@accordproject/concerto-core 3.6.0 → 3.6.1-20230308142539

package/dist/concerto-core.js.LICENSE.txt

@@ -1,5 +1,5 @@
 /*!
- * Concerto v3.6.0
+ * Concerto v3.6.1-20230308142539
  *         Licensed under the Apache License, Version 2.0 (the "License");
  *         you may not use this file except in compliance with the License.
  *         You may obtain a copy of the License at

package/index.js

@@ -39,6 +39,7 @@ const EnumValueDeclaration = require('./lib/introspect/enumvaluedeclaration');
 const EventDeclaration = require('./lib/introspect/eventdeclaration');
 const ParticipantDeclaration = require('./lib/introspect/participantdeclaration');
 const TransactionDeclaration = require('./lib/introspect/transactiondeclaration');
+const ScalarDeclaration = require('./lib/introspect/scalardeclaration');
 
 // Properties
 const Property = require('./lib/introspect/property');
@@ -114,6 +115,7 @@ module.exports = {
     EventDeclaration,
     ParticipantDeclaration,
     TransactionDeclaration,
+    ScalarDeclaration,
     Property,
     Field,
     EnumDeclaration,

package/lib/basemodelmanager.js

@@ -32,6 +32,7 @@ const { getRootModel } = require('./rootmodel');
 /* eslint-disable no-unused-vars */
 /* istanbul ignore next */
 if (global === undefined) {
+    const Declaration = require('./introspect/declaration');
     const AssetDeclaration = require('./introspect/assetdeclaration');
     const ClassDeclaration = require('./introspect/classdeclaration');
     const ConceptDeclaration = require('./introspect/conceptdeclaration');
@@ -709,6 +710,32 @@ class BaseModelManager {
         });
         return result;
     }
+
+
+    /**
+     * A function type definition for use as an argument to the filter function
+     * @callback FilterFunction
+     * @param {Declaration} declaration
+     * @returns {boolean} true, if the declaration satisfies the filter function
+     */
+
+    /**
+     * Returns a new ModelManager with only the types for which the
+     * filter function returns true.
+     *
+     * ModelFiles with no declarations after filtering will be removed.
+     *
+     * @param {FilterFunction} predicate - the filter function over a Declaration object
+     * @returns {BaseModelManager} - the filtered ModelManager
+     */
+    filter(predicate){
+        const modelManager = new BaseModelManager({...this.options}, this.processFile);
+        const filteredModels = Object.values(this.modelFiles)
+            .map((modelFile) => modelFile.filter(predicate, modelManager))
+            .filter(Boolean);
+        modelManager.addModelFiles(filteredModels);
+        return modelManager;
+    }
 }
 
 module.exports = BaseModelManager;

package/lib/introspect/classdeclaration.js

@@ -16,20 +16,18 @@
 
 const { MetaModelNamespace } = require('@accordproject/concerto-metamodel');
 
-const Decorated = require('./decorated');
+const Declaration = require('./declaration');
 const EnumValueDeclaration = require('./enumvaluedeclaration');
 const Field = require('./field');
 const Globalize = require('../globalize');
 const IllegalModelException = require('./illegalmodelexception');
 const Introspector = require('./introspector');
-const ModelUtil = require('../modelutil');
 const RelationshipDeclaration = require('./relationshipdeclaration');
 
 // Types needed for TypeScript generation.
 /* eslint-disable no-unused-vars */
 /* istanbul ignore next */
 if (global === undefined) {
-    const ModelFile = require('./modelfile');
     const Property = require('./property');
 }
 /* eslint-enable no-unused-vars */
@@ -45,31 +43,7 @@ if (global === undefined) {
  * @class
  * @memberof module:concerto-core
  */
-class ClassDeclaration extends Decorated {
-    /**
-     * Create a ClassDeclaration 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, ast) {
-        super(ast);
-        this.modelFile = modelFile;
-        this.process();
-    }
-
-    /**
-     * Returns the ModelFile that defines this class.
-     *
-     * @public
-     * @return {ModelFile} the owning ModelFile
-     */
-    getModelFile() {
-        return this.modelFile;
-    }
-
+class ClassDeclaration extends Declaration {
     /**
      * Process the AST and build the model
      *
@@ -79,13 +53,8 @@ class ClassDeclaration extends Decorated {
     process() {
         super.process();
 
-        if (!ModelUtil.isValidIdentifier(this.ast.name)){
-            throw new IllegalModelException(`Invalid class name '${this.ast.name}'`, this.modelFile, this.ast.location);
-        }
-
         const reservedProperties = ['$class', '$identifier', '$timestamp'];
 
-        this.name = this.ast.name;
         this.properties = [];
         this.superType = null;
         this.superTypeDeclaration = null;
@@ -143,8 +112,6 @@ class ClassDeclaration extends Decorated {
             }
         }
 
-        this.fqn = ModelUtil.getFullyQualifiedName(this.modelFile.getNamespace(), this.name);
-
         if (this.fqn === 'concerto@1.0.0.Transaction' || this.fqn === 'concerto@1.0.0.Event') {
             this.addTimestampField();
         }
@@ -332,34 +299,6 @@ class ClassDeclaration extends Decorated {
         return this.abstract;
     }
 
-    /**
-     * 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() {
-        return this.name;
-    }
-
-    /**
-     * Return the namespace of this class.
-     * @return {string} namespace - a namespace.
-     */
-    getNamespace() {
-        return this.modelFile.getNamespace();
-    }
-
-    /**
-     * 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() {
-        return this.fqn;
-    }
-
     /**
      * Returns true if this class declaration declares an identifying field
      * (system or explicit)

package/lib/introspect/declaration.js

@@ -0,0 +1,182 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+'use strict';
+
+const Decorated = require('./decorated');
+const ModelUtil = require('../modelutil');
+const IllegalModelException = require('./illegalmodelexception');
+
+// Types needed for TypeScript generation.
+/* eslint-disable no-unused-vars */
+/* istanbul ignore next */
+if (global === undefined) {
+    const ModelFile = require('./modelfile');
+}
+/* eslint-enable no-unused-vars */
+
+/**
+ * Declaration 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 Declaration is conceptually owned by a ModelFile which
+ * defines all the classes that are part of a namespace.
+ *
+ * @abstract
+ * @class
+ * @memberof module:concerto-core
+ */
+class Declaration extends Decorated {
+    /**
+     * Create a Declaration 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, ast) {
+        super(ast);
+        this.modelFile = modelFile;
+        this.process();
+    }
+
+    /**
+     * Process the AST and build the model
+     *
+     * @throws {IllegalModelException}
+     * @private
+     */
+    process() {
+        super.process();
+
+        if (!ModelUtil.isValidIdentifier(this.ast.name)){
+            throw new IllegalModelException(`Invalid class name '${this.ast.name}'`, this.modelFile, this.ast.location);
+        }
+
+        this.name = this.ast.name;
+        this.fqn = ModelUtil.getFullyQualifiedName(this.modelFile.getNamespace(), this.name);
+    }
+
+    /**
+     * Returns the ModelFile that defines this class.
+     *
+     * @public
+     * @return {ModelFile} the owning ModelFile
+     */
+    getModelFile() {
+        return this.modelFile;
+    }
+
+    /**
+     * 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() {
+        return this.name;
+    }
+
+    /**
+     * Return the namespace of this class.
+     * @return {string} namespace - a namespace.
+     */
+    getNamespace() {
+        return this.modelFile.getNamespace();
+    }
+
+    /**
+     * 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() {
+        return this.fqn;
+    }
+
+    /**
+     * Returns false as scalars are never identified.
+     * @returns {Boolean} false as scalars are never identified
+     */
+    isIdentified() {
+        return false;
+    }
+
+    /**
+     * Returns false as scalars are never identified.
+     * @returns {Boolean} false as scalars are never identified
+     */
+    isSystemIdentified() {
+        return false;
+    }
+
+    /**
+     * Returns the name of the identifying field for this class. Note
+     * that the identifying field may come from a super type.
+     *
+     * @return {string} the name of the id field for this class or null if it does not exist
+     */
+    getIdentifierFieldName() {
+        return 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() {
+        return null;
+    }
+
+    /**
+     * Returns the string representation of this class
+     * @return {String} the string representation of the class
+     */
+    toString() {
+        return null;
+    }
+
+    /**
+     * Returns true if this class is the definition of an enum.
+     *
+     * @return {boolean} true if the class is an enum
+     */
+    isEnum() {
+        return false;
+    }
+
+    /**
+     * Returns true if this class is the definition of a class declaration.
+     *
+     * @return {boolean} true if the class is a class
+     */
+    isClassDeclaration() {
+        return false;
+    }
+
+    /**
+     * Returns true if this class is the definition of a scalar declaration.
+     *
+     * @return {boolean} true if the class is a scalar
+     */
+    isScalarDeclaration() {
+        return false;
+    }
+}
+
+module.exports = Declaration;

package/lib/introspect/modelfile.js

@@ -36,6 +36,7 @@ const Decorated = require('./decorated');
 if (global === undefined) {
     const ClassDeclaration = require('./classdeclaration');
     const ModelManager = require('../modelmanager');
+    const Declaration = require('./declaration');
 }
 /* eslint-enable no-unused-vars */
 
@@ -802,6 +803,35 @@ class ModelFile extends Decorated {
         }
     }
 
+    /**
+     * A function type definition for use as an argument to the filter function
+     * @callback FilterFunction
+     * @param {Declaration} declaration
+     * @returns {boolean} true, if the declaration satisfies the filter function
+     */
+
+    /**
+     * Returns a new ModelFile with only the types for which the
+     * filter function returns true.
+     *
+     * Will return null if the filtered ModelFile doesn't contain any declarations.
+     *
+     * @param {FilterFunction} predicate - the filter function over a Declaration object
+     * @param {ModelManager} modelManager - the target ModelManager for the filtered ModelFile
+     * @returns {ModelFile?} - the filtered ModelFile
+     * @private
+     */
+    filter(predicate, modelManager){
+        const declarations = this.declarations?.filter(predicate).map(declaration => declaration.ast);
+        const ast = {
+            ...this.ast,
+            declarations: declarations,
+        };
+        if (ast.declarations?.length > 0){
+            return new ModelFile(modelManager, ast, undefined, this.fileName);
+        }
+        return null;
+    }
 }
 
 module.exports = ModelFile;

package/lib/introspect/scalardeclaration.js

@@ -16,9 +16,8 @@
 
 const { MetaModelNamespace } = require('@accordproject/concerto-metamodel');
 
-const Decorated = require('./decorated');
+const Declaration = require('./declaration');
 const IllegalModelException = require('./illegalmodelexception');
-const ModelUtil = require('../modelutil');
 const NumberValidator = require('./numbervalidator');
 const StringValidator = require('./stringvalidator');
 
@@ -26,8 +25,8 @@ const StringValidator = require('./stringvalidator');
 /* eslint-disable no-unused-vars */
 /* istanbul ignore next */
 if (global === undefined) {
-    const ModelFile = require('./modelfile');
     const Validator = require('./validator');
+    const ClassDeclaration = require('./classdeclaration');
 }
 /* eslint-enable no-unused-vars */
 
@@ -42,31 +41,7 @@ if (global === undefined) {
  * @class
  * @memberof module:concerto-core
  */
-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, ast) {
-        super(ast);
-        this.modelFile = modelFile;
-        this.process();
-    }
-
-    /**
-     * Returns the ModelFile that defines this class.
-     *
-     * @public
-     * @return {ModelFile} the owning ModelFile
-     */
-    getModelFile() {
-        return this.modelFile;
-    }
-
+class ScalarDeclaration extends Declaration {
     /**
      * Process the AST and build the model
      *
@@ -76,7 +51,6 @@ class ScalarDeclaration extends Decorated {
     process() {
         super.process();
 
-        this.name = this.ast.name;
         this.superType = null;
         this.superTypeDeclaration = null;
         this.idField = null;
@@ -120,8 +94,6 @@ class ScalarDeclaration extends Decorated {
         } else {
             this.defaultValue = null;
         }
-
-        this.fqn = ModelUtil.getFullyQualifiedName(this.modelFile.getNamespace(), this.name);
     }
 
     /**
@@ -151,37 +123,10 @@ class ScalarDeclaration extends Decorated {
         }
     }
 
-    /**
-     * 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() {
-        return this.name;
-    }
-
-    /**
-     * Return the namespace of this class.
-     * @return {string} namespace - a namespace.
-     */
-    getNamespace() {
-        return this.modelFile.getNamespace();
-    }
-
-    /**
-     * 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() {
-        return this.fqn;
-    }
-
     /**
      * Returns false as scalars are never identified.
      * @returns {Boolean} false as scalars are never identified
+     * @deprecated
      */
     isIdentified() {
         return false;
@@ -190,6 +135,7 @@ class ScalarDeclaration extends Decorated {
     /**
      * Returns false as scalars are never identified.
      * @returns {Boolean} false as scalars are never identified
+     * @deprecated
      */
     isSystemIdentified() {
         return false;
@@ -197,13 +143,13 @@ class ScalarDeclaration extends Decorated {
 
     /**
      * Returns null as scalars are never identified.
-     * @return {null} null, as scalars are never identified
+     * @return {string} as scalars are never identified
+     * @deprecated
      */
     getIdentifierFieldName() {
         return null;
     }
 
-
     /**
      * Returns the FQN of the super type for this class or null if this
      * class does not have a super type.
@@ -215,15 +161,20 @@ class ScalarDeclaration extends Decorated {
     }
 
     /**
-     * Throws an error as scalars do not have supertypes.
+     * 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
+     * @deprecated
      */
     getSuperType() {
-        throw new Error('Scalars do not have super types.');
+        return null;
     }
 
     /**
      * Get the super type class declaration for this class.
-     * @return {ScalarDeclaration | null} the super type declaration, or null if there is no super type.
+     * @return {ClassDeclaration} the super type declaration, or null if there is no super type.
+     * @deprecated
      */
     getSuperTypeDeclaration() {
         return null;
@@ -238,9 +189,9 @@ class ScalarDeclaration extends Decorated {
     }
 
     /**
-       * Returns the default value for the field or null
-       * @return {string | number | null} the default value for the field or null
-       */
+     * Returns the default value for the field or null
+     * @return {string | number | null} the default value for the field or null
+     */
     getDefaultValue() {
         if(this.defaultValue) {
             return this.defaultValue;
@@ -262,15 +213,26 @@ class ScalarDeclaration extends Decorated {
      * Returns true if this class is abstract.
      *
      * @return {boolean} true if the class is abstract
+     * @deprecated
      */
     isAbstract() {
         return true;
     }
 
+    /**
+     * Returns true if this class is the definition of a scalar declaration.
+     *
+     * @return {boolean} true if the class is a scalar
+     */
+    isScalarDeclaration() {
+        return true;
+    }
+
     /**
      * Returns true if this class is the definition of an asset.
      *
      * @return {boolean} true if the class is an asset
+     * @deprecated
      */
     isAsset() {
         return false;
@@ -280,6 +242,7 @@ class ScalarDeclaration extends Decorated {
      * Returns true if this class is the definition of a participant.
      *
      * @return {boolean} true if the class is a participant
+     * @deprecated
      */
     isParticipant() {
         return false;
@@ -289,6 +252,7 @@ class ScalarDeclaration extends Decorated {
      * Returns true if this class is the definition of a transaction.
      *
      * @return {boolean} true if the class is a transaction
+     * @deprecated
      */
     isTransaction() {
         return false;
@@ -298,6 +262,7 @@ class ScalarDeclaration extends Decorated {
      * Returns true if this class is the definition of an event.
      *
      * @return {boolean} true if the class is an event
+     * @deprecated
      */
     isEvent() {
         return false;
@@ -307,37 +272,12 @@ class ScalarDeclaration extends Decorated {
      * Returns true if this class is the definition of a concept.
      *
      * @return {boolean} true if the class is a concept
+     * @deprecated
      */
     isConcept() {
         return false;
     }
 
-    /**
-     * Returns true if this class is the definition of an enum.
-     *
-     * @return {boolean} true if the class is an enum
-     */
-    isEnum() {
-        return false;
-    }
-
-    /**
-     * Returns true if this class is the definition of a class declaration.
-     *
-     * @return {boolean} true if the class is a class
-     */
-    isClassDeclaration() {
-        return false;
-    }
-
-    /**
-     * Returns true if this class is the definition of a scalar declaration.
-     *
-     * @return {boolean} true if the class is a scalar
-     */
-    isScalarDeclaration() {
-        return true;
-    }
 }
 
 module.exports = ScalarDeclaration;

package/lib/modelutil.js

@@ -174,13 +174,13 @@ class ModelUtil {
 
     /**
      * Returns the true if the given field is a Scalar type
-     * @param {Scalar} scalar - the string
+     * @param {Field} field - the Field to test
      * @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());
+    static isScalar(field) {
+        const modelFile = field.getParent().getModelFile();
+        const declaration = modelFile.getType(field.getType());
         return (declaration !== null && declaration.isScalarDeclaration?.());
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@accordproject/concerto-core",
-  "version": "3.6.0",
+  "version": "3.6.1-20230308142539",
   "description": "Core Implementation for the Concerto Modeling Language",
   "homepage": "https://github.com/accordproject/concerto",
   "engines": {
@@ -71,9 +71,9 @@
     "yargs": "17.3.1"
   },
   "dependencies": {
-    "@accordproject/concerto-cto": "3.6.0",
-    "@accordproject/concerto-metamodel": "3.6.0",
-    "@accordproject/concerto-util": "3.6.0",
+    "@accordproject/concerto-cto": "3.6.1-20230308142539",
+    "@accordproject/concerto-metamodel": "3.6.1-20230308142539",
+    "@accordproject/concerto-util": "3.6.1-20230308142539",
     "dayjs": "1.10.8",
     "debug": "4.3.1",
     "lorem-ipsum": "2.0.3",