@accordproject/concerto-util 4.0.0-alpha.2 → 4.0.0-beta.1

package/dist/filedownloader.d.ts

@@ -1,31 +1,38 @@
-export = FileDownloader;
+import type { FileLoader } from './loaders/fileloader';
+type ExternalImportMap = Record<string, string>;
+type DownloadJob<TFile> = {
+    downloadedUris: Set<string>;
+    url: string;
+    options: RequestInit;
+};
 /**
  * Downloads the transitive closure of a set of model files.
  * @memberof module:concerto-core
  */
-declare class FileDownloader {
+declare class FileDownloader<TFile = unknown> {
+    fileLoader: FileLoader<TFile>;
+    getExternalImports: (file: TFile) => ExternalImportMap;
+    concurrency: number;
     /**
      * Create a FileDownloader and bind to a FileLoader.
-     * @param {*} 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
+     * @param fileLoader - the loader to use to download model files
+     * @param getExternalImports - a function taking a file and returning new files
+     * @param concurrency - the number of model files to download concurrently
      */
-    constructor(fileLoader: any, getExternalImports: any, concurrency?: number);
-    fileLoader: any;
-    concurrency: number;
-    getExternalImports: any;
+    constructor(fileLoader: FileLoader<TFile>, getExternalImports: (file: TFile) => ExternalImportMap, concurrency?: number);
     /**
      * 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
+     * @param files - the model files
+     * @param options - Options object passed to FileLoaders
+     * @return a promise that resolves to Files[] for the external model files
      */
-    downloadExternalDependencies(files: File[], options?: Object): Promise<any>;
+    downloadExternalDependencies(files: TFile[], options?: RequestInit): Promise<TFile[]>;
     /**
      * 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
+     * @param job - the job to execute
+     * @param fileLoader - the loader to use to download model files.
+     * @return a promise to the job results
      */
-    runJob(job: Object, fileLoader: Object): Promise<any>;
+    runJob(job: DownloadJob<TFile>, fileLoader: FileLoader<TFile>): Promise<TFile[]>;
 }
+export = FileDownloader;

package/dist/filedownloader.js

@@ -12,13 +12,16 @@
  * limitations under the License.
  */
 'use strict';
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 const debug = require('debug')('concerto:FileDownloader');
+// eslint-disable-next-line @typescript-eslint/no-var-requires
 const PromisePool = require('@supercharge/promise-pool');
-const flatten = arr => [].concat(...arr);
-const filterUndefined = arr => arr.filter(Boolean);
+const flatten = (arr) => [].concat(...arr);
+const filterUndefined = (arr) => arr.filter((value) => Boolean(value));
 const handleJobError = async (error, job) => {
-    const badHttpResponse = error.response && error.response.status && error.response.status !== 200;
-    const dnsFailure = error.code && error.code === 'ENOTFOUND';
+    const errLike = error;
+    const badHttpResponse = errLike.response && errLike.response.status && errLike.response.status !== 200;
+    const dnsFailure = errLike.code && errLike.code === 'ENOTFOUND';
     if (badHttpResponse || dnsFailure) {
         const err = new Error(`Unable to download external model dependency '${job.url}'`);
         err.code = 'MISSING_DEPENDENCY';
@@ -33,9 +36,9 @@ const handleJobError = async (error, job) => {
 class FileDownloader {
     /**
      * Create a FileDownloader and bind to a FileLoader.
-     * @param {*} 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
+     * @param fileLoader - the loader to use to download model files
+     * @param getExternalImports - a function taking a file and returning new files
+     * @param concurrency - the number of model files to download concurrently
      */
     constructor(fileLoader, getExternalImports, concurrency = 10) {
         this.fileLoader = fileLoader;
@@ -44,17 +47,14 @@ class FileDownloader {
     }
     /**
      * 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
+     * @param files - the model files
+     * @param options - Options object passed to FileLoaders
+     * @return a promise that resolves to Files[] for the external model files
      */
-    downloadExternalDependencies(files, options) {
+    downloadExternalDependencies(files, options = {}) {
         const method = 'downloadExternalDependencies';
         debug(method);
         const downloadedUris = new Set();
-        if (!options) {
-            options = {};
-        }
         const jobs = flatten(files.map(file => {
             const externalImports = this.getExternalImports(file);
             return Object.keys(externalImports).map(importDeclaration => ({
@@ -67,14 +67,14 @@ class FileDownloader {
             .withConcurrency(this.concurrency)
             .for(jobs)
             .handleError(handleJobError)
-            .process(x => this.runJob(x, this.fileLoader))
+            .process((x) => this.runJob(x, this.fileLoader))
             .then(({ results }) => filterUndefined(flatten(results)));
     }
     /**
      * 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
+     * @param job - the job to execute
+     * @param fileLoader - the loader to use to download model files.
+     * @return a promise to the job results
      */
     runJob(job, fileLoader) {
         const downloadedUris = job.downloadedUris;
@@ -95,7 +95,7 @@ class FileDownloader {
                 .withConcurrency(this.concurrency)
                 .for(importedUris)
                 .handleError(handleJobError)
-                .process(uri => {
+                .process((uri) => {
                 if (!downloadedUris.has(uri)) {
                     // recurse and add a new job for the referenced URI
                     return this.runJob({
@@ -111,4 +111,3 @@ class FileDownloader {
     }
 }
 module.exports = FileDownloader;
-//# sourceMappingURL=filedownloader.js.map

package/dist/filewriter.d.ts

@@ -1,44 +1,47 @@
-export = FileWriter;
+import Writer = require('./writer');
 /**
- * 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().
- *
+ * FileWriter buffers text to be written to a file.
  * @private
- * @extends Writer
- * @see See {@link Writer}
  * @class
- * @memberof module:concerto-core
+ * @memberof module:concerto-util
  */
 declare class FileWriter extends Writer {
+    outputDirectory: string;
+    fileName: string | null;
+    relativeDir: string | null;
     /**
      * Create a FileWriter.
-     *
-     * @param {string} outputDirectory - the path to an output directory
-     * that will be used to store generated files.
+     * @param outputDirectory - the output directory
      */
     constructor(outputDirectory: string);
-    outputDirectory: string;
-    relativeDir: string | null;
-    fileName: string | null;
     /**
-     * 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
+     * Open a file for writing. The file is created in the
+     * output directory.
+     * @param 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
+     * Open a file for writing. The file is created in the
+     * output directory, plus the relative directory path.
+     * @param relativeDir - the relative directory
+     * @param fileName - the name of the file to open
      */
     openRelativeFile(relativeDir: string, fileName: string): void;
     /**
-     * Closes the current open file
+     * Writes text to the current open file
+     * @param tabs - the number of tabs to use
+     * @param text - the text to write
+     */
+    writeLine(tabs: number, text: string): void;
+    /**
+     * Writes text to the start of the current open file
+     * @param tabs - the number of tabs to use
+     * @param text - the text to write
+     */
+    writeBeforeLine(tabs: number, text: string): void;
+    /**
+     * Closes the file, flushing the buffer to disk.
      */
     closeFile(): void;
 }
-import Writer = require("./writer");
+export = FileWriter;

package/dist/filewriter.js

@@ -12,83 +12,110 @@
  * limitations under the License.
  */
 'use strict';
-const fs = require('fs');
-const path = require('path');
-const Writer = require('./writer');
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const Writer = require("./writer");
 /**
- * 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().
- *
+ * FileWriter buffers text to be written to a file.
  * @private
- * @extends Writer
- * @see See {@link Writer}
  * @class
- * @memberof module:concerto-core
+ * @memberof module:concerto-util
  */
 class FileWriter extends Writer {
     /**
      * Create a FileWriter.
-     *
-     * @param {string} outputDirectory - the path to an output directory
-     * that will be used to store generated files.
+     * @param outputDirectory - the output directory
      */
     constructor(outputDirectory) {
         super();
+        this.fileName = null;
+        this.relativeDir = null;
         this.outputDirectory = outputDirectory;
         this.relativeDir = null;
         this.fileName = null;
         fs.mkdirSync(outputDirectory, { recursive: true });
     }
     /**
-     * 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
+     * Open a file for writing. The file is created in the
+     * output directory.
+     * @param fileName - the name of the file to open
      */
     openFile(fileName) {
         this.fileName = fileName;
         this.relativeDir = null;
     }
     /**
-     * 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
+     * Open a file for writing. The file is created in the
+     * output directory, plus the relative directory path.
+     * @param relativeDir - the relative directory
+     * @param fileName - the name of the file to open
      */
     openRelativeFile(relativeDir, fileName) {
-        this.relativeDir = relativeDir;
         this.fileName = fileName;
+        this.relativeDir = relativeDir;
+        this.clearBuffer();
     }
     /**
      * Writes text to the current open file
-     * @param {number} tabs - the number of tabs to use
-     * @param {string} text - the text to write
+     * @param tabs - the number of tabs to use
+     * @param text - the text to write
      */
     writeLine(tabs, text) {
         if (this.fileName) {
             super.writeLine(tabs, text);
         }
         else {
-            throw Error('File has not been opened!');
+            throw new Error('File has not been opened!');
         }
     }
     /**
      * Writes text to the start of the current open file
-     * @param {number} tabs - the number of tabs to use
-     * @param {string} text - the text to write
+     * @param tabs - the number of tabs to use
+     * @param text - the text to write
      */
     writeBeforeLine(tabs, text) {
         if (this.fileName) {
             super.writeBeforeLine(tabs, text);
         }
         else {
-            throw Error('File has not been opened!');
+            throw new Error('File has not been opened!');
         }
     }
     /**
-     * Closes the current open file
+     * Closes the file, flushing the buffer to disk.
      */
     closeFile() {
         if (!this.fileName) {
@@ -108,4 +135,3 @@ class FileWriter extends Writer {
     }
 }
 module.exports = FileWriter;
-//# sourceMappingURL=filewriter.js.map

package/dist/identifiers.d.ts

@@ -1,10 +1,10 @@
+export declare const ID_REGEX: RegExp;
 /**
  * Function that attempts to normalize arbitrary strings
  * into valid Concerto identifiers
  *
- * @param {string} identifier - the input value
- * @param {number} [truncateLength] - Length at which to truncate the identifier
- * @returns {string} - An identifier that meets the Concerto specification
+ * @param identifier - the input value
+ * @param truncateLength - Length at which to truncate the identifier
+ * @returns - An identifier that meets the Concerto specification
  */
-export function normalizeIdentifier(identifier: string, truncateLength?: number): string;
-export const ID_REGEX: RegExp;
+export declare function normalizeIdentifier(identifier: string | null | undefined, truncateLength?: number): string;

package/dist/identifiers.js

@@ -12,27 +12,31 @@
  * limitations under the License.
  */
 'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ID_REGEX = void 0;
+exports.normalizeIdentifier = normalizeIdentifier;
 // Conforms to Concerto Spec for identifiers
-const ID_REGEX = /^(\p{Lu}|\p{Ll}|\p{Lt}|\p{Lm}|\p{Lo}|\p{Nl}|\$|_|\\u[0-9A-Fa-f]{4})(?:\p{Lu}|\p{Ll}|\p{Lt}|\p{Lm}|\p{Lo}|\p{Nl}|\$|_|\\u[0-9A-Fa-f]{4}|\p{Mn}|\p{Mc}|\p{Nd}|\p{Pc}|\u200C|\u200D)*$/u;
+exports.ID_REGEX = /^(\p{Lu}|\p{Ll}|\p{Lt}|\p{Lm}|\p{Lo}|\p{Nl}|\$|_|\\u[0-9A-Fa-f]{4})(?:\p{Lu}|\p{Ll}|\p{Lt}|\p{Lm}|\p{Lo}|\p{Nl}|\$|_|\\u[0-9A-Fa-f]{4}|\p{Mn}|\p{Mc}|\p{Nd}|\p{Pc}|\u200C|\u200D)*$/u;
 /**
  * Function that attempts to normalize arbitrary strings
  * into valid Concerto identifiers
  *
- * @param {string} identifier - the input value
- * @param {number} [truncateLength] - Length at which to truncate the identifier
- * @returns {string} - An identifier that meets the Concerto specification
+ * @param identifier - the input value
+ * @param truncateLength - Length at which to truncate the identifier
+ * @returns - An identifier that meets the Concerto specification
  */
 function normalizeIdentifier(identifier, truncateLength = -1) {
     const replacer = (_match, group1) => {
         let escapedChar = '';
         // Loop through characters with multiple code points
         for (const codePoint of group1) {
+            // @ts-ignore
             escapedChar += `_${codePoint.codePointAt(0).toString(16)}`;
         }
         return escapedChar;
     };
     // Stringify null & undefined values
-    let result = identifier ?? String(identifier);
+    let result = identifier !== null && identifier !== void 0 ? identifier : String(identifier);
     if (typeof result !== 'string') {
         throw new Error(`Unsupported identifier type, '${typeof result}'.`);
     }
@@ -51,13 +55,8 @@ function normalizeIdentifier(identifier, truncateLength = -1) {
         result = result.substring(0, truncateLength);
     }
     // Check validity
-    if (!ID_REGEX.test(result)) {
+    if (!exports.ID_REGEX.test(result)) {
         throw new Error(`Unexpected error. Not able to escape identifier '${result}'.`);
     }
     return result;
 }
-module.exports = {
-    normalizeIdentifier,
-    ID_REGEX
-};
-//# sourceMappingURL=identifiers.js.map

package/dist/index.d.ts

@@ -11,6 +11,7 @@ export declare const CompositeFileLoader: any;
 export declare const DefaultFileLoader: any;
 export declare const GitHubFileLoader: any;
 export declare const HTTPFileLoader: any;
+export type { FileLoader } from './loaders/fileloader';
 export declare const Writer: any;
 export declare const FileWriter: any;
 export declare const ModelWriter: any;

package/dist/index.js

@@ -49,4 +49,3 @@ exports.ErrorCodes = require('./errorcodes');
 exports.NullUtil = require('./null');
 // Warning
 exports.Warning = require('./warning');
-//# sourceMappingURL=index.js.map

package/dist/inmemorywriter.d.ts

@@ -1,4 +1,4 @@
-export = InMemoryWriter;
+import Writer = require('./writer');
 /**
  * InMemoryWriter stores string representation of files in a map structure.
  * The Map key is the filename, and the value are its string contents.
@@ -11,11 +11,16 @@ export = InMemoryWriter;
  */
 declare class InMemoryWriter extends Writer {
     fileName: string;
-    data: Map<any, any>;
+    data: Map<string, string>;
+    /**
+     * Create a FileWriter.
+     *
+     */
+    constructor();
     /**
      * Creates the filename which will be used for association with its string content.
      *
-     * @param {string} fileName - the name of the file.
+     * @param fileName - the name of the file.
      */
     openFile(fileName: string): void;
     /**
@@ -25,8 +30,8 @@ declare class InMemoryWriter extends Writer {
     /**
      * Returns the content of the Map store.
      *
-     * @return {Map} - a Map containing the string representation of files. (k,v) => (filename, file content).
+     * @return - a Map containing the string representation of files. (k,v) => (filename, file content).
      */
-    getFilesInMemory(): Map<any, any>;
+    getFilesInMemory(): Map<string, string>;
 }
-import Writer = require("./writer");
+export = InMemoryWriter;

package/dist/inmemorywriter.js

@@ -12,7 +12,7 @@
  * limitations under the License.
  */
 'use strict';
-const Writer = require('./writer');
+const Writer = require("./writer");
 /**
  * InMemoryWriter stores string representation of files in a map structure.
  * The Map key is the filename, and the value are its string contents.
@@ -36,7 +36,7 @@ class InMemoryWriter extends Writer {
     /**
      * Creates the filename which will be used for association with its string content.
      *
-     * @param {string} fileName - the name of the file.
+     * @param fileName - the name of the file.
      */
     openFile(fileName) {
         this.fileName = fileName;
@@ -51,11 +51,10 @@ class InMemoryWriter extends Writer {
     /**
      * Returns the content of the Map store.
      *
-     * @return {Map} - a Map containing the string representation of files. (k,v) => (filename, file content).
+     * @return - a Map containing the string representation of files. (k,v) => (filename, file content).
      */
     getFilesInMemory() {
         return this.data;
     }
 }
 module.exports = InMemoryWriter;
-//# sourceMappingURL=inmemorywriter.js.map

package/dist/label.d.ts

@@ -1,12 +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
+ * @param labelName - the label text to be transformed
+ * @returns - The label text formatted for rendering
  */
-export function labelToSentence(labelName?: string): string;
+export declare function labelToSentence(labelName?: string): string;
 /**
  * Create a camelCase label from a sentence
- * @param {string} sentence - the sentence
- * @returns {string} - The camelCase label
+ * @param sentence - the sentence
+ * @returns - The camelCase label
  */
-export function sentenceToLabel(sentence?: string): string;
+export declare function sentenceToLabel(sentence?: string): string;

package/dist/label.js

@@ -12,10 +12,13 @@
  * limitations under the License.
  */
 'use strict';
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.labelToSentence = labelToSentence;
+exports.sentenceToLabel = sentenceToLabel;
 /**
  * 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
+ * @param labelName - the label text to be transformed
+ * @returns - The label text formatted for rendering
  */
 function labelToSentence(labelName = '') {
     return labelName
@@ -27,8 +30,8 @@ function labelToSentence(labelName = '') {
 }
 /**
  * Create a camelCase label from a sentence
- * @param {string} sentence - the sentence
- * @returns {string} - The camelCase label
+ * @param sentence - the sentence
+ * @returns - The camelCase label
  */
 function sentenceToLabel(sentence = '') {
     const split = sentence.split(/[^A-Za-z0-9_-]+/);
@@ -38,8 +41,3 @@ function sentenceToLabel(sentence = '') {
     const joined = split.join('');
     return joined.replace(/^./, str => str.toLowerCase());
 }
-module.exports = {
-    labelToSentence,
-    sentenceToLabel,
-};
-//# sourceMappingURL=label.js.map

package/dist/loaders/compositefileloader.d.ts

@@ -1,4 +1,4 @@
-export = CompositeFileLoader;
+import type { FileLoader } from './fileloader';
 /**
  * <p>
  * Manages a set of model file loaders, delegating to the first model file
@@ -8,35 +8,40 @@ export = CompositeFileLoader;
  * @class
  * @memberof module:concerto-util
  */
-declare class CompositeFileLoader {
-    fileLoaders: any[];
+declare class CompositeFileLoader<T = unknown> {
+    fileLoaders: Array<FileLoader<T>>;
+    /**
+     * Create the CompositeFileLoader. Used to delegate to a set of FileLoaders.
+     */
+    constructor();
     /**
      * Adds a FileLoader implemenetation to the FileLoader
-     * @param {*} fileLoader - The script to add to the ScriptManager
+     * @param fileLoader - The script to add to the ScriptManager
      */
-    addFileLoader(fileLoader: any): void;
+    addFileLoader(fileLoader: FileLoader<T>): void;
     /**
      * Get the array of FileLoader instances
-     * @return {*} The FileLoader registered
+     * @return The FileLoader registered
      * @private
      */
-    private getFileLoaders;
+    getFileLoaders(): Array<FileLoader<T>>;
     /**
      * 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
+     * @param url - the URL
+     * @return 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
+     * @param url - the url to get
+     * @param options - additional options
+     * @return a promise to the File
      */
-    load(url: string, options: object): Promise<any>;
+    load(url: string, options?: RequestInit): Promise<T>;
 }
+export = CompositeFileLoader;