Concerto API

Modules

concerto-core

Concerto module. Concerto is a framework for defining domain specific models.

Constants

levels : Object

Default levels for the npm configuration.

colorMap : Object

Default levels for the npm configuration.

Functions

setCurrentTime([currentTime], [utcOffset]) ⇒ object

Ensures there is a proper current time

randomNumberInRangeWithPrecision(userMin, userMax, precision, systemMin, systemMax) ⇒ number

Generate a random number within a given range with a prescribed precision and inside a global range

concerto-core

Concerto module. Concerto is a framework for defining domain specific models.

• concerto-core
  • .BaseException ⇐ Error
    • new BaseException(message, component)
  • .BaseFileException ⇐ BaseException
    • new BaseFileException(message, fileLocation, fullMessage, [fileName], [component])
    • .getFileLocation() ⇒ string
    • .getShortMessage() ⇒ string
    • .getFileName() ⇒ string
  • .Concerto
    • new Concerto(modelManager)
    • .validate(obj, [options])
    • .getModelManager() ⇒ *
    • .isObject(obj) ⇒ boolean
    • .getTypeDeclaration(obj) ⇒ *
    • .getIdentifier(obj) ⇒ string
    • .isIdentifiable(obj) ⇒ boolean
    • .isRelationship(obj) ⇒ boolean
    • .setIdentifier(obj, id) ⇒ *
    • .getFullyQualifiedIdentifier(obj) ⇒ string
    • .toURI(obj) ⇒ string
    • .fromURI(uri) ⇒ *
    • .getType(obj) ⇒ string
    • .getNamespace(obj) ⇒ string
  • .Factory
    • new Factory(modelManager)
    • instance
      • .newResource(ns, type, [id], [options]) ⇒ Resource
      • .newConcept(ns, type, [id], [options]) ⇒ Resource
      • .newRelationship(ns, type, id) ⇒ Relationship
      • .newTransaction(ns, type, [id], [options]) ⇒ Resource
      • .newEvent(ns, type, [id], [options]) ⇒ Resource
    • static
      • .Symbol.hasInstance(object) ⇒ boolean
  • .ModelLoader
    • .loadModelManager(ctoFiles, options) ⇒ object
    • .loadModelManagerFromModelFiles(modelFiles, [fileNames], options) ⇒ object
  • .ModelManager
    • new ModelManager([options])
    • instance
      • .accept(visitor, parameters) ⇒ Object
      • .validateModelFile(modelFile, [fileName])
      • .addModelFile(modelFile, fileName, [disableValidation]) ⇒ Object
      • .updateModelFile(modelFile, [fileName], [disableValidation]) ⇒ Object
      • .deleteModelFile(namespace)
      • .addModelFiles(modelFiles, [fileNames], [disableValidation]) ⇒ Array.<Object>
      • .validateModelFiles()
      • .updateExternalModels([options], [modelFileDownloader]) ⇒ Promise
      • .writeModelsToFileSystem(path, [options])
      • .getModels([options]) ⇒ Array.<{name:string, content:string}>
      • .clearModelFiles()
      • .getModelFile(namespace) ⇒ ModelFile
      • .getNamespaces() ⇒ Array.<string>
      • .getAssetDeclarations() ⇒ Array.<AssetDeclaration>
      • .getTransactionDeclarations() ⇒ Array.<TransactionDeclaration>
      • .getEventDeclarations() ⇒ Array.<EventDeclaration>
      • .getParticipantDeclarations() ⇒ Array.<ParticipantDeclaration>
      • .getEnumDeclarations() ⇒ Array.<EnumDeclaration>
      • .getConceptDeclarations() ⇒ Array.<ConceptDeclaration>
      • .getFactory() ⇒ Factory
      • .getSerializer() ⇒ Serializer
      • .getDecoratorFactories() ⇒ Array.<DecoratorFactory>
      • .addDecoratorFactory(factory)
      • .derivesFrom(fqt1, fqt2) ⇒ boolean
    • static
      • .Symbol.hasInstance(object) ⇒ boolean
  • .SecurityException ⇐ BaseException
    • new SecurityException(message)
  • .Serializer
    • new Serializer(factory, modelManager, [options])
    • instance
      • .setDefaultOptions(newDefaultOptions)
      • .toJSON(resource, [options]) ⇒ Object
      • .fromJSON(jsonObject, options) ⇒ Resource
    • static
      • .Symbol.hasInstance(object) ⇒ boolean
  • .TypeNotFoundException ⇐ BaseException
    • new TypeNotFoundException(typeName, [message], component)
    • .getTypeName() ⇒ string
  • .AssetDeclaration ⇐ ClassDeclaration
    • new AssetDeclaration(modelFile, ast)
    • .Symbol.hasInstance(object) ⇒ boolean
  • .ClassDeclaration
    • new ClassDeclaration(modelFile, ast)
    • instance
      • ._resolveSuperType() ⇒ ClassDeclaration
      • .isAbstract() ⇒ boolean
      • .isEnum() ⇒ boolean
      • .isConcept() ⇒ boolean
      • .isEvent() ⇒ boolean
      • .getName() ⇒ string
      • .getNamespace() ⇒ string
      • .getFullyQualifiedName() ⇒ string
      • .isIdentified() ⇒ Boolean
      • .isSystemIdentified() ⇒ Boolean
      • .isExplicitlyIdentified() ⇒ Boolean
      • .getIdentifierFieldName() ⇒ string
      • .getOwnProperty(name) ⇒ Property
      • .getOwnProperties() ⇒ Array.<Property>
      • .getSuperType() ⇒ string
      • .getSuperTypeDeclaration() ⇒ ClassDeclaration
      • .getAssignableClassDeclarations() ⇒ Array.<ClassDeclaration>
      • .getAllSuperTypeDeclarations() ⇒ Array.<ClassDeclaration>
      • .getProperty(name) ⇒ Property
      • .getProperties() ⇒ Array.<Property>
      • .getNestedProperty(propertyPath) ⇒ Property
      • .toString() ⇒ String
    • static
      • .Symbol.hasInstance(object) ⇒ boolean
  • .ConceptDeclaration ⇐ ClassDeclaration
    • new ConceptDeclaration(modelFile, ast)
    • instance
      • .isConcept() ⇒ boolean
    • static
      • .Symbol.hasInstance(object) ⇒ boolean
  • .Decorator
    • new Decorator(parent, ast)
    • .getParent() ⇒ ClassDeclaration | Property
    • .getName() ⇒ string
    • .getArguments() ⇒ Array.<object>
  • .DecoratorFactory
    • .newDecorator(parent, ast) ⇒ Decorator
  • .EnumDeclaration ⇐ ClassDeclaration
    • new EnumDeclaration(modelFile, ast)
    • instance
      • .isEnum() ⇒ boolean
      • .toString() ⇒ String
    • static
      • .Symbol.hasInstance(object) ⇒ boolean
  • .EnumValueDeclaration ⇐ Property
    • new EnumValueDeclaration(parent, ast)
    • .Symbol.hasInstance(object) ⇒ boolean
  • .EventDeclaration ⇐ ClassDeclaration
    • new EventDeclaration(modelFile, ast)
    • instance
      • .isEvent() ⇒ boolean
    • static
      • .Symbol.hasInstance(object) ⇒ boolean
  • .IdentifiedDeclaration ⇐ ClassDeclaration
    • new IdentifiedDeclaration(modelFile, ast)
    • .Symbol.hasInstance(object) ⇒ boolean
  • .IllegalModelException ⇐ BaseFileException
    • new IllegalModelException(message, [modelFile], [fileLocation], [component])
  • .Introspector
    • new Introspector(modelManager)
    • .getClassDeclarations() ⇒ Array.<ClassDeclaration>
    • .getClassDeclaration(fullyQualifiedTypeName) ⇒ ClassDeclaration
  • .ModelFile
    • new ModelFile(modelManager, definitions, [fileName])
    • instance
      • .isSystemModelFile() ⇒ Boolean
      • .isExternal() ⇒ boolean
      • .getModelManager() ⇒ ModelManager
      • .getImports() ⇒ Array.<string>
      • .isDefined(type) ⇒ boolean
      • .getLocalType(type) ⇒ ClassDeclaration
      • .getAssetDeclaration(name) ⇒ AssetDeclaration
      • .getTransactionDeclaration(name) ⇒ TransactionDeclaration
      • .getEventDeclaration(name) ⇒ EventDeclaration
      • .getParticipantDeclaration(name) ⇒ ParticipantDeclaration
      • .getNamespace() ⇒ string
      • .getName() ⇒ string
      • .getAssetDeclarations() ⇒ Array.<AssetDeclaration>
      • .getTransactionDeclarations() ⇒ Array.<TransactionDeclaration>
      • .getEventDeclarations() ⇒ Array.<EventDeclaration>
      • .getParticipantDeclarations() ⇒ Array.<ParticipantDeclaration>
      • .getConceptDeclarations() ⇒ Array.<ConceptDeclaration>
      • .getEnumDeclarations() ⇒ Array.<EnumDeclaration>
      • .getDeclarations(type) ⇒ Array.<ClassDeclaration>
      • .getAllDeclarations() ⇒ Array.<ClassDeclaration>
      • .getDefinitions() ⇒ string
      • .getConcertoVersion() ⇒ string
    • static
      • .Symbol.hasInstance(object) ⇒ boolean
  • .ParticipantDeclaration ⇐ ClassDeclaration
    • new ParticipantDeclaration(modelFile, ast)
    • .Symbol.hasInstance(object) ⇒ boolean
  • .Property
    • new Property(parent, ast)
    • instance
      • .getParent() ⇒ ClassDeclaration
      • .getName() ⇒ string
      • .getType() ⇒ string
      • .isOptional() ⇒ boolean
      • .getFullyQualifiedTypeName() ⇒ string
      • .getFullyQualifiedName() ⇒ string
      • .getNamespace() ⇒ string
      • .isArray() ⇒ boolean
      • .isTypeEnum() ⇒ boolean
      • .isPrimitive() ⇒ boolean
    • static
      • .Symbol.hasInstance(object) ⇒ boolean
  • .RelationshipDeclaration ⇐ Property
    • new RelationshipDeclaration(parent, ast)
    • instance
      • .toString() ⇒ String
    • static
      • .Symbol.hasInstance(object) ⇒ boolean
  • .TransactionDeclaration ⇐ ClassDeclaration
    • new TransactionDeclaration(modelFile, ast)
    • .Symbol.hasInstance(object) ⇒ boolean
  • .Resource ⇐ Identifiable
    • new Resource(modelManager, classDeclaration, ns, type, id, timestamp)
    • .toString() ⇒ String
    • .isResource() ⇒ boolean
    • .isConcept() ⇒ boolean
    • .isIdentifiable() ⇒ boolean
    • .toJSON() ⇒ Object
  • .TypedStack
    • new TypedStack(resource)
    • .push(obj, expectedType)
    • .pop(expectedType) ⇒ Object
    • .peek(expectedType) ⇒ Object
    • .clear()

concerto-core.BaseException ⇐ Error

A base class for all Concerto exceptions

Kind: static class of concerto-core
Extends: Error

new BaseException(message, component)

Create the BaseException.

Param	Type	Description
message	string	The exception message.
component	string	The optional component which throws this error.

concerto-core.BaseFileException ⇐ BaseException

Exception throws when a Concerto file is semantically invalid

Kind: static class of concerto-core
Extends: BaseException
See: BaseException

• .BaseFileException ⇐ BaseException
  • new BaseFileException(message, fileLocation, fullMessage, [fileName], [component])
  • .getFileLocation() ⇒ string
  • .getShortMessage() ⇒ string
  • .getFileName() ⇒ string

new BaseFileException(message, fileLocation, fullMessage, [fileName], [component])

Create an BaseFileException

Param	Type	Description
message	string	the message for the exception
fileLocation	string	the optional file location associated with the exception
fullMessage	string	the optional full message text
[fileName]	string	the file name
[component]	string	the component which throws this error

baseFileException.getFileLocation() ⇒ string

Returns the file location associated with the exception or null

Kind: instance method of BaseFileException
Returns: string - the optional location associated with the exception

baseFileException.getShortMessage() ⇒ string

Returns the error message without the location of the error

Kind: instance method of BaseFileException
Returns: string - the error message

baseFileException.getFileName() ⇒ string

Returns the fileName for the error

Kind: instance method of BaseFileException
Returns: string - the file name or null

concerto-core.Concerto

Runtime API for Concerto.

Kind: static class of concerto-core

• .Concerto
  • new Concerto(modelManager)
  • .validate(obj, [options])
  • .getModelManager() ⇒ *
  • .isObject(obj) ⇒ boolean
  • .getTypeDeclaration(obj) ⇒ *
  • .getIdentifier(obj) ⇒ string
  • .isIdentifiable(obj) ⇒ boolean
  • .isRelationship(obj) ⇒ boolean
  • .setIdentifier(obj, id) ⇒ *
  • .getFullyQualifiedIdentifier(obj) ⇒ string
  • .toURI(obj) ⇒ string
  • .fromURI(uri) ⇒ *
  • .getType(obj) ⇒ string
  • .getNamespace(obj) ⇒ string

new Concerto(modelManager)

Create a Concerto instance.

Param	Type	Description
modelManager	*	The this.modelManager to use for validation etc.

concerto.validate(obj, [options])

Validates the instance against its model.

Kind: instance method of Concerto
Throws:

• Error - if the instance if invalid with respect to the model

Param	Type	Description
obj	*	the input object
[options]	*	the validation options

concerto.getModelManager() ⇒ *

Returns the model manager

Kind: instance method of Concerto
Returns: * - the model manager associated with this Concerto class

concerto.isObject(obj) ⇒ boolean

Returns true if the input object is a Concerto object

Kind: instance method of Concerto
Returns: boolean - true if the object has a $class attribute

Param	Type	Description
obj	*	the input object

concerto.getTypeDeclaration(obj) ⇒ *

Returns the ClassDeclaration for an object, or throws an exception

Kind: instance method of Concerto
Returns: * - the ClassDeclaration for the type
Throw: Error an error if the object does not have a $class attribute

Param	Type	Description
obj	*	the input object

concerto.getIdentifier(obj) ⇒ string

Gets the identifier for an object

Kind: instance method of Concerto
Returns: string - The identifier for this object

Param	Type	Description
obj	*	the input object

concerto.isIdentifiable(obj) ⇒ boolean

Returns true if the object has an identifier

Kind: instance method of Concerto
Returns: boolean - is the object has been defined with an identifier in the model

Param	Type	Description
obj	*	the input object

concerto.isRelationship(obj) ⇒ boolean

Returns true if the object is a relationship. Relationships are strings of the form: 'resource:org.accordproject.Order#001' (a relationship) to the 'Order' identifiable, with the id 001.

Kind: instance method of Concerto
Returns: boolean - true if the object is a relationship

Param	Type	Description
obj	*	the input object

concerto.setIdentifier(obj, id) ⇒ *

Set the identifier for an object. This method does not mutate the input object, use the return object.

Kind: instance method of Concerto
Returns: * - the input object with the identifier set

Param	Type	Description
obj	*	the input object
id	string	the new identifier

concerto.getFullyQualifiedIdentifier(obj) ⇒ string

Returns the fully qualified identifier for an object

Kind: instance method of Concerto
Returns: string - the fully qualified identifier

Param	Type	Description
obj	*	the input object

concerto.toURI(obj) ⇒ string

Returns a URI for an object

Kind: instance method of Concerto
Returns: string - the URI for the object

Param	Type	Description
obj	*	the input object

concerto.fromURI(uri) ⇒ *

Parses a resource URI into typeDeclaration and id components.

Kind: instance method of Concerto
Returns: * - an object with typeDeclaration and id attributes
Throws:

• Error if the URI is invalid or the type does not exist in the model manager

Param	Type	Description
uri	string	the input URI

concerto.getType(obj) ⇒ string

Returns the short type name

Kind: instance method of Concerto
Returns: string - the short type name

Param	Type	Description
obj	*	the input object

concerto.getNamespace(obj) ⇒ string

Returns the namespace for the object

Kind: instance method of Concerto
Returns: string - the namespace

Param	Type	Description
obj	*	the input object

concerto-core.Factory

Use the Factory to create instances of Resource: transactions, participants and assets.

Kind: static class of concerto-core

• .Factory
  • new Factory(modelManager)
  • instance
    • .newResource(ns, type, [id], [options]) ⇒ Resource
    • .newConcept(ns, type, [id], [options]) ⇒ Resource
    • .newRelationship(ns, type, id) ⇒ Relationship
    • .newTransaction(ns, type, [id], [options]) ⇒ Resource
    • .newEvent(ns, type, [id], [options]) ⇒ Resource
  • static
    • .Symbol.hasInstance(object) ⇒ boolean

new Factory(modelManager)

Create the factory.

Param	Type	Description
modelManager	ModelManager	The ModelManager to use for this registry

factory.newResource(ns, type, [id], [options]) ⇒ Resource

Create a new Resource with a given namespace, type name and id

Kind: instance method of Factory
Returns: Resource - the new instance
Throws:

• TypeNotFoundException if the type is not registered with the ModelManager

Param	Type	Description
ns	String	the namespace of the Resource
type	String	the type of the Resource
[id]	String	an optional string identifier
[options]	Object	an optional set of options
[options.disableValidation]	boolean	pass true if you want the factory to return a Resource instead of a ValidatedResource. Defaults to false.
[options.generate]	String	Pass one of: sample return a resource instance with generated sample data. empty return a resource instance with empty property values.
[options.includeOptionalFields]	boolean	if options.generate is specified, whether optional fields should be generated.

factory.newConcept(ns, type, [id], [options]) ⇒ Resource

Create a new Concept with a given namespace and type name

Kind: instance method of Factory
Returns: Resource - the new instance
Throws:

• TypeNotFoundException if the type is not registered with the ModelManager

Param	Type	Description
ns	String	the namespace of the Concept
type	String	the type of the Concept
[id]	String	an optional string identifier
[options]	Object	an optional set of options
[options.disableValidation]	boolean	pass true if you want the factory to return a Concept instead of a ValidatedConcept. Defaults to false.
[options.generate]	String	Pass one of: sample return a resource instance with generated sample data. empty return a resource instance with empty property values.
[options.includeOptionalFields]	boolean	if options.generate is specified, whether optional fields should be generated.

factory.newRelationship(ns, type, id) ⇒ Relationship

Create a new Relationship with a given namespace, type and identifier. A relationship is a typed pointer to an instance. I.e the relationship with namespace = 'org.example', type = 'Vehicle' and id = 'ABC' creates a pointer that points at an instance of org.example.Vehicle with the id ABC.

Kind: instance method of Factory
Returns: Relationship - - the new relationship instance
Throws:

• TypeNotFoundException if the type is not registered with the ModelManager

Param	Type	Description
ns	String	the namespace of the Resource
type	String	the type of the Resource
id	String	the identifier

factory.newTransaction(ns, type, [id], [options]) ⇒ Resource

Create a new transaction object. The identifier of the transaction is set to a UUID.

Kind: instance method of Factory
Returns: Resource - A resource for the new transaction.

Param	Type	Description
ns	String	the namespace of the transaction.
type	String	the type of the transaction.
[id]	String	an optional string identifier
[options]	Object	an optional set of options
[options.generate]	String	Pass one of: sample return a resource instance with generated sample data. empty return a resource instance with empty property values.
[options.includeOptionalFields]	boolean	if options.generate is specified, whether optional fields should be generated.

factory.newEvent(ns, type, [id], [options]) ⇒ Resource

Create a new event object. The identifier of the event is set to a UUID.

Kind: instance method of Factory
Returns: Resource - A resource for the new event.

Param	Type	Description
ns	String	the namespace of the event.
type	String	the type of the event.
[id]	String	an optional string identifier
[options]	Object	an optional set of options
[options.generate]	String	Pass one of: sample return a resource instance with generated sample data. empty return a resource instance with empty property values.
[options.includeOptionalFields]	boolean	if options.generate is specified, whether optional fields should be generated.

Factory.Symbol.hasInstance(object) ⇒ boolean

Alternative instanceof that is reliable across different module instances

Kind: static method of Factory
Returns: boolean - - True, if the object is an instance of a Factory
See: https://github.com/hyperledger/composer-concerto/issues/47

Param	Type	Description
object	object	The object to test against

concerto-core.ModelLoader

Create a ModelManager from model files, with an optional system model.

If a ctoFile is not provided, the Accord Project system model is used.

Kind: static class of concerto-core

• .ModelLoader
  • .loadModelManager(ctoFiles, options) ⇒ object
  • .loadModelManagerFromModelFiles(modelFiles, [fileNames], options) ⇒ object

ModelLoader.loadModelManager(ctoFiles, options) ⇒ object

Load models in a new model manager

Kind: static method of ModelLoader
Returns: object - the model manager

Param	Type	Description
ctoFiles	Array.<string>	the CTO files (can be local file paths or URLs)
options	object	optional parameters
[options.offline]	boolean	do not resolve external models
[options.utcOffset]	number	UTC Offset for this execution

ModelLoader.loadModelManagerFromModelFiles(modelFiles, [fileNames], options) ⇒ object

Load system and models in a new model manager from model files objects

Kind: static method of ModelLoader
Returns: object - the model manager

Param	Type	Description
modelFiles	Array.<object>	An array of Concerto files as strings or ModelFile objects.
[fileNames]	Array.<string>	An optional array of file names to associate with the model files
options	object	optional parameters
[options.offline]	boolean	do not resolve external models
[options.utcOffset]	number	UTC Offset for this execution

concerto-core.ModelManager

Manages the Concerto model files.

The structure of Resources (Assets, Transactions, Participants) is modelled in a set of Concerto files. The contents of these files are managed by the ModelManager. Each Concerto file has a single namespace and contains a set of asset, transaction and participant type definitions.

Concerto applications load their Concerto files and then call the addModelFile method to register the Concerto file(s) with the ModelManager.

Use the Concerto class to validate instances.

Kind: static class of concerto-core

• .ModelManager
  • new ModelManager([options])
  • instance
    • .accept(visitor, parameters) ⇒ Object
    • .validateModelFile(modelFile, [fileName])
    • .addModelFile(modelFile, fileName, [disableValidation]) ⇒ Object
    • .updateModelFile(modelFile, [fileName], [disableValidation]) ⇒ Object
    • .deleteModelFile(namespace)
    • .addModelFiles(modelFiles, [fileNames], [disableValidation]) ⇒ Array.<Object>
    • .validateModelFiles()
    • .updateExternalModels([options], [modelFileDownloader]) ⇒ Promise
    • .writeModelsToFileSystem(path, [options])
    • .getModels([options]) ⇒ Array.<{name:string, content:string}>
    • .clearModelFiles()
    • .getModelFile(namespace) ⇒ ModelFile
    • .getNamespaces() ⇒ Array.<string>
    • .getAssetDeclarations() ⇒ Array.<AssetDeclaration>
    • .getTransactionDeclarations() ⇒ Array.<TransactionDeclaration>
    • .getEventDeclarations() ⇒ Array.<EventDeclaration>
    • .getParticipantDeclarations() ⇒ Array.<ParticipantDeclaration>
    • .getEnumDeclarations() ⇒ Array.<EnumDeclaration>
    • .getConceptDeclarations() ⇒ Array.<ConceptDeclaration>
    • .getFactory() ⇒ Factory
    • .getSerializer() ⇒ Serializer
    • .getDecoratorFactories() ⇒ Array.<DecoratorFactory>
    • .addDecoratorFactory(factory)
    • .derivesFrom(fqt1, fqt2) ⇒ boolean
  • static
    • .Symbol.hasInstance(object) ⇒ boolean

new ModelManager([options])

Create the ModelManager.

Param	Type	Description
[options]	object	Serializer options

modelManager.accept(visitor, parameters) ⇒ Object

Visitor design pattern

Kind: instance method of ModelManager
Returns: Object - the result of visiting or null

Param	Type	Description
visitor	Object	the visitor
parameters	Object	the parameter

modelManager.validateModelFile(modelFile, [fileName])

Validates a Concerto file (as a string) to the ModelManager. Concerto files have a single namespace.

Note that if there are dependencies between multiple files the files must be added in dependency order, or the addModelFiles method can be used to add a set of files irrespective of dependencies.

Kind: instance method of ModelManager
Throws:

• IllegalModelException

Param	Type	Description
modelFile	string	The Concerto file as a string
[fileName]	string	a file name to associate with the model file

modelManager.addModelFile(modelFile, fileName, [disableValidation]) ⇒ Object

Adds a Concerto file (as a string) to the ModelManager. Concerto files have a single namespace. If a Concerto file with the same namespace has already been added to the ModelManager then it will be replaced. Note that if there are dependencies between multiple files the files must be added in dependency order, or the addModelFiles method can be used to add a set of files irrespective of dependencies.

Kind: instance method of ModelManager
Returns: Object - The newly added model file (internal).
Throws:

• IllegalModelException

Param	Type	Description
modelFile	string	The Concerto file as a string
fileName	string	an optional file name to associate with the model file
[disableValidation]	boolean	If true then the model files are not validated

modelManager.updateModelFile(modelFile, [fileName], [disableValidation]) ⇒ Object

Updates a Concerto file (as a string) on the ModelManager. Concerto files have a single namespace. If a Concerto file with the same namespace has already been added to the ModelManager then it will be replaced.

Kind: instance method of ModelManager
Returns: Object - The newly added model file (internal).
Throws:

• IllegalModelException

Param	Type	Description
modelFile	string	The Concerto file as a string
[fileName]	string	a file name to associate with the model file
[disableValidation]	boolean	If true then the model files are not validated

modelManager.deleteModelFile(namespace)

Remove the Concerto file for a given namespace

Kind: instance method of ModelManager

Param	Type	Description
namespace	string	The namespace of the model file to delete.

modelManager.addModelFiles(modelFiles, [fileNames], [disableValidation]) ⇒ Array.<Object>

Add a set of Concerto files to the model manager.

Kind: instance method of ModelManager
Returns: Array.<Object> - The newly added model files (internal).

Param	Type	Description
modelFiles	Array.<object>	An array of Concerto files as strings or ModelFile objects.
[fileNames]	Array.<string>	A array of file names to associate with the model files
[disableValidation]	boolean	If true then the model files are not validated

modelManager.validateModelFiles()

Validates all models files in this model manager

Kind: instance method of ModelManager

modelManager.updateExternalModels([options], [modelFileDownloader]) ⇒ Promise

Downloads all ModelFiles that are external dependencies and adds or updates them in this ModelManager.

Kind: instance method of ModelManager
Returns: Promise - a promise when the download and update operation is completed.
Throws:

• IllegalModelException if the models fail validation

Param	Type	Description
[options]	Object	Options object passed to ModelFileLoaders
[modelFileDownloader]	ModelFileDownloader	an optional ModelFileDownloader

modelManager.writeModelsToFileSystem(path, [options])

Write all models in this model manager to the specified path in the file system

Kind: instance method of ModelManager

Param	Type	Description
path	string	to a local directory
[options]	Object	Options object
options.includeExternalModels	boolean	If true, external models are written to the file system. Defaults to true

modelManager.getModels([options]) ⇒ Array.<{name:string, content:string}>

Gets all the Concerto models

Kind: instance method of ModelManager
Returns: Array.<{name:string, content:string}> - the name and content of each CTO file

Param	Type	Description
[options]	Object	Options object
options.includeExternalModels	boolean	If true, external models are written to the file system. Defaults to true

modelManager.clearModelFiles()

Remove all registered Concerto files

Kind: instance method of ModelManager

modelManager.getModelFile(namespace) ⇒ ModelFile

Get the ModelFile associated with a namespace

Kind: instance method of ModelManager
Returns: ModelFile - registered ModelFile for the namespace or null

Param	Type	Description
namespace	string	the namespace containing the ModelFile

modelManager.getNamespaces() ⇒ Array.<string>

Get the namespaces registered with the ModelManager.

Kind: instance method of ModelManager
Returns: Array.<string> - namespaces - the namespaces that have been registered.

modelManager.getAssetDeclarations() ⇒ Array.<AssetDeclaration>

Get the AssetDeclarations defined in this model manager

Kind: instance method of ModelManager
Returns: Array.<AssetDeclaration> - the AssetDeclarations defined in the model manager

modelManager.getTransactionDeclarations() ⇒ Array.<TransactionDeclaration>

Get the TransactionDeclarations defined in this model manager

Kind: instance method of ModelManager
Returns: Array.<TransactionDeclaration> - the TransactionDeclarations defined in the model manager

modelManager.getEventDeclarations() ⇒ Array.<EventDeclaration>

Get the EventDeclarations defined in this model manager

Kind: instance method of ModelManager
Returns: Array.<EventDeclaration> - the EventDeclaration defined in the model manager

modelManager.getParticipantDeclarations() ⇒ Array.<ParticipantDeclaration>

Get the ParticipantDeclarations defined in this model manager

Kind: instance method of ModelManager
Returns: Array.<ParticipantDeclaration> - the ParticipantDeclaration defined in the model manager

modelManager.getEnumDeclarations() ⇒ Array.<EnumDeclaration>

Get the EnumDeclarations defined in this model manager

Kind: instance method of ModelManager
Returns: Array.<EnumDeclaration> - the EnumDeclaration defined in the model manager

modelManager.getConceptDeclarations() ⇒ Array.<ConceptDeclaration>

Get the Concepts defined in this model manager

Kind: instance method of ModelManager
Returns: Array.<ConceptDeclaration> - the ConceptDeclaration defined in the model manager

modelManager.getFactory() ⇒ Factory

Get a factory for creating new instances of types defined in this model manager.

Kind: instance method of ModelManager
Returns: Factory - A factory for creating new instances of types defined in this model manager.

modelManager.getSerializer() ⇒ Serializer

Get a serializer for serializing instances of types defined in this model manager.

Kind: instance method of ModelManager
Returns: Serializer - A serializer for serializing instances of types defined in this model manager.

modelManager.getDecoratorFactories() ⇒ Array.<DecoratorFactory>

Get the decorator factories for this model manager.

Kind: instance method of ModelManager
Returns: Array.<DecoratorFactory> - The decorator factories for this model manager.

modelManager.addDecoratorFactory(factory)

Add a decorator factory to this model manager.

Kind: instance method of ModelManager

Param	Type	Description
factory	DecoratorFactory	The decorator factory to add to this model manager.

modelManager.derivesFrom(fqt1, fqt2) ⇒ boolean

Checks if this fully qualified type name is derived from another.

Kind: instance method of ModelManager
Returns: boolean - True if this instance is an instance of the specified fully qualified type name, false otherwise.

Param	Type	Description
fqt1	string	The fully qualified type name to check.
fqt2	string	The fully qualified type name it is may be derived from.

ModelManager.Symbol.hasInstance(object) ⇒ boolean

Alternative instanceof that is reliable across different module instances

Kind: static method of ModelManager
Returns: boolean - - True, if the object is an instance of a ModelManager
See: https://github.com/hyperledger/composer-concerto/issues/47

Param	Type	Description
object	object	The object to test against

concerto-core.SecurityException ⇐ BaseException

Class representing a security exception

Kind: static class of concerto-core
Extends: BaseException
See: See BaseException

new SecurityException(message)

Create the SecurityException.

Param	Type	Description
message	string	The exception message.

concerto-core.Serializer

Serialize Resources instances to/from various formats for long-term storage (e.g. on the blockchain).

Kind: static class of concerto-core

• .Serializer
  • new Serializer(factory, modelManager, [options])
  • instance
    • .setDefaultOptions(newDefaultOptions)
    • .toJSON(resource, [options]) ⇒ Object
    • .fromJSON(jsonObject, options) ⇒ Resource
  • static
    • .Symbol.hasInstance(object) ⇒ boolean

new Serializer(factory, modelManager, [options])

Create a Serializer.

Param	Type	Description
factory	Factory	The Factory to use to create instances
modelManager	ModelManager	The ModelManager to use for validation etc.
[options]	object	Serializer options

serializer.setDefaultOptions(newDefaultOptions)

Set the default options for the serializer.

Kind: instance method of Serializer

Param	Type	Description
newDefaultOptions	Object	The new default options for the serializer.

serializer.toJSON(resource, [options]) ⇒ Object

Convert a [Resource](Resource) to a JavaScript object suitable for long-term peristent storage.

Kind: instance method of Serializer
Returns: Object - - The Javascript Object that represents the resource
Throws:

• Error - throws an exception if resource is not an instance of Resource or fails validation.

Param	Type	Description
resource	Resource	The instance to convert to JSON
[options]	Object	the optional serialization options.
[options.validate]	boolean	validate the structure of the Resource with its model prior to serialization (default to true)
[options.convertResourcesToRelationships]	boolean	Convert resources that are specified for relationship fields into relationships, false by default.
[options.permitResourcesForRelationships]	boolean	Permit resources in the place of relationships (serializing them as resources), false by default.
[options.deduplicateResources]	boolean	Generate $id for resources and if a resources appears multiple times in the object graph only the first instance is serialized in full, subsequent instances are replaced with a reference to the $id
[options.convertResourcesToId]	boolean	Convert resources that are specified for relationship fields into their id, false by default.
[options.utcOffset]	number	UTC Offset for DateTime values.

serializer.fromJSON(jsonObject, options) ⇒ Resource

Create a Resource from a JavaScript Object representation. The JavaScript Object should have been created by calling the toJSON API.

The Resource is populated based on the JavaScript object.

Kind: instance method of Serializer
Returns: Resource - The new populated resource

Param	Type	Description
jsonObject	Object	The JavaScript Object for a Resource
options	Object	the optional serialization options
options.acceptResourcesForRelationships	boolean	handle JSON objects in the place of strings for relationships, defaults to false.
options.validate	boolean	validate the structure of the Resource with its model prior to serialization (default to true)
[options.utcOffset]	number	UTC Offset for DateTime values.

Serializer.Symbol.hasInstance(object) ⇒ boolean

Alternative instanceof that is reliable across different module instances

Kind: static method of Serializer
Returns: boolean - - True, if the object is an instance of a Serializer
See: https://github.com/hyperledger/composer-concerto/issues/47

Param	Type	Description
object	object	The object to test against

concerto-core.TypeNotFoundException ⇐ BaseException

Error thrown when a Concerto type does not exist.

Kind: static class of concerto-core
Extends: BaseException
See: see BaseException

• .TypeNotFoundException ⇐ BaseException
  • new TypeNotFoundException(typeName, [message], component)
  • .getTypeName() ⇒ string

new TypeNotFoundException(typeName, [message], component)

Constructor. If the optional 'message' argument is not supplied, it will be set to a default value that includes the type name.

Param	Type	Description
typeName	string	fully qualified type name.
[message]	string	error message.
component	string	the optional component which throws this error

typeNotFoundException.getTypeName() ⇒ string

Get the name of the type that was not found.

Kind: instance method of TypeNotFoundException
Returns: string - fully qualified type name.

concerto-core.AssetDeclaration ⇐ ClassDeclaration

AssetDeclaration defines the schema (aka model or class) for an Asset. It extends ClassDeclaration which manages a set of fields, a super-type and the specification of an identifying field.

Kind: static class of concerto-core
Extends: ClassDeclaration
See: See ClassDeclaration

• .AssetDeclaration ⇐ ClassDeclaration
  • new AssetDeclaration(modelFile, ast)
  • .Symbol.hasInstance(object) ⇒ boolean

new AssetDeclaration(modelFile, ast)

Create an AssetDeclaration.

Throws:

• IllegalModelException

Param	Type	Description
modelFile	ModelFile	the ModelFile for this class
ast	Object	The AST created by the parser

AssetDeclaration.Symbol.hasInstance(object) ⇒ boolean

Alternative instanceof that is reliable across different module instances

Kind: static method of AssetDeclaration
Returns: boolean - - True, if the object is an instance of a AssetDeclaration
See: https://github.com/hyperledger/composer-concerto/issues/47

Param	Type	Description
object	object	The object to test against

concerto-core.ClassDeclaration

ClassDeclaration 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 ClassDeclaration is conceptually owned by a ModelFile which defines all the classes that are part of a namespace.

Kind: static abstract class of concerto-core

• .ClassDeclaration
  • new ClassDeclaration(modelFile, ast)
  • instance
    • ._resolveSuperType() ⇒ ClassDeclaration
    • .isAbstract() ⇒ boolean
    • .isEnum() ⇒ boolean
    • .isConcept() ⇒ boolean
    • .isEvent() ⇒ boolean
    • .getName() ⇒ string
    • .getNamespace() ⇒ string
    • .getFullyQualifiedName() ⇒ string
    • .isIdentified() ⇒ Boolean
    • .isSystemIdentified() ⇒ Boolean
    • .isExplicitlyIdentified() ⇒ Boolean
    • .getIdentifierFieldName() ⇒ string
    • .getOwnProperty(name) ⇒ Property
    • .getOwnProperties() ⇒ Array.<Property>
    • .getSuperType() ⇒ string
    • .getSuperTypeDeclaration() ⇒ ClassDeclaration
    • .getAssignableClassDeclarations() ⇒ Array.<ClassDeclaration>
    • .getAllSuperTypeDeclarations() ⇒ Array.<ClassDeclaration>
    • .getProperty(name) ⇒ Property
    • .getProperties() ⇒ Array.<Property>
    • .getNestedProperty(propertyPath) ⇒ Property
    • .toString() ⇒ String
  • static
    • .Symbol.hasInstance(object) ⇒ boolean

new ClassDeclaration(modelFile, ast)

Create a ClassDeclaration from an Abstract Syntax Tree. The AST is the result of parsing.

Throws:

• IllegalModelException

Param	Type	Description
modelFile	ModelFile	the ModelFile for this class
ast	Object	the AST created by the parser

classDeclaration._resolveSuperType() ⇒ ClassDeclaration

Resolve the super type on this class and store it as an internal property.

Kind: instance method of ClassDeclaration
Returns: ClassDeclaration - The super type, or null if non specified.

classDeclaration.isAbstract() ⇒ boolean

Returns true if this class is declared as abstract in the model file

Kind: instance method of ClassDeclaration
Returns: boolean - true if the class is abstract

classDeclaration.isEnum() ⇒ boolean

Returns true if this class is an enumeration.

Kind: instance method of ClassDeclaration
Returns: boolean - true if the class is an enumerated type

classDeclaration.isConcept() ⇒ boolean

Returns true if this class is the definition of a concept.

Kind: instance method of ClassDeclaration
Returns: boolean - true if the class is a concept

classDeclaration.isEvent() ⇒ boolean

Returns true if this class is the definition of an event.

Kind: instance method of ClassDeclaration
Returns: boolean - true if the class is an event

classDeclaration.getName() ⇒ string

Returns the short name of a class. This name does not include the namespace from the owning ModelFile.

Kind: instance method of ClassDeclaration
Returns: string - the short name of this class

classDeclaration.getNamespace() ⇒ string

Return the namespace of this class.

Kind: instance method of ClassDeclaration
Returns: string - namespace - a namespace.

classDeclaration.getFullyQualifiedName() ⇒ string

Returns the fully qualified name of this class. The name will include the namespace if present.

Kind: instance method of ClassDeclaration
Returns: string - the fully-qualified name of this class

classDeclaration.isIdentified() ⇒ Boolean

Returns true if this class declaration declares an identifying field (system or explicit)

Kind: instance method of ClassDeclaration
Returns: Boolean - true if the class declaration includes an identifier

classDeclaration.isSystemIdentified() ⇒ Boolean

Returns true if this class declaration declares a system identifier $identifier

Kind: instance method of ClassDeclaration
Returns: Boolean - true if the class declaration includes a system identifier

classDeclaration.isExplicitlyIdentified() ⇒ Boolean

Returns true if this class declaration declares an explicit identifier

Kind: instance method of ClassDeclaration
Returns: Boolean - true if the class declaration includes an explicit identifier

classDeclaration.getIdentifierFieldName() ⇒ string

Returns the name of the identifying field for this class. Note that the identifying field may come from a super type.

Kind: instance method of ClassDeclaration
Returns: string - the name of the id field for this class or null if it does not exist

classDeclaration.getOwnProperty(name) ⇒ Property

Returns the field with a given name or null if it does not exist. The field must be directly owned by this class -- the super-type is not introspected.

Kind: instance method of ClassDeclaration
Returns: Property - the field definition or null if it does not exist

Param	Type	Description
name	string	the name of the field

classDeclaration.getOwnProperties() ⇒ Array.<Property>

Returns the fields directly defined by this class.

Kind: instance method of ClassDeclaration
Returns: Array.<Property> - the array of fields

classDeclaration.getSuperType() ⇒ string

Returns the FQN of the super type for this class or null if this class does not have a super type.

Kind: instance method of ClassDeclaration
Returns: string - the FQN name of the super type or null

classDeclaration.getSuperTypeDeclaration() ⇒ ClassDeclaration

Get the super type class declaration for this class.

Kind: instance method of ClassDeclaration
Returns: ClassDeclaration - the super type declaration, or null if there is no super type.

classDeclaration.getAssignableClassDeclarations() ⇒ Array.<ClassDeclaration>

Get the class declarations for all subclasses of this class, including this class.

Kind: instance method of ClassDeclaration
Returns: Array.<ClassDeclaration> - subclass declarations.

classDeclaration.getAllSuperTypeDeclarations() ⇒ Array.<ClassDeclaration>

Get all the super-type declarations for this type.

Kind: instance method of ClassDeclaration
Returns: Array.<ClassDeclaration> - super-type declarations.

classDeclaration.getProperty(name) ⇒ Property

Returns the property with a given name or null if it does not exist. Fields defined in super-types are also introspected.

Kind: instance method of ClassDeclaration
Returns: Property - the field, or null if it does not exist

Param	Type	Description
name	string	the name of the field

classDeclaration.getProperties() ⇒ Array.<Property>

Returns the properties defined in this class and all super classes.

Kind: instance method of ClassDeclaration
Returns: Array.<Property> - the array of fields

classDeclaration.getNestedProperty(propertyPath) ⇒ Property

Get a nested property using a dotted property path

Kind: instance method of ClassDeclaration
Returns: Property - the property
Throws:

• IllegalModelException if the property path is invalid or the property does not exist

Param	Type	Description
propertyPath	string	The property name or name with nested structure e.g a.b.c

classDeclaration.toString() ⇒ String

Returns the string representation of this class

Kind: instance method of ClassDeclaration
Returns: String - the string representation of the class

ClassDeclaration.Symbol.hasInstance(object) ⇒ boolean

Alternative instanceof that is reliable across different module instances

Kind: static method of ClassDeclaration
Returns: boolean - - True, if the object is an instance of a Class Declaration
See: https://github.com/hyperledger/composer-concerto/issues/47

Param	Type	Description
object	object	The object to test against

concerto-core.ConceptDeclaration ⇐ ClassDeclaration

ConceptDeclaration defines the schema (aka model or class) for an Concept. It extends ClassDeclaration which manages a set of fields, a super-type and the specification of an identifying field.

Kind: static class of concerto-core
Extends: ClassDeclaration
See: ClassDeclaration

• .ConceptDeclaration ⇐ ClassDeclaration
  • new ConceptDeclaration(modelFile, ast)
  • instance
    • .isConcept() ⇒ boolean
  • static
    • .Symbol.hasInstance(object) ⇒ boolean

new ConceptDeclaration(modelFile, ast)

Create a ConceptDeclaration.

Throws:

• IllegalModelException

Param	Type	Description
modelFile	ModelFile	the ModelFile for this class
ast	Object	The AST created by the parser

conceptDeclaration.isConcept() ⇒ boolean

Returns true if this class is the definition of a concept.

Kind: instance method of ConceptDeclaration
Returns: boolean - true if the class is a concept

ConceptDeclaration.Symbol.hasInstance(object) ⇒ boolean

Alternative instanceof that is reliable across different module instances

Kind: static method of ConceptDeclaration
Returns: boolean - - True, if the object is an instance of a ConceptDeclaration
See: https://github.com/hyperledger/composer-concerto/issues/47

Param	Type	Description
object	object	The object to test against

concerto-core.Decorator

Decorator encapsulates a decorator (annotation) on a class or property.

Kind: static class of concerto-core

• .Decorator
  • new Decorator(parent, ast)
  • .getParent() ⇒ ClassDeclaration | Property
  • .getName() ⇒ string
  • .getArguments() ⇒ Array.<object>

new Decorator(parent, ast)

Create a Decorator.

Throws:

• IllegalModelException

Param	Type	Description
parent	ClassDeclaration \	Property	the owner of this property
ast	Object	The AST created by the parser

decorator.getParent() ⇒ ClassDeclaration | Property

Returns the owner of this property

Kind: instance method of Decorator
Returns: ClassDeclaration | Property - the parent class or property declaration

decorator.getName() ⇒ string

Returns the name of a decorator

Kind: instance method of Decorator
Returns: string - the name of this decorator

decorator.getArguments() ⇒ Array.<object>

Returns the arguments for this decorator

Kind: instance method of Decorator
Returns: Array.<object> - the arguments for this decorator

concerto-core.DecoratorFactory

An interface for a class that processes a decorator and returns a specific implementation class for that decorator.

Kind: static class of concerto-core

decoratorFactory.newDecorator(parent, ast) ⇒ Decorator

Process the decorator, and return a specific implementation class for that decorator, or return null if this decorator is not handled by this processor.

Kind: instance abstract method of DecoratorFactory
Returns: Decorator - The decorator.

Param	Type	Description
parent	ClassDeclaration \	Property	the owner of this property
ast	Object	The AST created by the parser

concerto-core.EnumDeclaration ⇐ ClassDeclaration

EnumDeclaration defines an enumeration of static values.

Kind: static class of concerto-core
Extends: ClassDeclaration
See: See ClassDeclaration

• .EnumDeclaration ⇐ ClassDeclaration
  • new EnumDeclaration(modelFile, ast)
  • instance
    • .isEnum() ⇒ boolean
    • .toString() ⇒ String
  • static
    • .Symbol.hasInstance(object) ⇒ boolean

new EnumDeclaration(modelFile, ast)

Create an EnumDeclaration.

Throws:

• IllegalModelException

Param	Type	Description
modelFile	ModelFile	the ModelFile for this class
ast	Object	The AST created by the parser

enumDeclaration.isEnum() ⇒ boolean

Returns true if this class is an enumeration.

Kind: instance method of EnumDeclaration
Returns: boolean - true if the class is an enumerated type

enumDeclaration.toString() ⇒ String

Returns the string representation of this class

Kind: instance method of EnumDeclaration
Returns: String - the string representation of the class

EnumDeclaration.Symbol.hasInstance(object) ⇒ boolean

Alternative instanceof that is reliable across different module instances

Kind: static method of EnumDeclaration
Returns: boolean - - True, if the object is an instance of a Class Declaration
See: https://github.com/hyperledger/composer-concerto/issues/47

Param	Type	Description
object	object	The object to test against

concerto-core.EnumValueDeclaration ⇐ Property

Class representing a value from a set of enumerated values

Kind: static class of concerto-core
Extends: Property
See: See Property

• .EnumValueDeclaration ⇐ Property
  • new EnumValueDeclaration(parent, ast)
  • .Symbol.hasInstance(object) ⇒ boolean

new EnumValueDeclaration(parent, ast)

Create a EnumValueDeclaration.

Throws:

• IllegalModelException

Param	Type	Description
parent	ClassDeclaration	The owner of this property
ast	Object	The AST created by the parser

EnumValueDeclaration.Symbol.hasInstance(object) ⇒ boolean

Alternative instanceof that is reliable across different module instances

Kind: static method of EnumValueDeclaration
Returns: boolean - - True, if the object is an instance of a EnumValueDeclaration
See: https://github.com/hyperledger/composer-concerto/issues/47

Param	Type	Description
object	object	The object to test against

concerto-core.EventDeclaration ⇐ ClassDeclaration

Class representing the definition of an Event.

Kind: static class of concerto-core
Extends: ClassDeclaration
See: See ClassDeclaration

• .EventDeclaration ⇐ ClassDeclaration
  • new EventDeclaration(modelFile, ast)
  • instance
    • .isEvent() ⇒ boolean
  • static
    • .Symbol.hasInstance(object) ⇒ boolean

new EventDeclaration(modelFile, ast)

Create an EventDeclaration.

Throws:

• IllegalModelException

Param	Type	Description
modelFile	ModelFile	the ModelFile for this class
ast	Object	The AST created by the parser

eventDeclaration.isEvent() ⇒ boolean

Returns true if this class is the definition of an event

Kind: instance method of EventDeclaration
Returns: boolean - true if the class is an event

EventDeclaration.Symbol.hasInstance(object) ⇒ boolean

Alternative instanceof that is reliable across different module instances

Kind: static method of EventDeclaration
Returns: boolean - - True, if the object is an instance of a EventDeclaration
See: https://github.com/hyperledger/composer-concerto/issues/47

Param	Type	Description
object	object	The object to test against

concerto-core.IdentifiedDeclaration ⇐ ClassDeclaration

IdentifiedDeclaration

Kind: static abstract class of concerto-core
Extends: ClassDeclaration
See: See ClassDeclaration

• .IdentifiedDeclaration ⇐ ClassDeclaration
  • new IdentifiedDeclaration(modelFile, ast)
  • .Symbol.hasInstance(object) ⇒ boolean

new IdentifiedDeclaration(modelFile, ast)

Create an AssetDeclaration.

Throws:

• IllegalModelException

Param	Type	Description
modelFile	ModelFile	the ModelFile for this class
ast	Object	The AST created by the parser

IdentifiedDeclaration.Symbol.hasInstance(object) ⇒ boolean

Alternative instanceof that is reliable across different module instances

Kind: static method of IdentifiedDeclaration
Returns: boolean - - True, if the object is an instance of a AssetDeclaration
See: https://github.com/hyperledger/composer-concerto/issues/47

Param	Type	Description
object	object	The object to test against

concerto-core.IllegalModelException ⇐ BaseFileException

Exception throws when a composer file is semantically invalid

Kind: static class of concerto-core
Extends: BaseFileException
See: See BaseFileException

new IllegalModelException(message, [modelFile], [fileLocation], [component])

Create an IllegalModelException.

Param	Type	Description
message	string	the message for the exception
[modelFile]	ModelFile	the modelfile associated with the exception
[fileLocation]	Object	location details of the error within the model file.
fileLocation.start.line	number	start line of the error location.
fileLocation.start.column	number	start column of the error location.
fileLocation.end.line	number	end line of the error location.
fileLocation.end.column	number	end column of the error location.
[component]	string	the component which throws this error

concerto-core.Introspector

Provides access to the structure of transactions, assets and participants.

Kind: static class of concerto-core

• .Introspector
  • new Introspector(modelManager)
  • .getClassDeclarations() ⇒ Array.<ClassDeclaration>
  • .getClassDeclaration(fullyQualifiedTypeName) ⇒ ClassDeclaration

new Introspector(modelManager)

Create the Introspector.

Param	Type	Description
modelManager	ModelManager	the ModelManager that backs this Introspector

introspector.getClassDeclarations() ⇒ Array.<ClassDeclaration>

Returns all the class declarations for the business network.

Kind: instance method of Introspector
Returns: Array.<ClassDeclaration> - the array of class declarations

introspector.getClassDeclaration(fullyQualifiedTypeName) ⇒ ClassDeclaration

Returns the class declaration with the given fully qualified name. Throws an error if the class declaration does not exist.

Kind: instance method of Introspector
Returns: ClassDeclaration - the class declaration
Throws:

• Error if the class declaration does not exist

Param	Type	Description
fullyQualifiedTypeName	String	the fully qualified name of the type

concerto-core.ModelFile

Class representing a Model File. A Model File contains a single namespace and a set of model elements: assets, transactions etc.

Kind: static class of concerto-core

• .ModelFile
  • new ModelFile(modelManager, definitions, [fileName])
  • instance
    • .isSystemModelFile() ⇒ Boolean
    • .isExternal() ⇒ boolean
    • .getModelManager() ⇒ ModelManager
    • .getImports() ⇒ Array.<string>
    • .isDefined(type) ⇒ boolean
    • .getLocalType(type) ⇒ ClassDeclaration
    • .getAssetDeclaration(name) ⇒ AssetDeclaration
    • .getTransactionDeclaration(name) ⇒ TransactionDeclaration
    • .getEventDeclaration(name) ⇒ EventDeclaration
    • .getParticipantDeclaration(name) ⇒ ParticipantDeclaration
    • .getNamespace() ⇒ string
    • .getName() ⇒ string
    • .getAssetDeclarations() ⇒ Array.<AssetDeclaration>
    • .getTransactionDeclarations() ⇒ Array.<TransactionDeclaration>
    • .getEventDeclarations() ⇒ Array.<EventDeclaration>
    • .getParticipantDeclarations() ⇒ Array.<ParticipantDeclaration>
    • .getConceptDeclarations() ⇒ Array.<ConceptDeclaration>
    • .getEnumDeclarations() ⇒ Array.<EnumDeclaration>
    • .getDeclarations(type) ⇒ Array.<ClassDeclaration>
    • .getAllDeclarations() ⇒ Array.<ClassDeclaration>
    • .getDefinitions() ⇒ string
    • .getConcertoVersion() ⇒ string
  • static
    • .Symbol.hasInstance(object) ⇒ boolean

new ModelFile(modelManager, definitions, [fileName])

Create a ModelFile. This should only be called by framework code. Use the ModelManager to manage ModelFiles.

Throws:

• IllegalModelException

Param	Type	Description
modelManager	ModelManager	the ModelManager that manages this ModelFile
definitions	string	The DSL model as a string.
[fileName]	string	The optional filename for this modelfile

modelFile.isSystemModelFile() ⇒ Boolean

Returns true if the ModelFile is a system namespace

Kind: instance method of ModelFile
Returns: Boolean - true if this is a system model file

modelFile.isExternal() ⇒ boolean

Returns true if this ModelFile was downloaded from an external URI.

Kind: instance method of ModelFile
Returns: boolean - true iff this ModelFile was downloaded from an external URI

modelFile.getModelManager() ⇒ ModelManager

Returns the ModelManager associated with this ModelFile

Kind: instance method of ModelFile
Returns: ModelManager - The ModelManager for this ModelFile

modelFile.getImports() ⇒ Array.<string>

Returns the types that have been imported into this ModelFile.

Kind: instance method of ModelFile
Returns: Array.<string> - The array of imports for this ModelFile

modelFile.isDefined(type) ⇒ boolean

Returns true if the type is defined in the model file

Kind: instance method of ModelFile
Returns: boolean - true if the type (asset or transaction) is defined

Param	Type	Description
type	string	the name of the type

modelFile.getLocalType(type) ⇒ ClassDeclaration

Returns the type with the specified name or null

Kind: instance method of ModelFile
Returns: ClassDeclaration - the ClassDeclaration, or null if the type does not exist

Param	Type	Description
type	string	the short OR FQN name of the type

modelFile.getAssetDeclaration(name) ⇒ AssetDeclaration

Get the AssetDeclarations defined in this ModelFile or null

Kind: instance method of ModelFile
Returns: AssetDeclaration - the AssetDeclaration with the given short name

Param	Type	Description
name	string	the name of the type

modelFile.getTransactionDeclaration(name) ⇒ TransactionDeclaration

Get the TransactionDeclaration defined in this ModelFile or null

Kind: instance method of ModelFile
Returns: TransactionDeclaration - the TransactionDeclaration with the given short name

Param	Type	Description
name	string	the name of the type

modelFile.getEventDeclaration(name) ⇒ EventDeclaration

Get the EventDeclaration defined in this ModelFile or null

Kind: instance method of ModelFile
Returns: EventDeclaration - the EventDeclaration with the given short name

Param	Type	Description
name	string	the name of the type

modelFile.getParticipantDeclaration(name) ⇒ ParticipantDeclaration

Get the ParticipantDeclaration defined in this ModelFile or null

Kind: instance method of ModelFile
Returns: ParticipantDeclaration - the ParticipantDeclaration with the given short name

Param	Type	Description
name	string	the name of the type

modelFile.getNamespace() ⇒ string

Get the Namespace for this model file.

Kind: instance method of ModelFile
Returns: string - The Namespace for this model file

modelFile.getName() ⇒ string

Get the filename for this model file. Note that this may be null.

Kind: instance method of ModelFile
Returns: string - The filename for this model file

modelFile.getAssetDeclarations() ⇒ Array.<AssetDeclaration>

Get the AssetDeclarations defined in this ModelFile

Kind: instance method of ModelFile
Returns: Array.<AssetDeclaration> - the AssetDeclarations defined in the model file

modelFile.getTransactionDeclarations() ⇒ Array.<TransactionDeclaration>

Get the TransactionDeclarations defined in this ModelFile

Kind: instance method of ModelFile
Returns: Array.<TransactionDeclaration> - the TransactionDeclarations defined in the model file

modelFile.getEventDeclarations() ⇒ Array.<EventDeclaration>

Get the EventDeclarations defined in this ModelFile

Kind: instance method of ModelFile
Returns: Array.<EventDeclaration> - the EventDeclarations defined in the model file

modelFile.getParticipantDeclarations() ⇒ Array.<ParticipantDeclaration>

Get the ParticipantDeclarations defined in this ModelFile

Kind: instance method of ModelFile
Returns: Array.<ParticipantDeclaration> - the ParticipantDeclaration defined in the model file

modelFile.getConceptDeclarations() ⇒ Array.<ConceptDeclaration>

Get the ConceptDeclarations defined in this ModelFile

Kind: instance method of ModelFile
Returns: Array.<ConceptDeclaration> - the ParticipantDeclaration defined in the model file

modelFile.getEnumDeclarations() ⇒ Array.<EnumDeclaration>

Get the EnumDeclarations defined in this ModelFile

Kind: instance method of ModelFile
Returns: Array.<EnumDeclaration> - the EnumDeclaration defined in the model file

modelFile.getDeclarations(type) ⇒ Array.<ClassDeclaration>

Get the instances of a given type in this ModelFile

Kind: instance method of ModelFile
Returns: Array.<ClassDeclaration> - the ClassDeclaration defined in the model file

Param	Type	Description
type	function	the type of the declaration

modelFile.getAllDeclarations() ⇒ Array.<ClassDeclaration>

Get all declarations in this ModelFile

Kind: instance method of ModelFile
Returns: Array.<ClassDeclaration> - the ClassDeclarations defined in the model file

modelFile.getDefinitions() ⇒ string

Get the definitions for this model.

Kind: instance method of ModelFile
Returns: string - The definitions for this model.

modelFile.getConcertoVersion() ⇒ string

Get the expected concerto version

Kind: instance method of ModelFile
Returns: string - The semver range for compatible concerto versions

ModelFile.Symbol.hasInstance(object) ⇒ boolean

Alternative to instanceof that is reliable across different module instances

Kind: static method of ModelFile
Returns: boolean - - True, if the object is an instance of a ModelFile
See: https://github.com/hyperledger/composer-concerto/issues/47

Param	Type	Description
object	object	The object to test against

concerto-core.ParticipantDeclaration ⇐ ClassDeclaration

Class representing the definition of a Participant.

Kind: static class of concerto-core
Extends: ClassDeclaration
See: See ClassDeclaration

• .ParticipantDeclaration ⇐ ClassDeclaration
  • new ParticipantDeclaration(modelFile, ast)
  • .Symbol.hasInstance(object) ⇒ boolean

new ParticipantDeclaration(modelFile, ast)

Create an ParticipantDeclaration.

Throws:

• IllegalModelException

Param	Type	Description
modelFile	ModelFile	the ModelFile for this class
ast	Object	The AST created by the parser

ParticipantDeclaration.Symbol.hasInstance(object) ⇒ boolean

Alternative instanceof that is reliable across different module instances

Kind: static method of ParticipantDeclaration
Returns: boolean - - True, if the object is an instance of a ParticipantDeclaration
See: https://github.com/hyperledger/composer-concerto/issues/47

Param	Type	Description
object	object	The object to test against

concerto-core.Property

Property representing an attribute of a class declaration, either a Field or a Relationship.

Kind: static class of concerto-core

• .Property
  • new Property(parent, ast)
  • instance
    • .getParent() ⇒ ClassDeclaration
    • .getName() ⇒ string
    • .getType() ⇒ string
    • .isOptional() ⇒ boolean
    • .getFullyQualifiedTypeName() ⇒ string
    • .getFullyQualifiedName() ⇒ string
    • .getNamespace() ⇒ string
    • .isArray() ⇒ boolean
    • .isTypeEnum() ⇒ boolean
    • .isPrimitive() ⇒ boolean
  • static
    • .Symbol.hasInstance(object) ⇒ boolean

new Property(parent, ast)

Create a Property.

Throws:

• IllegalModelException

Param	Type	Description
parent	ClassDeclaration	the owner of this property
ast	Object	The AST created by the parser

property.getParent() ⇒ ClassDeclaration

Returns the owner of this property

Kind: instance method of Property
Returns: ClassDeclaration - the parent class declaration

property.getName() ⇒ string

Returns the name of a property

Kind: instance method of Property
Returns: string - the name of this field

property.getType() ⇒ string

Returns the type of a property

Kind: instance method of Property
Returns: string - the type of this field

property.isOptional() ⇒ boolean

Returns true if the field is optional

Kind: instance method of Property
Returns: boolean - true if the field is optional

property.getFullyQualifiedTypeName() ⇒ string

Returns the fully qualified type name of a property

Kind: instance method of Property
Returns: string - the fully qualified type of this property

property.getFullyQualifiedName() ⇒ string

Returns the fully name of a property (ns + class name + property name)

Kind: instance method of Property
Returns: string - the fully qualified name of this property

property.getNamespace() ⇒ string

Returns the namespace of the parent of this property

Kind: instance method of Property
Returns: string - the namespace of the parent of this property

property.isArray() ⇒ boolean

Returns true if the field is declared as an array type

Kind: instance method of Property
Returns: boolean - true if the property is an array type

property.isTypeEnum() ⇒ boolean

Returns true if the field is declared as an enumerated value

Kind: instance method of Property
Returns: boolean - true if the property is an enumerated value

property.isPrimitive() ⇒ boolean

Returns true if this property is a primitive type.

Kind: instance method of Property
Returns: boolean - true if the property is a primitive type.

Property.Symbol.hasInstance(object) ⇒ boolean

Alternative instanceof that is reliable across different module instances

Kind: static method of Property
Returns: boolean - - True, if the object is an instance of a Property
See: https://github.com/hyperledger/composer-concerto/issues/47

Param	Type	Description
object	object	The object to test against

concerto-core.RelationshipDeclaration ⇐ Property

Class representing a relationship between model elements

Kind: static class of concerto-core
Extends: Property
See: See Property

• .RelationshipDeclaration ⇐ Property
  • new RelationshipDeclaration(parent, ast)
  • instance
    • .toString() ⇒ String
  • static
    • .Symbol.hasInstance(object) ⇒ boolean

new RelationshipDeclaration(parent, ast)

Create a Relationship.

Throws:

• IllegalModelException

Param	Type	Description
parent	ClassDeclaration	The owner of this property
ast	Object	The AST created by the parser

relationshipDeclaration.toString() ⇒ String

Returns a string representation of this property

Kind: instance method of RelationshipDeclaration
Returns: String - the string version of the property.

RelationshipDeclaration.Symbol.hasInstance(object) ⇒ boolean

Alternative instanceof that is reliable across different module instances

Kind: static method of RelationshipDeclaration
Returns: boolean - - True, if the object is an instance of a RelationshipDeclaration
See: https://github.com/hyperledger/composer-concerto/issues/47

Param	Type	Description
object	object	The object to test against

concerto-core.TransactionDeclaration ⇐ ClassDeclaration

Class representing the definition of an Transaction.

Kind: static class of concerto-core
Extends: ClassDeclaration
See: See ClassDeclaration

• .TransactionDeclaration ⇐ ClassDeclaration
  • new TransactionDeclaration(modelFile, ast)
  • .Symbol.hasInstance(object) ⇒ boolean

new TransactionDeclaration(modelFile, ast)

Create an TransactionDeclaration.

Throws:

• IllegalModelException

Param	Type	Description
modelFile	ModelFile	the ModelFile for this class
ast	Object	The AST created by the parser

TransactionDeclaration.Symbol.hasInstance(object) ⇒ boolean

Alternative instanceof that is reliable across different module instances

Kind: static method of TransactionDeclaration
Returns: boolean - - True, if the object is an instance of a TransactionDeclaration
See: https://github.com/hyperledger/composer-concerto/issues/47

Param	Type	Description
object	object	The object to test against

concerto-core.Resource ⇐ Identifiable

Resource is an instance that has a type. The type of the resource specifies a set of properites (which themselves have types).

Type information in Concerto is used to validate the structure of Resource instances and for serialization.

Resources are used in Concerto to represent Assets, Participants, Transactions and other domain classes that can be serialized for long-term persistent storage.

Kind: static class of concerto-core
Extends: Identifiable
Access: public
See: See Resource

• .Resource ⇐ Identifiable
  • new Resource(modelManager, classDeclaration, ns, type, id, timestamp)
  • .toString() ⇒ String
  • .isResource() ⇒ boolean
  • .isConcept() ⇒ boolean
  • .isIdentifiable() ⇒ boolean
  • .toJSON() ⇒ Object

new Resource(modelManager, classDeclaration, ns, type, id, timestamp)

This constructor should not be called directly.

Note: Only to be called by framework code. Applications should retrieve instances from [Factory](Factory)

Param	Type	Description
modelManager	ModelManager	The ModelManager for this instance
classDeclaration	ClassDeclaration	The class declaration for this instance.
ns	string	The namespace this instance.
type	string	The type this instance.
id	string	The identifier of this instance.
timestamp	string	The timestamp of this instance

resource.toString() ⇒ String

Returns the string representation of this class

Kind: instance method of Resource
Returns: String - the string representation of the class

resource.isResource() ⇒ boolean

Determine if this identifiable is a resource.

Kind: instance method of Resource
Returns: boolean - True if this identifiable is a resource, false if not.

resource.isConcept() ⇒ boolean

Determine if this identifiable is a concept.

Kind: instance method of Resource
Returns: boolean - True if this identifiable is a concept, false if not.

resource.isIdentifiable() ⇒ boolean

Determine if this object is identifiable.

Kind: instance method of Resource
Returns: boolean - True if this object has an identifiying field false if not.

resource.toJSON() ⇒ Object

Serialize this resource into a JavaScript object suitable for serialization to JSON, using the default options for the serializer. If you need to set additional options for the serializer, use the Serializer#toJSON method instead.

Kind: instance method of Resource
Returns: Object - A JavaScript object suitable for serialization to JSON.

concerto-core.TypedStack

Tracks a stack of typed instances. The type information is used to detect overflow / underflow bugs by the caller. It also performs basic sanity checking on push/pop to make detecting bugs easier.

Kind: static class of concerto-core

• .TypedStack
  • new TypedStack(resource)
  • .push(obj, expectedType)
  • .pop(expectedType) ⇒ Object
  • .peek(expectedType) ⇒ Object
  • .clear()

new TypedStack(resource)

Create the Stack with the resource at the head.

Param	Type	Description
resource	Object	the resource to be put at the head of the stack

typedStack.push(obj, expectedType)

Push a new object.

Kind: instance method of TypedStack

Param	Type	Description
obj	Object	the object being visited
expectedType	Object	the expected type of the object being pushed

typedStack.pop(expectedType) ⇒ Object

Push a new object.

Kind: instance method of TypedStack
Returns: Object - the result of pop

Param	Type	Description
expectedType	Object	the type that should be the result of pop

typedStack.peek(expectedType) ⇒ Object

Peek the top of the stack

Kind: instance method of TypedStack
Returns: Object - the result of peek

Param	Type	Description
expectedType	Object	the type that should be the result of pop

typedStack.clear()

Clears the stack

Kind: instance method of TypedStack

levels : Object

Default levels for the npm configuration.

Kind: global constant

colorMap : Object

Default levels for the npm configuration.

Kind: global constant

setCurrentTime([currentTime], [utcOffset]) ⇒ object

Ensures there is a proper current time

Kind: global function
Returns: object - if valid, the dayjs object for the current time

Param	Type	Description
[currentTime]	string	the definition of 'now'
[utcOffset]	number	UTC Offset for this execution

randomNumberInRangeWithPrecision(userMin, userMax, precision, systemMin, systemMax) ⇒ number

Generate a random number within a given range with a prescribed precision and inside a global range

Kind: global function
Returns: number - a number

Param	Type	Description
userMin	*	Lower bound on the range, inclusive. Defaults to systemMin
userMax	*	Upper bound on the range, inclusive. Defaults to systemMax
precision	*	The precision of values returned, e.g. a value of 1 returns only whole numbers
systemMin	*	Global minimum on the range, takes precidence over the userMin
systemMax	*	Global maximum on the range, takes precidence over the userMax