;
+ importWildcardNamespaces: any[];
+ importUriMap: {};
+ fileName: string;
+ concertoVersion: any;
+ definitions: string;
+ ast: any;
+ /**
+ * Returns true
+ * @returns {boolean} true
+ */
+ isModelFile(): boolean;
+ /**
+ * Returns true if the ModelFile is a system namespace
+ * @returns {Boolean} true if this is a system model file
+ */
+ isSystemModelFile(): boolean;
+ /**
+ * Returns true if this ModelFile was downloaded from an external URI.
+ * @return {boolean} true iff this ModelFile was downloaded from an external URI
+ */
+ isExternal(): boolean;
+ /**
+ * Returns the URI for an import, or null if the namespace was not associated with a URI.
+ * @param {string} namespace - the namespace for the import
+ * @return {string} the URI or null if the namespace was not associated with a URI.
+ * @private
+ */
+ private getImportURI;
+ /**
+ * Returns an object that maps from the import declarations to the URIs specified
+ * @return {Object} keys are import declarations, values are URIs
+ * @private
+ */
+ private getExternalImports;
+ /**
+ * Visitor design pattern
+ * @param {Object} visitor - the visitor
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private accept;
+ /**
+ * Returns the ModelManager associated with this ModelFile
+ *
+ * @return {ModelManager} The ModelManager for this ModelFile
+ */
+ getModelManager(): ModelManager;
+ /**
+ * Returns the types that have been imported into this ModelFile.
+ *
+ * @return {string[]} The array of imports for this ModelFile
+ */
+ getImports(): string[];
+ /**
+ * Validates the ModelFile.
+ *
+ * @throws {IllegalModelException} if the model is invalid
+ * @private
+ */
+ private validate;
+ /**
+ * Check that the type is valid.
+ * @param {string} context - error reporting context
+ * @param {string} type - a short type name
+ * @param {Object} [fileLocation] - location details of the error within the model file.
+ * @param {String} fileLocation.start.line - start line of the error location.
+ * @param {String} fileLocation.start.column - start column of the error location.
+ * @param {String} fileLocation.end.line - end line of the error location.
+ * @param {String} fileLocation.end.column - end column of the error location.
+ * @throws {IllegalModelException} - if the type is not defined
+ * @private
+ */
+ private resolveType;
+ /**
+ * Returns true if the type is defined in this namespace.
+ * @param {string} type - the short name of the type
+ * @return {boolean} - true if the type is defined in this ModelFile
+ * @private
+ */
+ private isLocalType;
+ /**
+ * Returns true if the type is imported from another namespace
+ * @param {string} type - the short name of the type
+ * @return {boolean} - true if the type is imported from another namespace
+ * @private
+ */
+ private isImportedType;
+ /**
+ * Returns the FQN for a type that is imported from another namespace
+ * @param {string} type - the short name of the type
+ * @return {string} - the FQN of the resolved import
+ * @throws {Error} - if the type is not imported
+ * @private
+ */
+ private resolveImport;
+ /**
+ * Returns true if the type is defined in the model file
+ * @param {string} type the name of the type
+ * @return {boolean} true if the type (asset or transaction) is defined
+ */
+ isDefined(type: string): boolean;
+ /**
+ * Returns the FQN of the type or null if the type could not be resolved.
+ * For primitive types the type name is returned.
+ * @param {string} type - a FQN or short type name
+ * @return {string | ClassDeclaration} the class declaration for the type or null.
+ * @private
+ */
+ private getType;
+ /**
+ * Returns the FQN of the type or null if the type could not be resolved.
+ * For primitive types the short type name is returned.
+ * @param {string} type - a FQN or short type name
+ * @return {string} the FQN type name or null
+ * @private
+ */
+ private getFullyQualifiedTypeName;
+ /**
+ * Returns the type with the specified name or null
+ * @param {string} type the short OR FQN name of the type
+ * @return {ClassDeclaration} the ClassDeclaration, or null if the type does not exist
+ */
+ getLocalType(type: string): ClassDeclaration;
+ /**
+ * Get the AssetDeclarations defined in this ModelFile or null
+ * @param {string} name the name of the type
+ * @return {AssetDeclaration} the AssetDeclaration with the given short name
+ */
+ getAssetDeclaration(name: string): AssetDeclaration;
+ /**
+ * Get the TransactionDeclaration defined in this ModelFile or null
+ * @param {string} name the name of the type
+ * @return {TransactionDeclaration} the TransactionDeclaration with the given short name
+ */
+ getTransactionDeclaration(name: string): TransactionDeclaration;
+ /**
+ * Get the EventDeclaration defined in this ModelFile or null
+ * @param {string} name the name of the type
+ * @return {EventDeclaration} the EventDeclaration with the given short name
+ */
+ getEventDeclaration(name: string): EventDeclaration;
+ /**
+ * Get the ParticipantDeclaration defined in this ModelFile or null
+ * @param {string} name the name of the type
+ * @return {ParticipantDeclaration} the ParticipantDeclaration with the given short name
+ */
+ getParticipantDeclaration(name: string): ParticipantDeclaration;
+ /**
+ * Get the Namespace for this model file.
+ * @return {string} The Namespace for this model file
+ */
+ getNamespace(): string;
+ /**
+ * Get the filename for this model file. Note that this may be null.
+ * @return {string} The filename for this model file
+ */
+ getName(): string;
+ /**
+ * Get the AssetDeclarations defined in this ModelFile
+ * @return {AssetDeclaration[]} the AssetDeclarations defined in the model file
+ */
+ getAssetDeclarations(): AssetDeclaration[];
+ /**
+ * Get the TransactionDeclarations defined in this ModelFile
+ * @return {TransactionDeclaration[]} the TransactionDeclarations defined in the model file
+ */
+ getTransactionDeclarations(): TransactionDeclaration[];
+ /**
+ * Get the EventDeclarations defined in this ModelFile
+ * @return {EventDeclaration[]} the EventDeclarations defined in the model file
+ */
+ getEventDeclarations(): EventDeclaration[];
+ /**
+ * Get the ParticipantDeclarations defined in this ModelFile
+ * @return {ParticipantDeclaration[]} the ParticipantDeclaration defined in the model file
+ */
+ getParticipantDeclarations(): ParticipantDeclaration[];
+ /**
+ * Get the ConceptDeclarations defined in this ModelFile
+ * @return {ConceptDeclaration[]} the ParticipantDeclaration defined in the model file
+ */
+ getConceptDeclarations(): ConceptDeclaration[];
+ /**
+ * Get the EnumDeclarations defined in this ModelFile
+ * @return {EnumDeclaration[]} the EnumDeclaration defined in the model file
+ */
+ getEnumDeclarations(): EnumDeclaration[];
+ /**
+ * Get the instances of a given type in this ModelFile
+ * @param {Function} type - the type of the declaration
+ * @return {ClassDeclaration[]} the ClassDeclaration defined in the model file
+ */
+ getDeclarations(type: Function): ClassDeclaration[];
+ /**
+ * Get all declarations in this ModelFile
+ * @return {ClassDeclaration[]} the ClassDeclarations defined in the model file
+ */
+ getAllDeclarations(): ClassDeclaration[];
+ /**
+ * Get the definitions for this model.
+ * @return {string} The definitions for this model.
+ */
+ getDefinitions(): string;
+ /**
+ * Get the expected concerto version
+ * @return {string} The semver range for compatible concerto versions
+ */
+ getConcertoVersion(): string;
+ /**
+ * Check whether this modelfile is compatible with the concerto version
+ */
+ isCompatibleVersion(): void;
+ /**
+ * Populate from an AST
+ * @param {object} ast - the AST obtained from the parser
+ * @private
+ */
+ private fromAst;
+ namespace: any;
+}
+import AssetDeclaration = require("./assetdeclaration");
+import TransactionDeclaration = require("./transactiondeclaration");
+import EventDeclaration = require("./eventdeclaration");
+import ParticipantDeclaration = require("./participantdeclaration");
+import ConceptDeclaration = require("./conceptdeclaration");
+import EnumDeclaration = require("./enumdeclaration");
diff --git a/packages/concerto-core/types/lib/introspect/numbervalidator.d.ts b/packages/concerto-core/types/lib/introspect/numbervalidator.d.ts
new file mode 100644
index 0000000000..c753316cfa
--- /dev/null
+++ b/packages/concerto-core/types/lib/introspect/numbervalidator.d.ts
@@ -0,0 +1,22 @@
+export = NumberValidator;
+/**
+ * A Validator to enforce that non null numeric values are between two values.
+ * @private
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class NumberValidator extends Validator {
+ lowerBound: any;
+ upperBound: any;
+ /**
+ * Returns the lower bound for this validator, or null if not specified
+ * @returns {number} the lower bound or null
+ */
+ getLowerBound(): number;
+ /**
+ * Returns the upper bound for this validator, or null if not specified
+ * @returns {number} the upper bound or null
+ */
+ getUpperBound(): number;
+}
+import Validator = require("./validator");
diff --git a/packages/concerto-core/types/lib/introspect/parseexception.d.ts b/packages/concerto-core/types/lib/introspect/parseexception.d.ts
new file mode 100644
index 0000000000..dc00643c16
--- /dev/null
+++ b/packages/concerto-core/types/lib/introspect/parseexception.d.ts
@@ -0,0 +1,21 @@
+export = ParseException;
+/**
+ * Exception throws when a Concerto file is syntactically invalid
+ * @extends BaseFileException
+ * @see See {@link BaseFileException}
+ * @class
+ * @memberof module:concerto-core
+ * @private
+ */
+declare class ParseException extends BaseFileException {
+ /**
+ * Create an ParseException
+ * @param {string} message - the message for the exception
+ * @param {string} [fileLocation] - the file location associated with the exception
+ * @param {string} [fileName] - the file name associated with the exception
+ * @param {string} [fullMessageOverride] - the pre-existing full message
+ * @param {string} [component] - the component which throws this error
+ */
+ constructor(message: string, fileLocation?: string, fileName?: string, fullMessageOverride?: string, component?: string);
+}
+import BaseFileException = require("../basefileexception");
diff --git a/packages/concerto-core/types/lib/introspect/parser.d.ts b/packages/concerto-core/types/lib/introspect/parser.d.ts
new file mode 100644
index 0000000000..611c93fde8
--- /dev/null
+++ b/packages/concerto-core/types/lib/introspect/parser.d.ts
@@ -0,0 +1,10 @@
+declare function peg$SyntaxError(message: any, expected: any, found: any, location: any): any;
+declare class peg$SyntaxError {
+ constructor(message: any, expected: any, found: any, location: any);
+ format(sources: any): string;
+}
+declare namespace peg$SyntaxError {
+ function buildMessage(expected: any, found: any): string;
+}
+declare function peg$parse(input: any, options: any): any;
+export { peg$SyntaxError as SyntaxError, peg$parse as parse };
diff --git a/packages/concerto-core/types/lib/introspect/participantdeclaration.d.ts b/packages/concerto-core/types/lib/introspect/participantdeclaration.d.ts
new file mode 100644
index 0000000000..b475aeff19
--- /dev/null
+++ b/packages/concerto-core/types/lib/introspect/participantdeclaration.d.ts
@@ -0,0 +1,17 @@
+export = ParticipantDeclaration;
+/** Class representing the definition of a Participant.
+ * @extends ClassDeclaration
+ * @see See {@link ClassDeclaration}
+ *
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class ParticipantDeclaration {
+ /**
+ * Create an ParticipantDeclaration.
+ * @param {ModelFile} modelFile the ModelFile for this class
+ * @param {Object} ast - The AST created by the parser
+ * @throws {IllegalModelException}
+ */
+ constructor(modelFile: ModelFile, ast: any);
+}
diff --git a/packages/concerto-core/types/lib/introspect/property.d.ts b/packages/concerto-core/types/lib/introspect/property.d.ts
new file mode 100644
index 0000000000..79ab135cdb
--- /dev/null
+++ b/packages/concerto-core/types/lib/introspect/property.d.ts
@@ -0,0 +1,74 @@
+export = Property;
+/**
+ * Property representing an attribute of a class declaration,
+ * either a Field or a Relationship.
+ *
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class Property extends Decorated {
+ /**
+ * Create a Property.
+ * @param {ClassDeclaration} parent - the owner of this property
+ * @param {Object} ast - The AST created by the parser
+ * @throws {IllegalModelException}
+ */
+ constructor(parent: ClassDeclaration, ast: any);
+ parent: ClassDeclaration;
+ /**
+ * Returns the owner of this property
+ * @return {ClassDeclaration} the parent class declaration
+ */
+ getParent(): ClassDeclaration;
+ name: any;
+ decorator: any;
+ type: any;
+ array: boolean;
+ optional: boolean;
+ /**
+ * Returns the name of a property
+ * @return {string} the name of this field
+ */
+ getName(): string;
+ /**
+ * Returns the type of a property
+ * @return {string} the type of this field
+ */
+ getType(): string;
+ /**
+ * Returns true if the field is optional
+ * @return {boolean} true if the field is optional
+ */
+ isOptional(): boolean;
+ /**
+ * Returns the fully qualified type name of a property
+ * @return {string} the fully qualified type of this property
+ */
+ getFullyQualifiedTypeName(): string;
+ /**
+ * Returns the fully name of a property (ns + class name + property name)
+ * @return {string} the fully qualified name of this property
+ */
+ getFullyQualifiedName(): string;
+ /**
+ * Returns the namespace of the parent of this property
+ * @return {string} the namespace of the parent of this property
+ */
+ getNamespace(): string;
+ /**
+ * Returns true if the field is declared as an array type
+ * @return {boolean} true if the property is an array type
+ */
+ isArray(): boolean;
+ /**
+ * Returns true if the field is declared as an enumerated value
+ * @return {boolean} true if the property is an enumerated value
+ */
+ isTypeEnum(): boolean;
+ /**
+ * Returns true if this property is a primitive type.
+ * @return {boolean} true if the property is a primitive type.
+ */
+ isPrimitive(): boolean;
+}
+import Decorated = require("./decorated");
diff --git a/packages/concerto-core/types/lib/introspect/relationshipdeclaration.d.ts b/packages/concerto-core/types/lib/introspect/relationshipdeclaration.d.ts
new file mode 100644
index 0000000000..1d53f00f79
--- /dev/null
+++ b/packages/concerto-core/types/lib/introspect/relationshipdeclaration.d.ts
@@ -0,0 +1,18 @@
+export = RelationshipDeclaration;
+/**
+ * Class representing a relationship between model elements
+ * @extends Property
+ * @see See {@link Property}
+ *
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class RelationshipDeclaration extends Property {
+ /**
+ * Returns true if this class is the definition of a relationship.
+ *
+ * @return {boolean} true if the class is a relationship
+ */
+ isRelationship(): boolean;
+}
+import Property = require("./property");
diff --git a/packages/concerto-core/types/lib/introspect/stringvalidator.d.ts b/packages/concerto-core/types/lib/introspect/stringvalidator.d.ts
new file mode 100644
index 0000000000..b4fc0d3aba
--- /dev/null
+++ b/packages/concerto-core/types/lib/introspect/stringvalidator.d.ts
@@ -0,0 +1,16 @@
+export = StringValidator;
+/**
+ * A Validator to enforce that a string matches a regex
+ * @private
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class StringValidator extends Validator {
+ regex: RegExp;
+ /**
+ * Returns the RegExp object associated with the string validator
+ * @returns {RegExp} the RegExp object
+ */
+ getRegex(): RegExp;
+}
+import Validator = require("./validator");
diff --git a/packages/concerto-core/types/lib/introspect/transactiondeclaration.d.ts b/packages/concerto-core/types/lib/introspect/transactiondeclaration.d.ts
new file mode 100644
index 0000000000..f9b3860b52
--- /dev/null
+++ b/packages/concerto-core/types/lib/introspect/transactiondeclaration.d.ts
@@ -0,0 +1,17 @@
+export = TransactionDeclaration;
+/** Class representing the definition of an Transaction.
+ * @extends ClassDeclaration
+ * @see See {@link ClassDeclaration}
+ *
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class TransactionDeclaration {
+ /**
+ * Create an TransactionDeclaration.
+ * @param {ModelFile} modelFile the ModelFile for this class
+ * @param {Object} ast - The AST created by the parser
+ * @throws {IllegalModelException}
+ */
+ constructor(modelFile: ModelFile, ast: any);
+}
diff --git a/packages/concerto-core/types/lib/introspect/validator.d.ts b/packages/concerto-core/types/lib/introspect/validator.d.ts
new file mode 100644
index 0000000000..313e90fca3
--- /dev/null
+++ b/packages/concerto-core/types/lib/introspect/validator.d.ts
@@ -0,0 +1,47 @@
+export = Validator;
+/**
+ * An Abstract field validator. Extend this class and override the
+ * validate method.
+ * @private
+ * @class
+ * @abstract
+ * @memberof module:concerto-core
+ */
+declare class Validator {
+ /**
+ * Create a Property.
+ * @param {Field} field - the field this validator is attached to
+ * @param {Object} validator - The validation string
+ * @throws {IllegalModelException}
+ */
+ constructor(field: Field, validator: any);
+ validator: any;
+ field: Field;
+ /**
+ * @param {string} id the identifier of the instance
+ * @param {string} msg the exception message
+ * @throws {Error} throws an error to report the message
+ */
+ reportError(id: string, msg: string): void;
+ /**
+ * Visitor design pattern
+ * @param {Object} visitor - the visitor
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private accept;
+ /**
+ * Returns the field that this validator applies to
+ * @return {Field} the field
+ */
+ getField(): Field;
+ /**
+ * Validate the property against a value
+ * @param {string} identifier the identifier of the instance being validated
+ * @param {Object} value the value to validate
+ * @throws {IllegalModelException}
+ * @private
+ */
+ private validate;
+}
diff --git a/packages/concerto-core/types/lib/logger.d.ts b/packages/concerto-core/types/lib/logger.d.ts
new file mode 100644
index 0000000000..632653c74f
--- /dev/null
+++ b/packages/concerto-core/types/lib/logger.d.ts
@@ -0,0 +1,106 @@
+export = Logger;
+/**
+ * A utility class with static function that print to the console
+ * @private
+ */
+declare class Logger {
+ /**
+ * A reusable function for logging at multiple levels
+ * @param {string} level - the required log level. e.g. error, warn, info, debug, etc.
+ * @param {any} obj - the input obj to prettify
+ * @returns {void} -
+ * @private
+ */
+ private static dispatch;
+ /**
+ * Add a custom transport for logging
+ * @param {Object} transport - The transport object should have function for the usual logging operations e.g. error, warn, info, debug, etc.
+ * @returns {void} -
+ * @private
+ */
+ private static add;
+ /**
+ * Write an error statement to the console.
+ *
+ * Prints to `stderr` with newline.
+ * @param {any|object} data - if this is an object with properties `level` and `message` it will be flattened first
+ * @param {any} args -
+ * @returns {void} -
+ * @private
+ */
+ private static error;
+ /**
+ * Write a warning statement to the console.
+ *
+ * Prints to `stderr` with newline.
+ * @param {any|object} data - if this is an object with properties `level` and `message` it will be flattened first
+ * @param {any} args -
+ * @returns {void} -
+ * @private
+ */
+ private static warn;
+ /**
+ * Write an info statement to the console.
+ *
+ * Prints to `stdout` with newline.
+ * @param {any|object} data - if this is an object with properties `level` and `message` it will be flattened first
+ * @param {any} args -
+ * @returns {void} -
+ * @private
+ */
+ private static info;
+ /**
+ * Write an info statement to the console. Alias for `logger.log`
+ *
+ * Prints to `stdout` with newline.
+ * @param {any|object} data - if this is an object with properties `level` and `message` it will be flattened first
+ * @param {any} args -
+ * @returns {void} -
+ * @private
+ */
+ private static log;
+ /**
+ * Write an http statement to the console.
+ *
+ * Prints to `stdout` with newline.
+ * @param {any|object} data - if this is an object with properties `level` and `message` it will be flattened first
+ * @param {any} args -
+ * @returns {void} -
+ * @private
+ */
+ private static http;
+ /**
+ * Write a verbose log statement to the console.
+ *
+ * Prints to `stdout` with newline.
+ * @param {any|object} data - if this is an object with properties `level` and `message` it will be flattened first
+ * @param {any} args -
+ * @returns {void} -
+ * @private
+ */
+ private static verbose;
+ /**
+ * Write a debug statement to the console.
+ *
+ * Prints to `stdout` with newline.
+ * @param {any|object} data - if this is an object with properties `level` and `message` it will be flattened first
+ * @param {any} args -
+ * @returns {void} -
+ * @private
+ */
+ private static debug;
+ /**
+ * Write a silly level statement to the console.
+ *
+ * Prints to `stdout` with newline.
+ * @param {any|object} data - if this is an object with properties `level` and `message` it will be flattened first
+ * @param {any} args -
+ * @returns {void} -
+ * @private
+ */
+ private static silly;
+}
+declare namespace Logger {
+ const level: string;
+ const transports: {}[];
+}
diff --git a/packages/concerto-core/types/lib/model/identifiable.d.ts b/packages/concerto-core/types/lib/model/identifiable.d.ts
new file mode 100644
index 0000000000..fb728c5a36
--- /dev/null
+++ b/packages/concerto-core/types/lib/model/identifiable.d.ts
@@ -0,0 +1,69 @@
+export = Identifiable;
+/**
+ * Identifiable is an entity with a namespace, type and an identifier.
+ * Applications should retrieve instances from {@link Factory}
+ * This class is abstract.
+ * @extends Typed
+ * @abstract
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class Identifiable extends Typed {
+ /**
+ * Create an instance.
+ *
+ * Note: Only to be called by framework code. Applications should
+ * retrieve instances from {@link Factory}
+ *
+ *
+ * @param {ModelManager} modelManager - The ModelManager for this instance
+ * @param {ClassDeclaration} classDeclaration - The class declaration for this instance.
+ * @param {string} ns - The namespace this instance.
+ * @param {string} type - The type this instance.
+ * @param {string} id - The identifier of this instance.
+ * @param {string} timestamp - The timestamp of this instance
+ * @private
+ */
+ private constructor();
+ $identifier: string;
+ $timestamp: string;
+ /**
+ * Get the timestamp of this instance
+ * @return {string} The timestamp for this object
+ */
+ getTimestamp(): string;
+ /**
+ * Get the identifier of this instance
+ * @return {string} The identifier for this object
+ */
+ getIdentifier(): string;
+ /**
+ * Set the identifier of this instance
+ * @param {string} id - the new identifier for this object
+ */
+ setIdentifier(id: string): void;
+ /**
+ * Get the fully qualified identifier of this instance.
+ * (namespace '.' type '#' identifier).
+ * @return {string} the fully qualified identifier of this instance
+ */
+ getFullyQualifiedIdentifier(): string;
+ /**
+ * Determine if this identifiable is a relationship.
+ * @return {boolean} True if this identifiable is a relationship,
+ * false if not.
+ */
+ isRelationship(): boolean;
+ /**
+ * Determine if this identifiable is a resource.
+ * @return {boolean} True if this identifiable is a resource,
+ * false if not.
+ */
+ isResource(): boolean;
+ /**
+ * Returns a URI representation of a reference to this identifiable
+ * @return {String} the URI for the identifiable
+ */
+ toURI(): string;
+}
+import Typed = require("./typed");
diff --git a/packages/concerto-core/types/lib/model/relationship.d.ts b/packages/concerto-core/types/lib/model/relationship.d.ts
new file mode 100644
index 0000000000..b216a5b227
--- /dev/null
+++ b/packages/concerto-core/types/lib/model/relationship.d.ts
@@ -0,0 +1,27 @@
+export = Relationship;
+/**
+ * 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.
+ *
+ * Applications should retrieve instances from {@link Factory}
+ *
+ * @extends Identifiable
+ * @see See {@link Identifiable}
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class Relationship extends Identifiable {
+ /**
+ * Contructs a Relationship instance from a URI representation (created using toURI).
+ * @param {ModelManager} modelManager - the model manager to bind the relationship to
+ * @param {String} uriAsString - the URI as a string, generated using Identifiable.toURI()
+ * @param {String} [defaultNamespace] - default namespace to use for backwards compatability
+ * @param {String} [defaultType] - default type to use for backwards compatability
+ * @return {Relationship} the relationship
+ */
+ static fromURI(modelManager: ModelManager, uriAsString: string, defaultNamespace?: string, defaultType?: string): Relationship;
+ $class: string;
+}
+import Identifiable = require("./identifiable");
diff --git a/packages/concerto-core/types/lib/model/resource.d.ts b/packages/concerto-core/types/lib/model/resource.d.ts
new file mode 100644
index 0000000000..1f5791fb06
--- /dev/null
+++ b/packages/concerto-core/types/lib/model/resource.d.ts
@@ -0,0 +1,35 @@
+export = Resource;
+/**
+ *
+ * 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.
+ *
+ * @extends Identifiable
+ * @see See {@link Resource}
+ * @class
+ * @memberof module:concerto-core
+ * @public
+ */
+declare class Resource extends Identifiable {
+ /**
+ * Determine if this identifiable is a concept.
+ * @return {boolean} True if this identifiable is a concept,
+ * false if not.
+ */
+ isConcept(): boolean;
+ /**
+ * Determine if this object is identifiable.
+ * @return {boolean} True if this object has an identifiying field
+ * false if not.
+ */
+ isIdentifiable(): boolean;
+}
+import Identifiable = require("./identifiable");
diff --git a/packages/concerto-core/types/lib/model/resourceid.d.ts b/packages/concerto-core/types/lib/model/resourceid.d.ts
new file mode 100644
index 0000000000..6e8d26f1b6
--- /dev/null
+++ b/packages/concerto-core/types/lib/model/resourceid.d.ts
@@ -0,0 +1,44 @@
+export = ResourceId;
+/**
+ * All the identifying properties of a resource.
+ * @private
+ * @class
+ * @memberof module:concerto-core
+ * @property {String} namespace
+ * @property {String} type
+ * @property {String} id
+ */
+declare class ResourceId {
+ /**
+ * Parse a URI into an identifier.
+ *
+ * Three formats are allowable:
+ *
+ * - Valid resource URI argument: resource:qualifiedTypeName#ID
+ * - Valid resource URI argument with missing URI scheme: qualifiedTypeName#ID
+ * - URI argument containing only an ID, with legacy namespace and type arguments supplied.
+ *
+ * @param {String} uri - Resource URI.
+ * @param {String} [legacyNamespace] - Namespace to use for legacy resource identifiers.
+ * @param {String} [legacyType] - Type to use for legacy resource identifiers.
+ * @return {Identifier} - An identifier.
+ * @throws {Error} - On an invalid resource URI.
+ */
+ static fromURI(uri: string, legacyNamespace?: string, legacyType?: string): Identifier;
+ /**
+ * Note: only for use by internal framework code.
+ * @param {String} namespace - Namespace containing the type.
+ * @param {String} type - Short type name.
+ * @param {String} id - Instance identifier.
+ * @private
+ */
+ private constructor();
+ namespace: string;
+ type: string;
+ id: string;
+ /**
+ * URI representation of this identifier.
+ * @return {String} A URI.
+ */
+ toURI(): string;
+}
diff --git a/packages/concerto-core/types/lib/model/typed.d.ts b/packages/concerto-core/types/lib/model/typed.d.ts
new file mode 100644
index 0000000000..7e42236776
--- /dev/null
+++ b/packages/concerto-core/types/lib/model/typed.d.ts
@@ -0,0 +1,96 @@
+export = Typed;
+/**
+ * Object is an instance with a namespace and a type.
+ *
+ * This class is abstract.
+ * @abstract
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class Typed {
+ /**
+ * Create an instance.
+ *
+ * Note: Only to be called by framework code. Applications should
+ * retrieve instances from {@link Factory}
+ *
+ *
+ * @param {ModelManager} modelManager - The ModelManager for this instance
+ * @param {ClassDeclaration} classDeclaration - The class declaration for this instance.
+ * @param {string} ns - The namespace this instance.
+ * @param {string} type - The type this instance.
+ * @private
+ */
+ private constructor();
+ $modelManager: ModelManager;
+ $classDeclaration: ClassDeclaration;
+ $namespace: string;
+ $type: string;
+ /**
+ * Visitor design pattern
+ * @param {Object} visitor - the visitor
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private accept;
+ /**
+ * Get the ModelManager for this instance
+ * @return {ModelManager} The ModelManager for this object
+ * @private
+ */
+ private getModelManager;
+ /**
+ * Get the type of the instance (a short name, not including namespace).
+ * @return {string} The type of this object
+ */
+ getType(): string;
+ /**
+ * Get the fully-qualified type name of the instance (including namespace).
+ * @return {string} The fully-qualified type name of this object
+ */
+ getFullyQualifiedType(): string;
+ /**
+ * Get the namespace of the instance.
+ * @return {string} The namespace of this object
+ */
+ getNamespace(): string;
+ /**
+ * Returns the class declaration for this instance object.
+ *
+ * @return {ClassDeclaration} - the class declaration for this instance
+ * @private
+ */
+ private getClassDeclaration;
+ /**
+ * Sets a property on this Resource
+ * @param {string} propName - the name of the field
+ * @param {string} value - the value of the property
+ */
+ setPropertyValue(propName: string, value: string): void;
+ /**
+ * Adds a value to an array property on this Resource
+ * @param {string} propName - the name of the field
+ * @param {string} value - the value of the property
+ */
+ addArrayValue(propName: string, value: string): void;
+ /**
+ * Sets the fields to their default values, based on the model
+ * @private
+ */
+ private assignFieldDefaults;
+ /**
+ * Check to see if this instance is an instance of the specified fully qualified
+ * type name.
+ * @param {String} fqt The fully qualified type name.
+ * @returns {boolean} True if this instance is an instance of the specified fully
+ * qualified type name, false otherwise.
+ */
+ instanceOf(fqt: string): boolean;
+ /**
+ * Overriden to prevent people accidentally converting a resource to JSON
+ * without using the Serializer.
+ * @private
+ */
+ private toJSON;
+}
diff --git a/packages/concerto-core/types/lib/model/validatedresource.d.ts b/packages/concerto-core/types/lib/model/validatedresource.d.ts
new file mode 100644
index 0000000000..300b458de8
--- /dev/null
+++ b/packages/concerto-core/types/lib/model/validatedresource.d.ts
@@ -0,0 +1,38 @@
+export = ValidatedResource;
+/**
+ * ValidatedResource is a Resource that can validate that property
+ * changes (or the whole instance) do not violate the structure of
+ * the type information associated with the instance.
+ * @extends Resource
+ * @see See {@link Resource}
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class ValidatedResource extends Resource {
+ /**
+ * This constructor should not be called directly.
+ * Use the Factory class to create instances.
+ *
+ *
+ * Note: Only to be called by framework code. Applications should
+ * retrieve instances from {@link Factory}
+ *
+ * @param {ModelManager} modelManager - The ModelManager for this instance
+ * @param {ClassDeclaration} classDeclaration - The class declaration for this instance.
+ * @param {string} ns - The namespace this instance.
+ * @param {string} type - The type this instance.
+ * @param {string} id - The identifier of this instance.
+ * @param {string} timestamp - The timestamp of this instance
+ * @param {ResourceValidator} resourceValidator - The validator to use for this instance
+ * @private
+ */
+ private constructor();
+ $validator: ResourceValidator;
+ /**
+ * Validates the instance against its model.
+ *
+ * @throws {Error} - if the instance if invalid with respect to the model
+ */
+ validate(): void;
+}
+import Resource = require("./resource");
diff --git a/packages/concerto-core/types/lib/modelloader.d.ts b/packages/concerto-core/types/lib/modelloader.d.ts
new file mode 100644
index 0000000000..c8f7d3a6de
--- /dev/null
+++ b/packages/concerto-core/types/lib/modelloader.d.ts
@@ -0,0 +1,48 @@
+export = 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.
+ *
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class ModelLoader {
+ /**
+ * Add model file
+ *
+ * @param {object} modelFileLoader - the model loader
+ * @param {object} modelManager - the model manager
+ * @param {string} ctoFile - the model file
+ * @return {object} the model manager
+ * @private
+ */
+ private static addModel;
+ /**
+ * Load models in a new model manager
+ *
+ * @param {string[]} ctoFiles - the CTO files (can be local file paths or URLs)
+ * @param {object} options - optional parameters
+ * @param {boolean} [options.offline] - do not resolve external models
+ * @param {number} [options.utcOffset] - UTC Offset for this execution
+ * @return {object} the model manager
+ */
+ static loadModelManager(ctoFiles: string[], options?: {
+ offline?: boolean;
+ utcOffset?: number;
+ }): object;
+ /**
+ * Load system and models in a new model manager from model files objects
+ *
+ * @param {object[]} modelFiles - An array of Concerto files as strings or ModelFile objects.
+ * @param {string[]} [fileNames] - An optional array of file names to associate with the model files
+ * @param {object} options - optional parameters
+ * @param {boolean} [options.offline] - do not resolve external models
+ * @param {number} [options.utcOffset] - UTC Offset for this execution
+ * @return {object} the model manager
+ */
+ static loadModelManagerFromModelFiles(modelFiles: object[], fileNames?: string[], options?: {
+ offline?: boolean;
+ utcOffset?: number;
+ }): object;
+}
diff --git a/packages/concerto-core/types/lib/modelmanager.d.ts b/packages/concerto-core/types/lib/modelmanager.d.ts
new file mode 100644
index 0000000000..6274db619a
--- /dev/null
+++ b/packages/concerto-core/types/lib/modelmanager.d.ts
@@ -0,0 +1,252 @@
+export = ModelManager;
+/**
+ * Manages the Concerto model files.
+ *
+ * The structure of {@link Resource}s (Assets, Transactions, Participants) is modelled
+ * in a set of Concerto files. The contents of these files are managed
+ * by the {@link 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 {@link ModelManager#addModelFile addModelFile}
+ * method to register the Concerto file(s) with the ModelManager.
+ *
+ * Use the {@link Concerto} class to validate instances.
+ *
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class ModelManager {
+ /**
+ * Create the ModelManager.
+ * @param {object} [options] - Serializer options
+ */
+ constructor(options?: object);
+ modelFiles: {};
+ factory: Factory;
+ serializer: Serializer;
+ decoratorFactories: any[];
+ /**
+ * Returns true
+ * @returns {boolean} true
+ */
+ isModelManager(): boolean;
+ /**
+ * Adds root types
+ * @private
+ */
+ private addRootModel;
+ /**
+ * Visitor design pattern
+ * @param {Object} visitor - the visitor
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ */
+ accept(visitor: any, parameters: any): any;
+ /**
+ * 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.
+ * @param {string} modelFile - The Concerto file as a string
+ * @param {string} [fileName] - a file name to associate with the model file
+ * @throws {IllegalModelException}
+ */
+ validateModelFile(modelFile: string, fileName?: string): void;
+ /**
+ * Throws an error with details about the existing namespace.
+ * @param {ModelFile} modelFile The model file that is trying to declare an existing namespace
+ * @private
+ */
+ private _throwAlreadyExists;
+ /**
+ * 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.
+ * @param {string|ModelFile} modelFile - Model as a string or object
+ * @param {string} fileName - an optional file name to associate with the model file
+ * @param {boolean} [disableValidation] - If true then the model files are not validated
+ * @throws {IllegalModelException}
+ * @return {Object} The newly added model file (internal).
+ */
+ addModelFile(modelFile: string | ModelFile, fileName: string, disableValidation?: boolean): any;
+ /**
+ * 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.
+ * @param {string|ModelFile} modelFile - Model as a string or object
+ * @param {string} [fileName] - a file name to associate with the model file
+ * @param {boolean} [disableValidation] - If true then the model files are not validated
+ * @throws {IllegalModelException}
+ * @returns {Object} The newly added model file (internal).
+ */
+ updateModelFile(modelFile: string | ModelFile, fileName?: string, disableValidation?: boolean): any;
+ /**
+ * Remove the Concerto file for a given namespace
+ * @param {string} namespace - The namespace of the model file to delete.
+ */
+ deleteModelFile(namespace: string): void;
+ /**
+ * Add a set of Concerto files to the model manager.
+ * @param {string[]|ModelFile[]} modelFiles - An array of models as strings or ModelFile objects.
+ * @param {string[]} [fileNames] - A array of file names to associate with the model files
+ * @param {boolean} [disableValidation] - If true then the model files are not validated
+ * @returns {Object[]} The newly added model files (internal).
+ */
+ addModelFiles(modelFiles: string[] | ModelFile[], fileNames?: string[], disableValidation?: boolean): any[];
+ /**
+ * Validates all models files in this model manager
+ */
+ validateModelFiles(): void;
+ /**
+ * Downloads all ModelFiles that are external dependencies and adds or
+ * updates them in this ModelManager.
+ * @param {Object} [options] - Options object passed to ModelFileLoaders
+ * @param {ModelFileDownloader} [modelFileDownloader] - an optional ModelFileDownloader
+ * @throws {IllegalModelException} if the models fail validation
+ * @return {Promise} a promise when the download and update operation is completed.
+ */
+ updateExternalModels(options?: any, modelFileDownloader?: ModelFileDownloader): Promise;
+ /**
+ * Write all models in this model manager to the specified path in the file system
+ *
+ * @param {string} path to a local directory
+ * @param {Object} [options] - Options object
+ * @param {boolean} options.includeExternalModels -
+ * If true, external models are written to the file system. Defaults to true
+ */
+ writeModelsToFileSystem(path: string, options?: {
+ includeExternalModels: boolean;
+ }): void;
+ /**
+ * Get the array of model file instances
+ * @param {Boolean} [includeConcertoNamespace] - whether to include the concerto namespace
+ * (default to false)
+ * @return {ModelFile[]} The ModelFiles registered
+ * @private
+ */
+ private getModelFiles;
+ /**
+ * Gets all the Concerto models
+ * @param {Object} [options] - Options object
+ * @param {boolean} options.includeExternalModels -
+ * If true, external models are written to the file system. Defaults to true
+ * @return {Array<{name:string, content:string}>} the name and content of each CTO file
+ */
+ getModels(options?: {
+ includeExternalModels: boolean;
+ }): Array<{
+ name: string;
+ content: string;
+ }>;
+ /**
+ * Check that the type is valid and returns the FQN of the type.
+ * @param {string} context - error reporting context
+ * @param {string} type - fully qualified type name
+ * @return {string} - the resolved type name (fully qualified)
+ * @throws {IllegalModelException} - if the type is not defined
+ * @private
+ */
+ private resolveType;
+ /**
+ * Remove all registered Concerto files
+ */
+ clearModelFiles(): void;
+ /**
+ * Get the ModelFile associated with a namespace
+ *
+ * @param {string} namespace - the namespace containing the ModelFile
+ * @return {ModelFile} registered ModelFile for the namespace or null
+ */
+ getModelFile(namespace: string): ModelFile;
+ /**
+ * Get the ModelFile associated with a file name
+ *
+ * @param {string} fileName - the fileName associated with the ModelFile
+ * @return {ModelFile} registered ModelFile for the namespace or null
+ * @private
+ */
+ private getModelFileByFileName;
+ /**
+ * Get the namespaces registered with the ModelManager.
+ * @return {string[]} namespaces - the namespaces that have been registered.
+ */
+ getNamespaces(): string[];
+ /**
+ * Look up a type in all registered namespaces.
+ *
+ * @param {string} qualifiedName - fully qualified type name.
+ * @return {ClassDeclaration} - the class declaration for the specified type.
+ * @throws {TypeNotFoundException} - if the type cannot be found or is a primitive type.
+ * @private
+ */
+ private getType;
+ /**
+ * Get the AssetDeclarations defined in this model manager
+ * @return {AssetDeclaration[]} the AssetDeclarations defined in the model manager
+ */
+ getAssetDeclarations(): AssetDeclaration[];
+ /**
+ * Get the TransactionDeclarations defined in this model manager
+ * @return {TransactionDeclaration[]} the TransactionDeclarations defined in the model manager
+ */
+ getTransactionDeclarations(): TransactionDeclaration[];
+ /**
+ * Get the EventDeclarations defined in this model manager
+ * @return {EventDeclaration[]} the EventDeclaration defined in the model manager
+ */
+ getEventDeclarations(): EventDeclaration[];
+ /**
+ * Get the ParticipantDeclarations defined in this model manager
+ * @return {ParticipantDeclaration[]} the ParticipantDeclaration defined in the model manager
+ */
+ getParticipantDeclarations(): ParticipantDeclaration[];
+ /**
+ * Get the EnumDeclarations defined in this model manager
+ * @return {EnumDeclaration[]} the EnumDeclaration defined in the model manager
+ */
+ getEnumDeclarations(): EnumDeclaration[];
+ /**
+ * Get the Concepts defined in this model manager
+ * @return {ConceptDeclaration[]} the ConceptDeclaration defined in the model manager
+ */
+ getConceptDeclarations(): ConceptDeclaration[];
+ /**
+ * Get a factory for creating new instances of types defined in this model manager.
+ * @return {Factory} A factory for creating new instances of types defined in this model manager.
+ */
+ getFactory(): Factory;
+ /**
+ * Get a serializer for serializing instances of types defined in this model manager.
+ * @return {Serializer} A serializer for serializing instances of types defined in this model manager.
+ */
+ getSerializer(): Serializer;
+ /**
+ * Get the decorator factories for this model manager.
+ * @return {DecoratorFactory[]} The decorator factories for this model manager.
+ */
+ getDecoratorFactories(): DecoratorFactory[];
+ /**
+ * Add a decorator factory to this model manager.
+ * @param {DecoratorFactory} factory The decorator factory to add to this model manager.
+ */
+ addDecoratorFactory(factory: DecoratorFactory): void;
+ /**
+ * Checks if this fully qualified type name is derived from another.
+ * @param {string} fqt1 The fully qualified type name to check.
+ * @param {string} fqt2 The fully qualified type name it is may be derived from.
+ * @returns {boolean} True if this instance is an instance of the specified fully
+ * qualified type name, false otherwise.
+ */
+ derivesFrom(fqt1: string, fqt2: string): boolean;
+}
+import Factory = require("./factory");
+import Serializer = require("./serializer");
+import ModelFile = require("./introspect/modelfile");
+import ModelFileDownloader = require("./introspect/loaders/modelfiledownloader");
diff --git a/packages/concerto-core/types/lib/modelutil.d.ts b/packages/concerto-core/types/lib/modelutil.d.ts
new file mode 100644
index 0000000000..eef9f02145
--- /dev/null
+++ b/packages/concerto-core/types/lib/modelutil.d.ts
@@ -0,0 +1,87 @@
+export = ModelUtil;
+/**
+ * Internal Model Utility Class
+ * 
+ * @private
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class ModelUtil {
+ /**
+ * Returns everything after the last dot, if present, of the source string
+ * @param {string} fqn - the source string
+ * @return {string} - the string after the last dot
+ * @private
+ */
+ private static getShortName;
+ /**
+ * Returns true if the specified name is a wildcard
+ * @param {string} fqn - the source string
+ * @return {boolean} true if the specified name is a wildcard
+ * @private
+ */
+ private static isWildcardName;
+ /**
+ * Returns true if the specified name is a recusive wildcard
+ * @param {string} fqn - the source string
+ * @return {boolean} true if the specified name is a recusive wildcard
+ * @private
+ */
+ private static isRecursiveWildcardName;
+ /**
+ * Returns true if a type matches the required fully qualified name. The required
+ * name may be a wildcard or recursive wildcard
+ * @param {Typed} type - the type to test
+ * @param {string} fqn - required fully qualified name
+ * @return {boolean} true if the specified type and namespace match
+ * @private
+ */
+ private static isMatchingType;
+ /**
+ * Returns the namespace for a the fully qualified name of a type
+ * @param {string} fqn - the fully qualified identifier of a type
+ * @return {string} - namespace of the type (everything before the last dot)
+ * or the empty string if there is no dot
+ * @private
+ */
+ private static getNamespace;
+ /**
+ * Returns true if the type is a primitive type
+ * @param {string} typeName - the name of the type
+ * @return {boolean} - true if the type is a primitive
+ * @private
+ */
+ private static isPrimitiveType;
+ /**
+ * Returns true if the type is assignable to the propertyType.
+ *
+ * @param {ModelFile} modelFile - the ModelFile that owns the Property
+ * @param {string} typeName - the FQN of the type we are trying to assign
+ * @param {Property} property - the property that we'd like to store the
+ * type in.
+ * @return {boolean} - true if the type can be assigned to the property
+ * @private
+ */
+ private static isAssignableTo;
+ /**
+ * Returns the passed string with the first character capitalized
+ * @param {string} string - the string
+ * @return {string} the string with the first letter capitalized
+ * @private
+ */
+ private static capitalizeFirstLetter;
+ /**
+ * Returns the true if the given field is an enumerated type
+ * @param {Field} field - the string
+ * @return {boolean} true if the field is declared as an enumeration
+ * @private
+ */
+ private static isEnum;
+ /**
+ * Get the fully qualified name of a type.
+ * @param {string} namespace - namespace of the type.
+ * @param {string} type - short name of the type.
+ * @returns {string} the fully qualified type name.
+ */
+ static getFullyQualifiedName(namespace: string, type: string): string;
+}
diff --git a/packages/concerto-core/types/lib/securityexception.d.ts b/packages/concerto-core/types/lib/securityexception.d.ts
new file mode 100644
index 0000000000..fa05632374
--- /dev/null
+++ b/packages/concerto-core/types/lib/securityexception.d.ts
@@ -0,0 +1,16 @@
+export = SecurityException;
+/**
+* Class representing a security exception
+* @extends BaseException
+* @see See {@link BaseException}
+* @class
+* @memberof module:concerto-core
+*/
+declare class SecurityException extends BaseException {
+ /**
+ * Create the SecurityException.
+ * @param {string} message - The exception message.
+ */
+ constructor(message: string);
+}
+import BaseException = require("./baseexception");
diff --git a/packages/concerto-core/types/lib/serializer.d.ts b/packages/concerto-core/types/lib/serializer.d.ts
new file mode 100644
index 0000000000..e2758a8445
--- /dev/null
+++ b/packages/concerto-core/types/lib/serializer.d.ts
@@ -0,0 +1,77 @@
+export = Serializer;
+/**
+ * Serialize Resources instances to/from various formats for long-term storage
+ * (e.g. on the blockchain).
+ *
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class Serializer {
+ /**
+ * Create a Serializer.
+ * @param {Factory} factory - The Factory to use to create instances
+ * @param {ModelManager} modelManager - The ModelManager to use for validation etc.
+ * @param {object} [options] - Serializer options
+ */
+ constructor(factory: Factory, modelManager: ModelManager, options?: object);
+ factory: Factory;
+ modelManager: ModelManager;
+ defaultOptions: any;
+ /**
+ * Set the default options for the serializer.
+ * @param {Object} newDefaultOptions The new default options for the serializer.
+ */
+ setDefaultOptions(newDefaultOptions: any): void;
+ /**
+ *
+ * Convert a {@link Resource} to a JavaScript object suitable for long-term
+ * peristent storage.
+ *
+ * @param {Resource} resource - The instance to convert to JSON
+ * @param {Object} [options] - the optional serialization options.
+ * @param {boolean} [options.validate] - validate the structure of the Resource
+ * with its model prior to serialization (default to true)
+ * @param {boolean} [options.convertResourcesToRelationships] - Convert resources that
+ * are specified for relationship fields into relationships, false by default.
+ * @param {boolean} [options.permitResourcesForRelationships] - Permit resources in the
+ * place of relationships (serializing them as resources), false by default.
+ * @param {boolean} [options.deduplicateResources] - 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
+ * @param {boolean} [options.convertResourcesToId] - Convert resources that
+ * are specified for relationship fields into their id, false by default.
+ * @param {number} [options.utcOffset] - UTC Offset for DateTime values.
+ * @return {Object} - The Javascript Object that represents the resource
+ * @throws {Error} - throws an exception if resource is not an instance of
+ * Resource or fails validation.
+ */
+ toJSON(resource: Resource, options?: {
+ validate?: boolean;
+ convertResourcesToRelationships?: boolean;
+ permitResourcesForRelationships?: boolean;
+ deduplicateResources?: boolean;
+ convertResourcesToId?: boolean;
+ utcOffset?: number;
+ }): any;
+ /**
+ * Create a {@link Resource} from a JavaScript Object representation.
+ * The JavaScript Object should have been created by calling the
+ * {@link Serializer#toJSON toJSON} API.
+ *
+ * The Resource is populated based on the JavaScript object.
+ *
+ * @param {Object} jsonObject The JavaScript Object for a Resource
+ * @param {Object} options - the optional serialization options
+ * @param {boolean} options.acceptResourcesForRelationships - handle JSON objects
+ * in the place of strings for relationships, defaults to false.
+ * @param {boolean} options.validate - validate the structure of the Resource
+ * with its model prior to serialization (default to true)
+ * @param {number} [options.utcOffset] - UTC Offset for DateTime values.
+ * @return {Resource} The new populated resource
+ */
+ fromJSON(jsonObject: any, options: {
+ acceptResourcesForRelationships: boolean;
+ validate: boolean;
+ utcOffset?: number;
+ }): Resource;
+}
diff --git a/packages/concerto-core/types/lib/serializer/instancegenerator.d.ts b/packages/concerto-core/types/lib/serializer/instancegenerator.d.ts
new file mode 100644
index 0000000000..f612270761
--- /dev/null
+++ b/packages/concerto-core/types/lib/serializer/instancegenerator.d.ts
@@ -0,0 +1,68 @@
+export = InstanceGenerator;
+/**
+ * Generate sample instance data for the specified class declaration
+ * and resource instance. The specified resource instance will be
+ * updated with either default values or generated sample data.
+ * @private
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class InstanceGenerator {
+ /**
+ * Visitor design pattern
+ * @param {Object} thing - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visit;
+ /**
+ * Visitor design pattern
+ * @param {ClassDeclaration} classDeclaration - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visitClassDeclaration;
+ /**
+ * Visitor design pattern
+ * @param {Field} field - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visitField;
+ /**
+ * Get a value for the specified field.
+ * @param {Field} field - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {*} A value for the specified field.
+ */
+ getFieldValue(field: Field, parameters: any): any;
+ /**
+ * Find a concrete type that extends the provided type. If the supplied type argument is
+ * not abstract then it will be returned.
+ * TODO: work out whether this has to be a leaf node or whether the closest type can be used
+ * It depends really since the closest type will satisfy the model but whether it satisfies
+ * any transaction code which attempts to use the generated resource is another matter.
+ * @param {ClassDeclaration} declaration the class declaration.
+ * @return {ClassDeclaration} the closest extending concrete class definition.
+ * @throws {Error} if no concrete subclasses exist.
+ */
+ findConcreteSubclass(declaration: ClassDeclaration): ClassDeclaration;
+ /**
+ * Visitor design pattern
+ * @param {RelationshipDeclaration} relationshipDeclaration - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Relationship} the result of visiting
+ * @private
+ */
+ private visitRelationshipDeclaration;
+ /**
+ * Generate a random ID for a given type.
+ * @private
+ * @param {ClassDeclaration} classDeclaration - class declaration for a type.
+ * @return {String} an ID.
+ */
+ private generateRandomId;
+}
diff --git a/packages/concerto-core/types/lib/serializer/jsongenerator.d.ts b/packages/concerto-core/types/lib/serializer/jsongenerator.d.ts
new file mode 100644
index 0000000000..c3aff1dca7
--- /dev/null
+++ b/packages/concerto-core/types/lib/serializer/jsongenerator.d.ts
@@ -0,0 +1,81 @@
+export = JSONGenerator;
+/**
+ * Converts the contents of a Resource to JSON. The parameters
+ * object should contain the keys
+ * 'stack' - the TypedStack of objects being processed. It should
+ * start with a Resource.
+ * 'modelManager' - the ModelManager to use.
+ * @private
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class JSONGenerator {
+ /**
+ * Constructor.
+ * @param {boolean} [convertResourcesToRelationships] Convert resources that
+ * are specified for relationship fields into relationships, false by default.
+ * @param {boolean} [permitResourcesForRelationships] Permit resources in the
+ * place of relationships (serializing them as resources), false by default.
+ * @param {boolean} [deduplicateResources] If resources appear several times
+ * in the object graph only the first instance is serialized, with only the $id
+ * written for subsequent instances, false by default.
+ * @param {boolean} [convertResourcesToId] Convert resources that
+ * are specified for relationship fields into their id, false by default.
+ * @param {boolean} [ergo] target ergo.
+ * @param {number} [utcOffset] UTC Offset for DateTime values.
+ */
+ constructor(convertResourcesToRelationships?: boolean, permitResourcesForRelationships?: boolean, deduplicateResources?: boolean, convertResourcesToId?: boolean, ergo?: boolean, utcOffset?: number);
+ convertResourcesToRelationships: boolean;
+ permitResourcesForRelationships: boolean;
+ deduplicateResources: boolean;
+ convertResourcesToId: boolean;
+ ergo: boolean;
+ utcOffset: number;
+ /**
+ * Visitor design pattern
+ * @param {Object} thing - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visit;
+ /**
+ * Visitor design pattern
+ * @param {ClassDeclaration} classDeclaration - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visitClassDeclaration;
+ /**
+ * Visitor design pattern
+ * @param {Field} field - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visitField;
+ /**
+ * Converts to JSON safe format.
+ *
+ * @param {Field} field - the field declaration of the object
+ * @param {Object} obj - the object to convert to text
+ * @return {Object} the text JSON safe representation
+ */
+ convertToJSON(field: Field, obj: any): any;
+ /**
+ * Visitor design pattern
+ * @param {RelationshipDeclaration} relationshipDeclaration - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visitRelationshipDeclaration;
+ /**
+ * Returns the persistent format for a relationship.
+ * @param {RelationshipDeclaration} relationshipDeclaration - the relationship being persisted
+ * @param {Identifiable} relationshipOrResource - the relationship or the resource
+ * @returns {string} the text to use to persist the relationship
+ */
+ getRelationshipText(relationshipDeclaration: RelationshipDeclaration, relationshipOrResource: Identifiable): string;
+}
diff --git a/packages/concerto-core/types/lib/serializer/jsonpopulator.d.ts b/packages/concerto-core/types/lib/serializer/jsonpopulator.d.ts
new file mode 100644
index 0000000000..980a01d7bb
--- /dev/null
+++ b/packages/concerto-core/types/lib/serializer/jsonpopulator.d.ts
@@ -0,0 +1,74 @@
+export = JSONPopulator;
+/**
+ * Populates a Resource with data from a JSON object graph. The JSON objects
+ * should be the result of calling Serializer.toJSON and then JSON.parse.
+ * The parameters object should contain the keys
+ * 'stack' - the TypedStack of objects being processed. It should
+ * start with the root object from JSON.parse.
+ * 'factory' - the Factory instance to use for creating objects.
+ * 'modelManager' - the ModelManager instance to use to resolve classes
+ * @private
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class JSONPopulator {
+ /**
+ * Constructor.
+ * @param {boolean} [acceptResourcesForRelationships] Permit resources in the
+ * place of relationships, false by default.
+ * @param {boolean} [ergo] target ergo.
+ * @param {number} [utcOffset] - UTC Offset for DateTime values.
+ */
+ constructor(acceptResourcesForRelationships?: boolean, ergo?: boolean, utcOffset?: number);
+ acceptResourcesForRelationships: boolean;
+ ergo: boolean;
+ utcOffset: number;
+ /**
+ * Visitor design pattern
+ * @param {Object} thing - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visit;
+ /**
+ * Visitor design pattern
+ * @param {ClassDeclaration} classDeclaration - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visitClassDeclaration;
+ /**
+ * Visitor design pattern
+ * @param {Field} field - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visitField;
+ /**
+ *
+ * @param {Field} field - the field of the item being converted
+ * @param {Object} jsonItem - the JSON object of the item being converted
+ * @param {Object} parameters - the parameters
+ * @return {Object} - the populated object.
+ */
+ convertItem(field: Field, jsonItem: any, parameters: any): any;
+ /**
+ * Converts a primtive object to JSON text.
+ *
+ * @param {Field} field - the field declaration of the object
+ * @param {Object} json - the JSON object to convert to a Concerto Object
+ * @return {string} the text representation
+ */
+ convertToObject(field: Field, json: any): string;
+ /**
+ * Visitor design pattern
+ * @param {RelationshipDeclaration} relationshipDeclaration - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visitRelationshipDeclaration;
+}
diff --git a/packages/concerto-core/types/lib/serializer/objectvalidator.d.ts b/packages/concerto-core/types/lib/serializer/objectvalidator.d.ts
new file mode 100644
index 0000000000..65cfd1377a
--- /dev/null
+++ b/packages/concerto-core/types/lib/serializer/objectvalidator.d.ts
@@ -0,0 +1,191 @@
+export = ObjectValidator;
+/**
+ *
+ * Validates a Resource or Field against the models defined in the ModelManager.
+ * This class is used with the Visitor pattern and visits the class declarations
+ * (etc) for the model, checking that the data in a Resource / Field is consistent
+ * with the model.
+ *
+ * The parameters for the visit method must contain the following properties:
+ *
+ * - 'stack' - the TypedStack of objects being processed. It should
+ * start as [Resource] or [Field]
+ * - 'rootResourceIdentifier' - the identifier of the resource being validated
+ * - 'modelManager' - the ModelManager instance to use for type checking
+ *
+ * @private
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class ObjectValidator {
+ /**
+ * Throw a new error for a model violation.
+ * @param {string} id - the identifier of this instance.
+ * @param {string} propName - the name of the field.
+ * @param {*} value - the value of the field.
+ * @param {Field} field - the field
+ * @param {*} concerto - the concerto instance
+ * @throws {ValidationException} the exception
+ * @private
+ */
+ private static reportFieldTypeViolation;
+ /**
+ * Throw a new error for a model violation.
+ * @param {string} id - the identifier of this instance.
+ * @param {RelationshipDeclaration} relationshipDeclaration - the declaration of the classs
+ * @param {Object} value - the value of the field.
+ * @private
+ */
+ private static reportNotRelationshipViolation;
+ /**
+ * Throw a new error for a missing, but required field.
+ * @param {string} id - the identifier of this instance.
+ * @param {Field} field - the field/
+ * @private
+ */
+ private static reportMissingRequiredProperty;
+ /**
+ * Throw a new error for a missing, but required field.
+ * @param {string} id - the identifier of this instance.
+ * @param {Field} field - the field/
+ * @private
+ */
+ private static reportEmptyIdentifier;
+ /**
+ * Throw a new error for a missing, but required field.
+ * @param {string} id - the identifier of this instance.
+ * @param {Field} field - the field
+ * @param {string} obj - the object value
+ * @private
+ */
+ private static reportInvalidEnumValue;
+ /**
+ * Throw a validation exception for an abstract class
+ * @param {ClassDeclaration} classDeclaration - the class declaration
+ * @throws {ValidationException} the validation exception
+ * @private
+ */
+ private static reportAbstractClass;
+ /**
+ * Throw a validation exception for an abstract class
+ * @param {string} resourceId - the id of the resouce being validated
+ * @param {string} propertyName - the name of the property that is not declared
+ * @param {string} fullyQualifiedTypeName - the fully qualified type being validated
+ * @throws {ValidationException} the validation exception
+ * @private
+ */
+ private static reportUndeclaredField;
+ /**
+ * Throw a validation exception for an invalid field assignment
+ * @param {string} resourceId - the id of the resouce being validated
+ * @param {string} propName - the name of the property that is being assigned
+ * @param {*} obj - the Field
+ * @param {Field} field - the Field
+ * @throws {ValidationException} the validation exception
+ * @private
+ */
+ private static reportInvalidFieldAssignment;
+ /**
+ * ResourceValidator constructor
+ * @param {*} concerto - the Concerto instance used for validation
+ * @param {Object} [options] - the optional validation options.
+ * @param {boolean} [options.validate] - validate the structure of the Resource
+ * with its model prior to serialization (default to true)
+ * @param {boolean} [options.convertResourcesToRelationships] - Convert resources that
+ * are specified for relationship fields into relationships, false by default.
+ * @param {boolean} [options.permitResourcesForRelationships] - Permit resources in the
+ */
+ constructor(concerto: any, options?: {
+ validate?: boolean;
+ convertResourcesToRelationships?: boolean;
+ permitResourcesForRelationships?: boolean;
+ });
+ options: {
+ validate?: boolean;
+ convertResourcesToRelationships?: boolean;
+ permitResourcesForRelationships?: boolean;
+ };
+ concerto: any;
+ /**
+ * Visitor design pattern.
+ *
+ * @param {Object} thing - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visit;
+ /**
+ * Visitor design pattern
+ *
+ * @param {EnumDeclaration} enumDeclaration - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visitEnumDeclaration;
+ /**
+ * Visitor design pattern
+ * @param {ClassDeclaration} classDeclaration - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visitClassDeclaration;
+ /**
+ * Returns true if the property is a system property.
+ * System properties are not declared in the model.
+ * @param {String} propertyName - the name of the property
+ * @return {Boolean} true if the property is a system property
+ * @private
+ */
+ private isSystemProperty;
+ /**
+ * Visitor design pattern
+ * @param {Field} field - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visitField;
+ /**
+ * Check a Field that is declared as an Array.
+ * @param {Object} obj - the object being validated
+ * @param {Field} field - the object being visited
+ * @param {Object} parameters - the parameter
+ * @private
+ */
+ private checkEnum;
+ /**
+ * Check a Field that is declared as an Array.
+ * @param {Object} obj - the object being validated
+ * @param {Field} field - the object being visited
+ * @param {Object} parameters - the parameter
+ * @private
+ */
+ private checkArray;
+ /**
+ * Check a single (non-array) field.
+ * @param {Object} obj - the object being validated
+ * @param {Field} field - the object being visited
+ * @param {Object} parameters - the parameter
+ * @private
+ */
+ private checkItem;
+ /**
+ * Visitor design pattern
+ * @param {RelationshipDeclaration} relationshipDeclaration - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visitRelationshipDeclaration;
+ /**
+ * Check a single relationship
+ * @param {Object} parameters - the parameter
+ * @param {*} relationshipDeclaration - the object being visited
+ * @param {Object} obj - the object being validated
+ * @private
+ */
+ private checkRelationship;
+}
diff --git a/packages/concerto-core/types/lib/serializer/resourcevalidator.d.ts b/packages/concerto-core/types/lib/serializer/resourcevalidator.d.ts
new file mode 100644
index 0000000000..001ccf58c1
--- /dev/null
+++ b/packages/concerto-core/types/lib/serializer/resourcevalidator.d.ts
@@ -0,0 +1,192 @@
+export = ResourceValidator;
+/**
+ *
+ * Validates a Resource or Field against the models defined in the ModelManager.
+ * This class is used with the Visitor pattern and visits the class declarations
+ * (etc) for the model, checking that the data in a Resource / Field is consistent
+ * with the model.
+ *
+ * The parameters for the visit method must contain the following properties:
+ *
+ * - 'stack' - the TypedStack of objects being processed. It should
+ * start as [Resource] or [Field]
+ * - 'rootResourceIdentifier' - the identifier of the resource being validated
+ * - 'modelManager' - the ModelManager instance to use for type checking
+ *
+ * @private
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class ResourceValidator {
+ /**
+ * Throw a new error for a model violation.
+ * @param {string} id - the identifier of this instance.
+ * @param {string} propName - the name of the field.
+ * @param {*} value - the value of the field.
+ * @param {Field} field - the field
+ * @throws {ValidationException} the exception
+ * @private
+ */
+ private static reportFieldTypeViolation;
+ /**
+ * Throw a new error for a model violation.
+ * @param {string} id - the identifier of this instance.
+ * @param {classDeclaration} classDeclaration - the declaration of the classs
+ * @param {Object} value - the value of the field.
+ * @private
+ */
+ private static reportNotResouceViolation;
+ /**
+ * Throw a new error for a model violation.
+ * @param {string} id - the identifier of this instance.
+ * @param {RelationshipDeclaration} relationshipDeclaration - the declaration of the classs
+ * @param {Object} value - the value of the field.
+ * @private
+ */
+ private static reportNotRelationshipViolation;
+ /**
+ * Throw a new error for a missing, but required field.
+ * @param {string} id - the identifier of this instance.
+ * @param {Field} field - the field/
+ * @private
+ */
+ private static reportMissingRequiredProperty;
+ /**
+ * Throw a new error for a missing, but required field.
+ * @param {string} id - the identifier of this instance.
+ * @param {Field} field - the field/
+ * @private
+ */
+ private static reportEmptyIdentifier;
+ /**
+ * Throw a new error for a missing, but required field.
+ * @param {string} id - the identifier of this instance.
+ * @param {Field} field - the field
+ * @param {string} obj - the object value
+ * @private
+ */
+ private static reportInvalidEnumValue;
+ /**
+ * Throw a validation exception for an abstract class
+ * @param {ClassDeclaration} classDeclaration - the class declaration
+ * @throws {ValidationException} the validation exception
+ * @private
+ */
+ private static reportAbstractClass;
+ /**
+ * Throw a validation exception for an abstract class
+ * @param {string} resourceId - the id of the resouce being validated
+ * @param {string} propertyName - the name of the property that is not declared
+ * @param {string} fullyQualifiedTypeName - the fully qualified type being validated
+ * @throws {ValidationException} the validation exception
+ * @private
+ */
+ private static reportUndeclaredField;
+ /**
+ * Throw a validation exception for an invalid field assignment
+ * @param {string} resourceId - the id of the resouce being validated
+ * @param {string} propName - the name of the property that is being assigned
+ * @param {*} obj - the Field
+ * @param {Field} field - the Field
+ * @throws {ValidationException} the validation exception
+ * @private
+ */
+ private static reportInvalidFieldAssignment;
+ /**
+ * ResourceValidator constructor
+ * @param {Object} options - the optional serialization options.
+ * @param {boolean} options.validate - validate the structure of the Resource
+ * with its model prior to serialization (default to true)
+ * @param {boolean} options.convertResourcesToRelationships - Convert resources that
+ * are specified for relationship fields into relationships, false by default.
+ * @param {boolean} options.permitResourcesForRelationships - Permit resources in the
+ */
+ constructor(options: {
+ validate: boolean;
+ convertResourcesToRelationships: boolean;
+ permitResourcesForRelationships: boolean;
+ });
+ options: {};
+ /**
+ * Visitor design pattern.
+ *
+ * @param {Object} thing - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visit;
+ /**
+ * Visitor design pattern
+ *
+ * @param {EnumDeclaration} enumDeclaration - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visitEnumDeclaration;
+ /**
+ * Visitor design pattern
+ * @param {ClassDeclaration} classDeclaration - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visitClassDeclaration;
+ /**
+ * Returns true if the property is a system property.
+ * System properties are not declared in the model.
+ * @param {String} propertyName - the name of the property
+ * @return {Boolean} true if the property is a system property
+ * @private
+ */
+ private isSystemProperty;
+ /**
+ * Visitor design pattern
+ * @param {Field} field - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visitField;
+ /**
+ * Check a Field that is declared as an Array.
+ * @param {Object} obj - the object being validated
+ * @param {Field} field - the object being visited
+ * @param {Object} parameters - the parameter
+ * @private
+ */
+ private checkEnum;
+ /**
+ * Check a Field that is declared as an Array.
+ * @param {Object} obj - the object being validated
+ * @param {Field} field - the object being visited
+ * @param {Object} parameters - the parameter
+ * @private
+ */
+ private checkArray;
+ /**
+ * Check a single (non-array) field.
+ * @param {Object} obj - the object being validated
+ * @param {Field} field - the object being visited
+ * @param {Object} parameters - the parameter
+ * @private
+ */
+ private checkItem;
+ /**
+ * Visitor design pattern
+ * @param {RelationshipDeclaration} relationshipDeclaration - the object being visited
+ * @param {Object} parameters - the parameter
+ * @return {Object} the result of visiting or null
+ * @private
+ */
+ private visitRelationshipDeclaration;
+ /**
+ * Check a single relationship
+ * @param {Object} parameters - the parameter
+ * @param {relationshipDeclaration} relationshipDeclaration - the object being visited
+ * @param {Object} obj - the object being validated
+ * @private
+ */
+ private checkRelationship;
+}
diff --git a/packages/concerto-core/types/lib/serializer/typedstack.d.ts b/packages/concerto-core/types/lib/serializer/typedstack.d.ts
new file mode 100644
index 0000000000..226bcfcfe4
--- /dev/null
+++ b/packages/concerto-core/types/lib/serializer/typedstack.d.ts
@@ -0,0 +1,38 @@
+export = 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.
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class TypedStack {
+ /**
+ * Create the Stack with the resource at the head.
+ * @param {Object} resource - the resource to be put at the head of the stack
+ */
+ constructor(resource: any);
+ stack: any[];
+ /**
+ * Push a new object.
+ * @param {Object} obj - the object being visited
+ * @param {Object} expectedType - the expected type of the object being pushed
+ */
+ push(obj: any, expectedType: any): void;
+ /**
+ * Push a new object.
+ * @param {Object} expectedType - the type that should be the result of pop
+ * @return {Object} the result of pop
+ */
+ pop(expectedType: any): any;
+ /**
+ * Peek the top of the stack
+ * @param {Object} expectedType - the type that should be the result of pop
+ * @return {Object} the result of peek
+ */
+ peek(expectedType: any): any;
+ /**
+ * Clears the stack
+ */
+ clear(): void;
+}
diff --git a/packages/concerto-core/types/lib/serializer/validationexception.d.ts b/packages/concerto-core/types/lib/serializer/validationexception.d.ts
new file mode 100644
index 0000000000..53ee2ba92b
--- /dev/null
+++ b/packages/concerto-core/types/lib/serializer/validationexception.d.ts
@@ -0,0 +1,12 @@
+export = ValidationException;
+/**
+ * Exception thrown when a resource fails to model against the model
+ * @extends BaseException
+ * @see See {@link BaseException}
+ * @class
+ * @memberof module:concerto-core
+ * @private
+ */
+declare class ValidationException extends BaseException {
+}
+import BaseException = require("../baseexception");
diff --git a/packages/concerto-core/types/lib/serializer/valuegenerator.d.ts b/packages/concerto-core/types/lib/serializer/valuegenerator.d.ts
new file mode 100644
index 0000000000..0a54ea7540
--- /dev/null
+++ b/packages/concerto-core/types/lib/serializer/valuegenerator.d.ts
@@ -0,0 +1,17 @@
+export = ValueGeneratorFactory;
+/**
+ * Factory providing static methods to create ValueGenerator instances.
+ * @private
+ */
+declare class ValueGeneratorFactory {
+ /**
+ * Create a value generator that supplies empty values.
+ * @return {ValueGenerator} a value generator.
+ */
+ static empty(): ValueGenerator;
+ /**
+ * Create a value generator that supplies randomly generated sample values.
+ * @return {ValueGenerator} a value generator.
+ */
+ static sample(): ValueGenerator;
+}
diff --git a/packages/concerto-core/types/lib/typenotfoundexception.d.ts b/packages/concerto-core/types/lib/typenotfoundexception.d.ts
new file mode 100644
index 0000000000..04f0974be0
--- /dev/null
+++ b/packages/concerto-core/types/lib/typenotfoundexception.d.ts
@@ -0,0 +1,25 @@
+export = TypeNotFoundException;
+/**
+ * Error thrown when a Concerto type does not exist.
+ * @extends BaseException
+ * @see see {@link BaseException}
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class TypeNotFoundException extends BaseException {
+ /**
+ * Constructor. If the optional 'message' argument is not supplied, it will be set to a default value that
+ * includes the type name.
+ * @param {string} typeName - fully qualified type name.
+ * @param {string} [message] - error message.
+ * @param {string} component - the optional component which throws this error
+ */
+ constructor(typeName: string, message?: string, component: string);
+ typeName: string;
+ /**
+ * Get the name of the type that was not found.
+ * @returns {string} fully qualified type name.
+ */
+ getTypeName(): string;
+}
+import BaseException = require("./baseexception");
diff --git a/packages/concerto-core/types/lib/util.d.ts b/packages/concerto-core/types/lib/util.d.ts
new file mode 100644
index 0000000000..3f1ad2539a
--- /dev/null
+++ b/packages/concerto-core/types/lib/util.d.ts
@@ -0,0 +1,17 @@
+export = Util;
+/**
+ * Internal Utility Class
+ * 
+ * @private
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class Util {
+ /**
+ * Returns true if the typeof the object === 'undefined' or
+ * the object === null.
+ * @param {Object} obj - the object to be tested
+ * @returns {boolean} true if the object is null or undefined
+ */
+ static isNull(obj: any): boolean;
+}
diff --git a/packages/concerto-core/types/lib/writer.d.ts b/packages/concerto-core/types/lib/writer.d.ts
new file mode 100644
index 0000000000..db71a332bb
--- /dev/null
+++ b/packages/concerto-core/types/lib/writer.d.ts
@@ -0,0 +1,52 @@
+export = Writer;
+/**
+ * Writer buffers text to be written in memory. It handles simple
+ * indentation and tracks the number of lines written.
+ * @private
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class Writer {
+ beforeBuffer: string;
+ buffer: string;
+ linesWritten: number;
+ /**
+ * Writes text to the start of the buffer
+ * @param {int} tabs - the number of tabs to use
+ * @param {string} text - the text to write
+ */
+ writeBeforeLine(tabs: int, text: string): void;
+ /**
+ * Append text to the buffer
+ * @param {int} tabs - the number of tabs to use
+ * @param {string} text - the text to write
+ */
+ writeLine(tabs: int, text: string): void;
+ /**
+ * Returns the number of lines that have been written to the buffer.
+ * @return {int} the number of lines written to the buffer.
+ */
+ getLineCount(): int;
+ /**
+ * Append text to the buffer, prepending tabs
+ * @param {int} tabs - the number of tabs to use
+ * @param {string} text - the text to write
+ */
+ writeIndented(tabs: int, text: string): void;
+ /**
+ * Append text to the buffer (no automatic newline). The
+ * text may contain newline, and these will increment the linesWritten
+ * counter.
+ * @param {string} msg - the text to write
+ */
+ write(msg: string): void;
+ /**
+ * Returns the text that has been buffered in this Writer.
+ * @return {string} the buffered text.
+ */
+ getBuffer(): string;
+ /**
+ * Empties the underyling buffer and resets the line count.
+ */
+ clearBuffer(): void;
+}