fix(types): typescript type generation improvements (contributes to #402)

packages/concerto-core/api.txt

@@ -66,6 +66,7 @@ class AssetDeclaration extends IdentifiedDeclaration {
 class ClassDeclaration extends Decorated {
    + void constructor(ModelFile,Object) throws IllegalModelException
    + ClassDeclaration _resolveSuperType() 
+   ~ void validate() throws IllegalModelException
    + boolean isAbstract() 
    + string getName() 
    + string getNamespace() 
@@ -167,6 +168,7 @@ class ParticipantDeclaration extends IdentifiedDeclaration {
 class Property extends Decorated {
    + void constructor(ClassDeclaration,Object) throws IllegalModelException
    + ClassDeclaration getParent() 
+   ~ void validate(ClassDeclaration) throws IllegalModelException
    + string getName() 
    + string getType() 
    + boolean isOptional() 
@@ -179,6 +181,7 @@ class Property extends Decorated {
 }
 class RelationshipDeclaration extends Property {
    + void constructor(ClassDeclaration,Object) throws IllegalModelException
+   ~ void validate(ClassDeclaration) throws IllegalModelException
    + String toString() 
    + boolean isRelationship() 
 }
@@ -187,6 +190,7 @@ class TransactionDeclaration extends IdentifiedDeclaration {
    + string declarationKind() 
 }
 class Identifiable extends Typed {
+   ~ void constructor(ModelManager,ClassDeclaration,string,string,string,string) 
    + string getTimestamp() 
    + string getIdentifier() 
    + void setIdentifier(string) 
@@ -209,12 +213,14 @@ class Resource extends Identifiable {
    + Object toJSON() 
 }
 class Typed {
+   ~ void constructor(ModelManager,ClassDeclaration,string,string) 
    + string getType() 
    + string getFullyQualifiedType() 
    + string getNamespace() 
    + void setPropertyValue(string,string) 
    + void addArrayValue(string,string) 
    + boolean instanceOf(String) 
+   ~ void toJSON() 
 }
 class ValidatedResource extends Resource {
    + void setPropertyValue(string,string) throws Error
@@ -239,6 +245,6 @@ class Serializer {
    + Resource fromJSON(Object,Object?,boolean,boolean,number?) 
 }
 class TypeNotFoundException extends BaseException {
-   + void constructor(string,string?,string) 
+   + void constructor(string,string|,string) 
    + string getTypeName() 
 }

packages/concerto-core/changelog.txt

@@ -24,7 +24,7 @@
 # Note that the latest public API is documented using JSDocs and is available in api.txt.
 #
 
-Version 2.0.0-alpha.1 {ee5fa0479fe2720d720ac500b1b3ead8} 2021-11-24
+Version 2.0.0-alpha.1 {4169a97a927d336f3c76f85f00725c13} 2021-11-24
 - Remove custom instanceof and add methods to check runtime type
 - Remove support for Node 12
 - Generate Typescript definitions from JSDoc

packages/concerto-core/index.js

@@ -89,6 +89,7 @@ const Concerto = require('./lib/concerto');
 const MetaModel = require('./lib/introspect/metamodel');
 
 // Version
+/** @type {{ name: string, version: string }} */
 const version = require('./package.json');
 
 module.exports = {

packages/concerto-core/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

packages/concerto-core/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.

packages/concerto-core/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

packages/concerto-core/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();

packages/concerto-core/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

packages/concerto-core/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();

packages/concerto-core/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

packages/concerto-core/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.

packages/concerto-core/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.
  *

packages/concerto-core/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
  *

packages/concerto-core/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}

packages/concerto-core/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

packages/concerto-core/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
  *

packages/concerto-core/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

packages/concerto-core/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.

packages/concerto-core/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');

packages/concerto-core/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.