@accordproject/concerto-util 2.0.0-alpha.2 → 2.0.0

package/index.js

@@ -22,28 +22,44 @@
  */
 
 // Exceptions
-module.exports.BaseException = require('./lib/baseexception');
-module.exports.BaseFileException = require('./lib/basefileexception');
+const BaseException = require('./lib/baseexception');
+const BaseFileException = require('./lib/basefileexception');
 
 // Transitive closure downloader
-module.exports.FileDownloader = require('./lib/filedownloader');
+const FileDownloader = require('./lib/filedownloader');
 
 // File Loaders
-module.exports.CompositeFileLoader = require('./lib/loaders/compositefileloader');
-module.exports.DefaultFileLoader = require('./lib/loaders/defaultfileloader');
-module.exports.GitHubFileLoader = require('./lib/loaders/githubfileloader');
-module.exports.HTTPFileLoader = require('./lib/loaders/httpfileloader');
+const CompositeFileLoader = require('./lib/loaders/compositefileloader');
+const DefaultFileLoader = require('./lib/loaders/defaultfileloader');
+const GitHubFileLoader = require('./lib/loaders/githubfileloader');
+const HTTPFileLoader = require('./lib/loaders/httpfileloader');
 
 // Writers
-module.exports.Writer = require('./lib/writer');
-module.exports.FileWriter = require('./lib/filewriter');
-module.exports.ModelWriter = require('./lib/modelwriter');
+const Writer = require('./lib/writer');
+const FileWriter = require('./lib/filewriter');
+const ModelWriter = require('./lib/modelwriter');
 
 // Logger
-module.exports.Logger = require('./lib/logger');
+const Logger = require('./lib/logger');
 
 // TypedStack
-module.exports.TypedStack = require('./lib/typedstack');
+const TypedStack = require('./lib/typedstack');
 
 // Label
-module.exports.Label = require('./lib/label');
+const Label = require('./lib/label');
+
+module.exports = {
+    BaseException,
+    BaseFileException,
+    FileDownloader,
+    CompositeFileLoader,
+    DefaultFileLoader,
+    GitHubFileLoader,
+    HTTPFileLoader,
+    Writer,
+    FileWriter,
+    ModelWriter,
+    Logger,
+    TypedStack,
+    Label
+};

package/lib/filewriter.js

@@ -72,7 +72,7 @@ class FileWriter extends Writer {
 
     /**
      * Writes text to the current open file
-     * @param {int} tabs - the number of tabs to use
+     * @param {number} tabs - the number of tabs to use
      * @param {string} text - the text to write
      */
     writeLine(tabs,text) {
@@ -85,7 +85,7 @@ class FileWriter extends Writer {
 
     /**
      * Writes text to the start of the current open file
-     * @param {int} tabs - the number of tabs to use
+     * @param {number} tabs - the number of tabs to use
      * @param {string} text - the text to write
      */
     writeBeforeLine(tabs,text) {

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@accordproject/concerto-util",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0",
   "description": "Utilities for Concerto Modeling Language",
   "homepage": "https://github.com/accordproject/concerto",
   "engines": {
-    "node": ">=12",
+    "node": ">=14",
     "npm": ">=6"
   },
   "main": "index.js",
@@ -16,11 +16,12 @@
     "licchk": "license-check-and-add",
     "postlicchk": "npm run doc",
     "doc": "jsdoc --pedantic --recurse -c jsdoc.json",
+    "postdoc": "npm run build:types",
     "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",
-    "build:types": "npx -p typescript tsc ./lib/**/*.js index.js --declaration --allowJs --emitDeclarationOnly --outDir types"
+    "build:types": "tsc index.js --declaration --allowJs --emitDeclarationOnly --outDir types"
   },
   "repository": {
     "type": "git",
@@ -44,7 +45,8 @@
     "mocha": "8.3.2",
     "moxios": "0.4.0",
     "nyc": "15.1.0",
-    "tmp-promise": "3.0.2"
+    "tmp-promise": "3.0.2",
+    "typescript": "4.6.3"
   },
   "dependencies": {
     "@supercharge/promise-pool": "1.7.0",

package/types/index.d.ts

@@ -1,8 +1,14 @@
-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");
+import BaseException = require("./lib/baseexception");
+import BaseFileException = require("./lib/basefileexception");
+import FileDownloader = require("./lib/filedownloader");
+import CompositeFileLoader = require("./lib/loaders/compositefileloader");
+import DefaultFileLoader = require("./lib/loaders/defaultfileloader");
+import GitHubFileLoader = require("./lib/loaders/githubfileloader");
+import HTTPFileLoader = require("./lib/loaders/httpfileloader");
+import Writer = require("./lib/writer");
+import FileWriter = require("./lib/filewriter");
+import ModelWriter = require("./lib/modelwriter");
+import Logger = require("./lib/logger");
+import TypedStack = require("./lib/typedstack");
+import Label = require("./lib/label");
+export { BaseException, BaseFileException, FileDownloader, CompositeFileLoader, DefaultFileLoader, GitHubFileLoader, HTTPFileLoader, Writer, FileWriter, ModelWriter, Logger, TypedStack, Label };

package/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;
+}

package/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");

package/types/lib/filewriter.d.ts

@@ -0,0 +1,44 @@
+export = FileWriter;
+/**
+ * FileWriter creates text files under a directory tree. It can be used
+ * by code generators to create source files for example.
+ * Basic usage is: openFile(fileName), writeLine(...), closeFile().
+ *
+ * @private
+ * @extends Writer
+ * @see See {@link Writer}
+ * @class
+ * @memberof module:concerto-core
+ */
+declare class FileWriter extends Writer {
+    /**
+     * Create a FileWriter.
+     *
+     * @param {string} outputDirectory - the path to an output directory
+     * that will be used to store generated files.
+     */
+    constructor(outputDirectory: string);
+    outputDirectory: string;
+    relativeDir: string;
+    fileName: string;
+    /**
+     * Opens a file for writing. The file will be created in the
+     * root directory of this FileWriter.
+     *
+     * @param {string} fileName - the name of the file to open
+     */
+    openFile(fileName: string): void;
+    /**
+     * Opens a file for writing, with a location relative to the
+     * root directory of this FileWriter.
+     *
+     * @param {string} relativeDir - the relative directory to use
+     * @param {string} fileName - the name of the file to open
+     */
+    openRelativeFile(relativeDir: string, fileName: string): void;
+    /**
+     * Closes the current open file
+     */
+    closeFile(): void;
+}
+import Writer = require("./writer");

package/types/lib/label.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Inserts correct spacing and capitalization to a camelCase label
+ * @param {string} labelName - the label text to be transformed
+ * @returns {string} - The label text formatted for rendering
+ */
+export function labelToSentence(labelName?: string): string;
+/**
+ * Create a camelCase label from a sentence
+ * @param {string} sentence - the sentence
+ * @returns {string} - The camelCase label
+ */
+export function sentenceToLabel(sentence?: string): string;

package/types/lib/modelwriter.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Writes a set of model files to disk
+ * @param {*} files - the set of files to write, with names and whether they are external
+ * @param {string} path - a path to the directory where to write the files
+ * @param {*} options - a set of options
+ */
+export function writeModelsToFileSystem(files: any, path: string, options?: any): void;