chore(build) Recreate TypeScript interfaces for the new packages

Signed-off-by: jeromesimeon <[email protected]>

packages/concerto-core/api.txt

@@ -103,7 +103,7 @@ class MetaModel {
    + object modelManagerFromMetaModel(object,boolean?) 
 }
 class ModelFile {
-   + void constructor(ModelManager,object,string,string?) throws IllegalModelException
+   + void constructor(ModelManager,object,string?,string?) throws IllegalModelException
    + boolean isModelFile() 
    + Boolean isSystemModelFile() 
    + boolean isExternal() 

packages/concerto-core/changelog.txt

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

packages/concerto-core/lib/introspect/modelfile.js

@@ -40,7 +40,7 @@ class ModelFile {
      * @param {ModelManager} modelManager - the ModelManager that manages this
      * ModelFile
      * @param {object} ast - The DSL model as a string.
-     * @param {string} definitions - The DSL model as a string.
+     * @param {string} [definitions] - The (optional) CTO model as a string.
      * @param {string} [fileName] - The optional filename for this modelfile
      * @throws {IllegalModelException}
      */

packages/concerto-core/package.json

@@ -60,8 +60,6 @@
   "dependencies": {
     "@accordproject/concerto-util": "1.2.1",
     "@accordproject/concerto-cto": "1.2.1",
-    "@supercharge/promise-pool": "1.7.0",
-    "axios": "0.23.0",
     "dayjs": "1.10.4",
     "debug": "4.3.1",
     "lorem-ipsum": "2.0.3",

packages/concerto-cto/lib/parserMain.js

@@ -19,9 +19,9 @@ const ParseException = require('./parseexception');
 
 /**
  * Create decorator argument string from a metamodel
- * @param {object} cto - the Concerto string
+ * @param {string} cto - the Concerto string
  * @param {string} [fileName] - an optional file name
- * @return {string} the string for the decorator argument
+ * @return {object} the string for the decorator argument
  */
 function parse(cto, fileName) {
     try {

packages/concerto-cto/package.json

@@ -8,6 +8,7 @@
     "npm": ">=6"
   },
   "main": "index.js",
+  "typings": "types/index.d.ts",
   "scripts": {
     "pretest": "npm run lint",
     "lint": "eslint .",
@@ -18,7 +19,8 @@
     "test": "nyc mocha --recursive -t 10000",
     "test:watch": "nyc mocha --watch --recursive -t 10000",
     "mocha": "mocha --recursive -t 10000",
-    "nyc": "nyc mocha --recursive -t 10000"
+    "nyc": "nyc mocha --recursive -t 10000",
+    "build:types" : "npx -p typescript tsc ./lib/*.js index.js --declaration --allowJs --emitDeclarationOnly --outDir types"
   },
   "repository": {
     "type": "git",

packages/concerto-cto/types/index.d.ts

@@ -0,0 +1,5 @@
+export var BaseException: typeof import("./lib/baseexception");
+export var BaseFileException: typeof import("./lib/basefileexception");
+export var ParseException: typeof import("./lib/parseexception");
+export var Parser: typeof import("./lib/parserMain");
+export var Printer: typeof import("./lib/printer");

packages/concerto-cto/types/lib/baseexception.d.ts

@@ -0,0 +1,16 @@
+export = BaseException;
+/**
+* A base class for all Concerto exceptions
+* @extends Error
+* @class
+* @memberof module:concerto-core
+*/
+declare class BaseException extends Error {
+    /**
+     * Create the BaseException.
+     * @param {string} message - The exception message.
+     * @param {string} component - The optional component which throws this error.
+     */
+    constructor(message: string, component: string);
+    component: any;
+}

packages/concerto-cto/types/lib/basefileexception.d.ts

@@ -0,0 +1,38 @@
+export = BaseFileException;
+/**
+ * Exception throws when a Concerto file is semantically invalid
+ * @extends BaseException
+ * @see {@link BaseException}
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class BaseFileException extends BaseException {
+    /**
+     * Create an BaseFileException
+     * @param {string} message - the message for the exception
+     * @param {string} fileLocation - the optional file location associated with the exception
+     * @param {string} fullMessage - the optional full message text
+     * @param {string} [fileName] - the file name
+     * @param {string} [component] - the component which throws this error
+     */
+    constructor(message: string, fileLocation: string, fullMessage: string, fileName?: string, component?: string);
+    fileLocation: string;
+    shortMessage: string;
+    fileName: string;
+    /**
+     * Returns the file location associated with the exception or null
+     * @return {string} the optional location associated with the exception
+     */
+    getFileLocation(): string;
+    /**
+     * Returns the error message without the location of the error
+     * @returns {string} the error message
+     */
+    getShortMessage(): string;
+    /**
+     * Returns the fileName for the error
+     * @returns {string} the file name or null
+     */
+    getFileName(): string;
+}
+import BaseException = require("./baseexception");

packages/concerto-cto/types/lib/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");

packages/concerto-cto/types/lib/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 };

packages/concerto-cto/types/lib/parserMain.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Create decorator argument string from a metamodel
+ * @param {string} cto - the Concerto string
+ * @param {string} [fileName] - an optional file name
+ * @return {object} the string for the decorator argument
+ */
+export function parse(cto: string, fileName?: string): object;

packages/concerto-cto/types/lib/printer.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Create a model string from a metamodel
+ * @param {object} metaModel - the metamodel
+ * @return {string} the string for that model
+ */
+export function toCTO(metaModel: object): string;

packages/concerto-util/README.md

@@ -1,11 +1,11 @@
-# Concerto Core
+# Concerto Utilities
 
-Main library for Concerto models, model manager, JSON instance validation and serialization.
+Those are various utilities independent of Concerto itself covering things like: logging, external files downloads, stacks etc.
 
 # Installation
 
 ```
-npm install @accordproject/concerto-core --save
+npm install @accordproject/concerto-util --save
 ```
 
 ## License <a name="license"></a>

packages/concerto-util/package.json

@@ -8,6 +8,7 @@
     "npm": ">=6"
   },
   "main": "index.js",
+  "typings": "types/index.d.ts",
   "scripts": {
     "pretest": "npm run lint",
     "lint": "eslint .",
@@ -18,7 +19,8 @@
     "test": "nyc mocha --recursive -t 10000",
     "test:watch": "nyc mocha --watch --recursive -t 10000",
     "mocha": "mocha --recursive -t 10000",
-    "nyc": "nyc mocha --recursive -t 10000"
+    "nyc": "nyc mocha --recursive -t 10000",
+    "build:types" : "npx -p typescript tsc ./lib/**/*.js index.js --declaration --allowJs --emitDeclarationOnly --outDir types"
   },
   "repository": {
     "type": "git",

packages/concerto-util/types/index.d.ts

@@ -0,0 +1,8 @@
+export var FileDownloader: typeof import("./lib/filedownloader");
+export var CompositeFileLoader: typeof import("./lib/loaders/compositefileloader");
+export var DefaultFileLoader: typeof import("./lib/loaders/defaultfileloader");
+export var GitHubFileLoader: typeof import("./lib/loaders/githubfileloader");
+export var HTTPFileLoader: typeof import("./lib/loaders/httpfileloader");
+export var Writer: typeof import("./lib/writer");
+export var Logger: typeof import("./lib/logger");
+export var TypedStack: typeof import("./lib/typedstack");

packages/concerto-util/types/lib/filedownloader.d.ts

@@ -0,0 +1,32 @@
+export = FileDownloader;
+/**
+ * Downloads the transitive closure of a set of model files.
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class FileDownloader {
+    /**
+     * Create a FileDownloader and bind to a FileLoader.
+     * @param {fileLoader} fileLoader - the loader to use to download model files
+     * @param {*} getExternalImports - a function taking a file and returning new files
+     * @param {Number} concurrency - the number of model files to download concurrently
+     */
+    constructor(fileLoader: fileLoader, getExternalImports: any, concurrency?: number);
+    fileLoader: fileLoader;
+    concurrency: number;
+    getExternalImports: any;
+    /**
+     * Download all external dependencies for an array of model files
+     * @param {File[]} files - the model files
+     * @param {Object} [options] - Options object passed to FileLoaders
+     * @return {Promise} a promise that resolves to Files[] for the external model files
+     */
+    downloadExternalDependencies(files: File[], options?: any): Promise<any>;
+    /**
+     * Execute a Job
+     * @param {Object} job - the job to execute
+     * @param {Object} fileLoader - the loader to use to download model files.
+     * @return {Promise} a promise to the job results
+     */
+    runJob(job: any, fileLoader: any): Promise<any>;
+}

packages/concerto-util/types/lib/loaders/compositefileloader.d.ts

@@ -0,0 +1,42 @@
+export = CompositeFileLoader;
+/**
+ * <p>
+ * Manages a set of model file loaders, delegating to the first model file
+ * loader that accepts a URL.
+ * </p>
+ * @private
+ * @class
+ * @memberof module:concerto-util
+ */
+declare class CompositeFileLoader {
+    fileLoaders: any[];
+    /**
+     * Adds a FileLoader implemenetation to the FileLoader
+     * @param {FileLoader} fileLoader - The script to add to the ScriptManager
+     */
+    addFileLoader(fileLoader: FileLoader): void;
+    /**
+     * Get the array of FileLoader instances
+     * @return {FileLoaders[]} The FileLoader registered
+     * @private
+     */
+    private getFileLoaders;
+    /**
+     * Remove all registered FileLoaders
+     */
+    clearFileLoaders(): void;
+    /**
+     * Returns true if this ModelLoader can process the URL
+     * @param {string} url - the URL
+     * @return {boolean} true if this ModelLoader accepts the URL
+     * @abstract
+     */
+    accepts(url: string): boolean;
+    /**
+     * Load a File from a URL and return it
+     * @param {string} url - the url to get
+     * @param {object} options - additional options
+     * @return {Promise} a promise to the File
+     */
+    load(url: string, options: object): Promise<any>;
+}

packages/concerto-util/types/lib/loaders/defaultfileloader.d.ts

@@ -0,0 +1,19 @@
+export = DefaultFileLoader;
+/**
+ * <p>
+ * A default CompositeFileLoader implementation which supports
+ * github://, http:// and https:// URLs.
+ * </p>
+ * @private
+ * @class
+ * @see See {@link CompositeFileLoader}
+ * @memberof module:concerto-util
+ */
+declare class DefaultFileLoader extends CompositeFileLoader {
+    /**
+     * Create the DefaultFileLoader.
+     * @param {*} processFile - a function to apply to the content of the file
+     */
+    constructor(processFile: any);
+}
+import CompositeFileLoader = require("./compositefileloader");

packages/concerto-util/types/lib/loaders/githubfileloader.d.ts

@@ -0,0 +1,11 @@
+export = GitHubFileLoader;
+/**
+ * Loads Files from an external source, such as a URL.
+ *
+ * @class
+ * @private
+ * @memberof module:concerto-util
+ */
+declare class GitHubFileLoader extends HTTPFileLoader {
+}
+import HTTPFileLoader = require("./httpfileloader");

packages/concerto-util/types/lib/loaders/httpfileloader.d.ts

@@ -0,0 +1,29 @@
+export = HTTPFileLoader;
+/**
+ * Loads Files from an HTTP(S) URL using the axios library.
+ * @class
+ * @private
+ * @memberof module:concerto-util
+ */
+declare class HTTPFileLoader {
+    /**
+     * Create the HTTPFileLoader.
+     * @param {*} processFile - a function to apply to the content of the file
+     */
+    constructor(processFile: any);
+    processFile: any;
+    /**
+     * Returns true if this ModelLoader can process the URL
+     * @param {string} url - the URL
+     * @return {boolean} true if this ModelLoader accepts the URL
+     * @abstract
+     */
+    accepts(url: string): boolean;
+    /**
+     * Load a File from a URL and return it
+     * @param {string} requestUrl - the url to get
+     * @param {object} options - additional options
+     * @return {Promise} a promise to the File
+     */
+    load(requestUrl: string, options: object): Promise<any>;
+}