@accordproject/concerto-core 2.0.0-alpha.1 → 2.0.0-beta.2

package/changelog.txt

@@ -24,13 +24,14 @@
 # Note that the latest public API is documented using JSDocs and is available in api.txt.
 #
 
-Version 1.2.2 {ee5fa0479fe2720d720ac500b1b3ead8} 2021-11-24
+Version 2.0.0-alpha.1 {292b93fc879d3b0c3969711b24312ffd} 2022-03-30
 - Remove custom instanceof and add methods to check runtime type
 - Remove support for Node 12
 - Generate Typescript definitions from JSDoc
 - Parser directly constructs metamodel instance
 - Convert MetaModel to a class for Typescript + Webpack compatability
 - Update Acorn to latest and refactor the JavaScript parser so we can use static class members
+- Add DecoratorManager
 - New packages for parsing and metamodel, distinct from core
 - Revisions to model manager API to support various inputs (e.g., CTO or AST)
 - New vocabulary package for handling model vocabularies

package/index.js

@@ -22,71 +22,111 @@
  */
 
 // Exceptions
-module.exports.SecurityException = require('./lib/securityexception');
-module.exports.IllegalModelException = require('./lib/introspect/illegalmodelexception');
-module.exports.TypeNotFoundException = require('./lib/typenotfoundexception');
+const SecurityException = require('./lib/securityexception');
+const IllegalModelException = require('./lib/introspect/illegalmodelexception');
+const TypeNotFoundException = require('./lib/typenotfoundexception');
 
 // Decorated
-module.exports.Decorator = require('./lib/introspect/decorator');
-module.exports.DecoratorFactory = require('./lib/introspect/decoratorfactory');
+const Decorator = require('./lib/introspect/decorator');
+const DecoratorFactory = require('./lib/introspect/decoratorfactory');
 
 // ClassDeclarations
-module.exports.ClassDeclaration = require('./lib/introspect/classdeclaration');
-module.exports.IdentifiedDeclaration = require('./lib/introspect/identifieddeclaration');
-module.exports.AssetDeclaration = require('./lib/introspect/assetdeclaration');
-module.exports.ConceptDeclaration = require('./lib/introspect/conceptdeclaration');
-module.exports.EnumValueDeclaration = require('./lib/introspect/enumvaluedeclaration');
-module.exports.EventDeclaration = require('./lib/introspect/eventdeclaration');
-module.exports.ParticipantDeclaration = require('./lib/introspect/participantdeclaration');
-module.exports.TransactionDeclaration = require('./lib/introspect/transactiondeclaration');
+const ClassDeclaration = require('./lib/introspect/classdeclaration');
+const IdentifiedDeclaration = require('./lib/introspect/identifieddeclaration');
+const AssetDeclaration = require('./lib/introspect/assetdeclaration');
+const ConceptDeclaration = require('./lib/introspect/conceptdeclaration');
+const EnumValueDeclaration = require('./lib/introspect/enumvaluedeclaration');
+const EventDeclaration = require('./lib/introspect/eventdeclaration');
+const ParticipantDeclaration = require('./lib/introspect/participantdeclaration');
+const TransactionDeclaration = require('./lib/introspect/transactiondeclaration');
 
 // Properties
-module.exports.Property = require('./lib/introspect/property');
-module.exports.Field = require('./lib/introspect/field');
-module.exports.EnumDeclaration = require('./lib/introspect/enumdeclaration');
-module.exports.RelationshipDeclaration = require('./lib/introspect/relationshipdeclaration');
+const Property = require('./lib/introspect/property');
+const Field = require('./lib/introspect/field');
+const EnumDeclaration = require('./lib/introspect/enumdeclaration');
+const RelationshipDeclaration = require('./lib/introspect/relationshipdeclaration');
 
 // Typed
-module.exports.Typed = require('./lib/model/typed');
+const Typed = require('./lib/model/typed');
 
 // Identifiables
-module.exports.Identifiable = require('./lib/model/identifiable');
-module.exports.Relationship = require('./lib/model/relationship');
-module.exports.Resource = require('./lib/model/resource');
+const Identifiable = require('./lib/model/identifiable');
+const Relationship = require('./lib/model/relationship');
+const Resource = require('./lib/model/resource');
 
 // Factory
-module.exports.Factory = require('./lib/factory');
+const Factory = require('./lib/factory');
 
 // Globalize
-module.exports.Globalize = require('./lib/globalize');
+const Globalize = require('./lib/globalize');
 
 // Introspector
-module.exports.Introspector = require('./lib/introspect/introspector');
+const Introspector = require('./lib/introspect/introspector');
 
 // ModelFile
-module.exports.ModelFile = require('./lib/introspect/modelfile');
+const ModelFile = require('./lib/introspect/modelfile');
 
 // ModelManager
-module.exports.ModelManager = require('./lib/modelmanager');
+const ModelManager = require('./lib/modelmanager');
 
 // Serializer
-module.exports.Serializer = require('./lib/serializer');
+const Serializer = require('./lib/serializer');
 
 // ModelUtil
-module.exports.ModelUtil = require('./lib/modelutil');
+const ModelUtil = require('./lib/modelutil');
 
 // ModelLoader
-module.exports.ModelLoader = require('./lib/modelloader');
+const ModelLoader = require('./lib/modelloader');
 
+// DecoratorManager
+const DecoratorManager = require('./lib/decoratormanager');
 
 // DateTimeUtil
-module.exports.DateTimeUtil = require('./lib/datetimeutil');
+const DateTimeUtil = require('./lib/datetimeutil');
 
 // Concerto
-module.exports.Concerto = require('./lib/concerto');
+const Concerto = require('./lib/concerto');
 
 // MetaModel
-module.exports.MetaModel = require('./lib/introspect/metamodel');
+const MetaModel = require('./lib/introspect/metamodel');
 
 // Version
-module.exports.version = require('./package.json');
+/** @type {{ name: string, version: string }} */
+const version = require('./package.json');
+
+module.exports = {
+    SecurityException,
+    IllegalModelException,
+    TypeNotFoundException,
+    Decorator,
+    DecoratorFactory,
+    DecoratorManager,
+    ClassDeclaration,
+    IdentifiedDeclaration,
+    AssetDeclaration,
+    ConceptDeclaration,
+    EnumValueDeclaration,
+    EventDeclaration,
+    ParticipantDeclaration,
+    TransactionDeclaration,
+    Property,
+    Field,
+    EnumDeclaration,
+    RelationshipDeclaration,
+    Typed,
+    Identifiable,
+    Relationship,
+    Resource,
+    Factory,
+    Globalize,
+    Introspector,
+    ModelFile,
+    ModelManager,
+    Serializer,
+    ModelUtil,
+    ModelLoader,
+    DateTimeUtil,
+    Concerto,
+    MetaModel,
+    version
+};

package/lib/basemodelmanager.js

@@ -16,10 +16,8 @@
 
 const fsPath = require('path');
 
-const DefaultFileLoader = require('@accordproject/concerto-util').DefaultFileLoader;
-const FileDownloader = require('@accordproject/concerto-util').FileDownloader;
-const ModelWriter = require('@accordproject/concerto-util').ModelWriter;
-const MetaModelUtil = require('@accordproject/concerto-metamodel').MetaModelUtil;
+const { DefaultFileLoader, FileDownloader, ModelWriter } = require('@accordproject/concerto-util');
+const { MetaModelUtil } = require('@accordproject/concerto-metamodel');
 
 const Factory = require('./factory');
 const Globalize = require('./globalize');
@@ -30,6 +28,21 @@ const Serializer = require('./serializer');
 const TypeNotFoundException = require('./typenotfoundexception');
 const { rootModelFile, rootModelCto, rootModelAst } = require('./rootmodel');
 
+// Types needed for TypeScript generation.
+/* eslint-disable no-unused-vars */
+/* istanbul ignore next */
+if (global === undefined) {
+    const AssetDeclaration = require('./introspect/assetdeclaration');
+    const ClassDeclaration = require('./introspect/classdeclaration');
+    const ConceptDeclaration = require('./introspect/conceptdeclaration');
+    const DecoratorFactory = require('./introspect/decoratorfactory');
+    const EnumDeclaration = require('./introspect/enumdeclaration');
+    const EventDeclaration = require('./introspect/eventdeclaration');
+    const ParticipantDeclaration = require('./introspect/participantdeclaration');
+    const TransactionDeclaration = require('./introspect/transactiondeclaration');
+}
+/* eslint-enable no-unused-vars */
+
 const debug = require('debug')('concerto:BaseModelManager');
 
 // How to create a modelfile from the external content
@@ -315,19 +328,20 @@ class BaseModelManager {
             fileDownloader = new FileDownloader(new DefaultFileLoader(this.processFile), (file) => MetaModelUtil.getExternalImports(file.ast));
         }
 
-        const externalModelFiles = await fileDownloader.downloadExternalDependencies(this.getModelFiles(), options);
+        const externalModels = await fileDownloader.downloadExternalDependencies(this.getModelFiles(), options);
         const originalModelFiles = {};
         Object.assign(originalModelFiles, this.modelFiles);
 
         try {
-            externalModelFiles.forEach((file) => {
+            const externalModelFiles = [];
+            externalModels.forEach((file) => {
                 const mf = new ModelFile(this, file.ast, file.definitions, file.fileName);
                 const existing = this.modelFiles[mf.getNamespace()];
 
                 if (existing) {
-                    this.updateModelFile(mf, mf.getName(), true); // disable validation
+                    externalModelFiles.push(this.updateModelFile(mf, mf.getName(), true)); // disable validation
                 } else {
-                    this.addModelFile(mf, null, mf.getName(), true); // disable validation
+                    externalModelFiles.push(this.addModelFile(mf, null, mf.getName(), true)); // disable validation
                 }
             });
 
@@ -629,6 +643,19 @@ class BaseModelManager {
         return MetaModelUtil.resolveLocalNames(priorModels, metaModel);
     }
 
+    /**
+     * Populates the model manager from a models metamodel AST
+     * @param {*} ast the metamodel
+     */
+    fromAst(ast) {
+        this.clearModelFiles();
+        ast.models.forEach( model => {
+            const modelFile = new ModelFile( this, model );
+            this.addModelFile( modelFile, null, null, true );
+        });
+        this.validateModelFiles();
+    }
+
     /**
      * Get the full ast (metamodel instances) for a modelmanager
      * @param {boolean} [resolve] - whether to resolve names

package/lib/decoratormanager.js

@@ -0,0 +1,118 @@
+/*
+ * 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 ModelManager = require('./modelmanager');
+
+/**
+ * Utility functions to work with
+ * [DecoratorCommandSet](https://models.accordproject.org/concerto/decorators.cto)
+ * @memberof module:concerto-core
+ */
+class DecoratorManager {
+    /**
+     * Applies all the decorator commands from the DecoratorCommandSet
+     * to the ModelManager.
+     * @param {ModelManager} modelManager the input model manager
+     * @param {*} decoratorCommandSet the DecoratorCommandSet object
+     * @returns {ModelManager} a new model manager with the decorations applied
+     */
+    static decorateModels(modelManager, decoratorCommandSet) {
+        const ast = modelManager.getAst(true);
+        const decoratedAst = JSON.parse(JSON.stringify(ast));
+        decoratedAst.models.forEach(model => {
+            model.declarations.forEach(decl => {
+                decoratorCommandSet.commands.forEach(command => {
+                    this.executeCommand(model.namespace, decl, command);
+                });
+            });
+        });
+        const newModelManager = new ModelManager();
+        newModelManager.fromAst(decoratedAst);
+        return newModelManager;
+    }
+
+    /**
+     * Compares two values. If the first argument is falsy
+     * the function returns true.
+     * @param {string | null} test the value to test (lhs)
+     * @param {string} value the value to compare (rhs)
+     * @returns {Boolean} true if the lhs is falsy or test === value
+     */
+    static falsyOrEqual(test, value) {
+        return test ? test === value : true;
+    }
+
+    /**
+     * Applies a decorator to a decorated model element.
+     * @param {*} decorated the type to apply the decorator to
+     * @param {string} type the command type
+     * @param {*} newDecorator the decorator to add
+     */
+    static applyDecorator(decorated, type, newDecorator) {
+        if (type === 'UPSERT') {
+            let updated = false;
+            if(decorated.decorators) {
+                for (let n = 0; n < decorated.decorators.length; n++) {
+                    let decorator = decorated.decorators[n];
+                    if (decorator.name === newDecorator.name) {
+                        decorated.decorators[n] = newDecorator;
+                        updated = true;
+                    }
+                }
+            }
+
+            if (!updated) {
+                decorated.decorators ? decorated.decorators.push(newDecorator)
+                    : decorated.decorators = [newDecorator];
+            }
+        }
+        else if (type === 'APPEND') {
+            decorated.decorators ? decorated.decorators.push(newDecorator)
+                : decorated.decorators = [newDecorator];
+        }
+        else {
+            throw new Error(`Unknown command type ${type}`);
+        }
+    }
+
+    /**
+     * Executes a Command against a ClassDeclaration, adding
+     * decorators to the ClassDeclaration, or its properties, as required.
+     * @param {string} namespace the namespace for the declaration
+     * @param {*} declaration the class declaration
+     * @param {*} command the Command object from the
+     * org.accordproject.decoratorcommands model
+     */
+    static executeCommand(namespace, declaration, command) {
+        const { target, decorator, type } = command;
+        if (this.falsyOrEqual(target.namespace, namespace) &&
+            this.falsyOrEqual(target.declaration, declaration.name)) {
+            if (!target.property && !target.type) {
+                this.applyDecorator(declaration, type, decorator);
+            }
+            else {
+                declaration.properties.forEach(property => {
+                    if (this.falsyOrEqual(target.property, property.name) &&
+                        this.falsyOrEqual(target.type, property.$class)) {
+                        this.applyDecorator(property, type, decorator);
+                    }
+                });
+            }
+        }
+    }
+}
+
+module.exports = DecoratorManager;

package/lib/factory.js

@@ -14,7 +14,7 @@
 
 'use strict';
 
-const TypedStack = require('@accordproject/concerto-util').TypedStack;
+const { TypedStack } = require('@accordproject/concerto-util');
 
 const debug = require('debug')('concerto:Factory');
 const Globalize = require('./globalize');
@@ -35,6 +35,14 @@ const dayjs = require('dayjs');
 const utc = require('dayjs/plugin/utc');
 dayjs.extend(utc);
 
+// Types needed for TypeScript generation.
+/* eslint-disable no-unused-vars */
+/* istanbul ignore next */
+if (global === undefined) {
+    const ModelManager = require('./modelmanager');
+}
+/* eslint-enable no-unused-vars */
+
 /**
  * Use the Factory to create instances of Resource: transactions, participants
  * and assets.

package/lib/introspect/assetdeclaration.js

@@ -16,6 +16,14 @@
 
 const IdentifiedDeclaration = require('./identifieddeclaration');
 
+// 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 */
+
 /**
  * AssetDeclaration defines the schema (aka model or class) for
  * an Asset. It extends ClassDeclaration which manages a set of

package/lib/introspect/classdeclaration.js

@@ -23,6 +23,15 @@ 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 */
+
 /**
  * ClassDeclaration defines the structure (model/schema) of composite data.
  * It is composed of a set of Properties, may have an identifying field, and may
@@ -184,7 +193,7 @@ class ClassDeclaration extends Decorated {
      * contents/relations of fields.
      *
      * @throws {IllegalModelException}
-     * @private
+     * @protected
      */
     validate() {
         super.validate();

package/lib/introspect/conceptdeclaration.js

@@ -16,6 +16,14 @@
 
 const ClassDeclaration = require('./classdeclaration');
 
+// 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 */
+
 /**
  * ConceptDeclaration defines the schema (aka model or class) for
  * an Concept. It extends ClassDeclaration which manages a set of

package/lib/introspect/decorated.js

@@ -17,6 +17,14 @@
 const Decorator = require('./decorator');
 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 */
+
 /**
  * Decorated defines a model element that may have decorators attached.
  *
@@ -99,10 +107,11 @@ class Decorated {
      * override this method to impose additional semantic constraints on the
      * contents/relations of fields.
      *
+     * @param {...*} args the validation arguments
      * @throws {IllegalModelException}
-     * @private
+     * @protected
      */
-    validate() {
+    validate(...args) {
         for(let n=0; n < this.decorators.length; n++) {
             let decorator = this.decorators[n];
             decorator.validate();

package/lib/introspect/decorator.js

@@ -14,6 +14,15 @@
 
 'use strict';
 
+// Types needed for TypeScript generation.
+/* eslint-disable no-unused-vars */
+/* istanbul ignore next */
+if (global === undefined) {
+    const ClassDeclaration = require('./classdeclaration');
+    const Property = require('./property');
+}
+/* eslint-enable no-unused-vars */
+
 /**
  * Decorator encapsulates a decorator (annotation) on a class or property.
  * @class

package/lib/introspect/decoratorfactory.js

@@ -14,6 +14,16 @@
 
 'use strict';
 
+// Types needed for TypeScript generation.
+/* eslint-disable no-unused-vars */
+/* istanbul ignore next */
+if (global === undefined) {
+    const ClassDeclaration = require('./classdeclaration');
+    const Decorator = require('./decorator');
+    const Property = require('./property');
+}
+/* eslint-enable no-unused-vars */
+
 /**
  * An interface for a class that processes a decorator and returns a specific
  * implementation class for that decorator.

package/lib/introspect/enumdeclaration.js

@@ -16,6 +16,14 @@
 
 const ClassDeclaration = require('./classdeclaration');
 
+// 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 */
+
 /**
  * EnumDeclaration defines an enumeration of static values.
  *

package/lib/introspect/enumvaluedeclaration.js

@@ -16,6 +16,14 @@
 
 const Property = require('./property');
 
+// Types needed for TypeScript generation.
+/* eslint-disable no-unused-vars */
+/* istanbul ignore next */
+if (global === undefined) {
+    const ClassDeclaration = require('./classdeclaration');
+}
+/* eslint-enable no-unused-vars */
+
 /**
  * Class representing a value from a set of enumerated values
  *

package/lib/introspect/eventdeclaration.js

@@ -16,6 +16,14 @@
 
 const IdentifiedDeclaration = require('./identifieddeclaration');
 
+// 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 */
+
 /** Class representing the definition of an Event.
  * @extends ClassDeclaration
  * @see See  {@link ClassDeclaration}

package/lib/introspect/field.js

@@ -18,6 +18,14 @@ const Property = require('./property');
 const NumberValidator = require('./numbervalidator');
 const StringValidator = require('./stringvalidator');
 
+// Types needed for TypeScript generation.
+/* eslint-disable no-unused-vars */
+/* istanbul ignore next */
+if (global === undefined) {
+    const ClassDeclaration = require('./classdeclaration');
+}
+/* eslint-enable no-unused-vars */
+
 /**
  * Class representing the definition of a Field. A Field is owned
  * by a ClassDeclaration and has a name, type and additional metadata

package/lib/introspect/identifieddeclaration.js

@@ -16,6 +16,14 @@
 
 const ClassDeclaration = require('./classdeclaration');
 
+// 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 */
+
 /**
  * IdentifiedDeclaration
  *

package/lib/introspect/illegalmodelexception.js

@@ -14,7 +14,15 @@
 
 'use strict';
 
-const BaseFileException = require('@accordproject/concerto-util').BaseFileException;
+const { BaseFileException } = require('@accordproject/concerto-util');
+
+// 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 */
 
 /**
  * Exception throws when a composer file is semantically invalid

package/lib/introspect/introspector.js

@@ -14,6 +14,15 @@
 
 'use strict';
 
+// Types needed for TypeScript generation.
+/* eslint-disable no-unused-vars */
+/* istanbul ignore next */
+if (global === undefined) {
+    const ClassDeclaration = require('./classdeclaration');
+    const ModelManager = require('../modelmanager');
+}
+/* eslint-enable no-unused-vars */
+
 /**
  *
  * Provides access to the structure of transactions, assets and participants.

package/lib/introspect/metamodel.js

@@ -14,7 +14,7 @@
 
 'use strict';
 
-const MetaModelUtil = require('@accordproject/concerto-metamodel').MetaModelUtil;
+const { MetaModelUtil } = require('@accordproject/concerto-metamodel');
 
 const ModelManager = require('../modelmanager');
 const Factory = require('../factory');

package/lib/introspect/modelfile.js

@@ -26,6 +26,15 @@ const IllegalModelException = require('./illegalmodelexception');
 const ModelUtil = require('../modelutil');
 const Globalize = require('../globalize');
 
+// Types needed for TypeScript generation.
+/* eslint-disable no-unused-vars */
+/* istanbul ignore next */
+if (global === undefined) {
+    const ClassDeclaration = require('./classdeclaration');
+    const ModelManager = require('../modelmanager');
+}
+/* eslint-enable no-unused-vars */
+
 /**
  * Class representing a Model File. A Model File contains a single namespace
  * and a set of model elements: assets, transactions etc.

package/lib/introspect/numbervalidator.js

@@ -16,6 +16,14 @@
 
 const Validator = require('./validator');
 
+// Types needed for TypeScript generation.
+/* eslint-disable no-unused-vars */
+/* istanbul ignore next */
+if (global === undefined) {
+    const Field = require('./field');
+}
+/* eslint-enable no-unused-vars */
+
 /**
  * A Validator to enforce that non null numeric values are between two values.
  * @private