@fontoxml/fontoxml-development-tools 3.11.0 → 3.12.0

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@fontoxml/fontoxml-development-tools",
 	"description": "Development tools for Fonto.",
-	"version": "3.11.0",
+	"version": "3.12.0",
 	"author": "The Fonto Team",
 	"license": "MIT",
 	"keywords": [
@@ -38,7 +38,7 @@
 		"babel-plugin-istanbul": "6.1.1",
 		"body-parser": "1.19.0",
 		"case-sensitive-paths-webpack-plugin": "2.4.0",
-		"chalk": "4.1.0",
+		"chalk": "5.0.1",
 		"cli-table": "0.3.6",
 		"compare-versions": "3.6.0",
 		"compression": "1.7.4",
@@ -51,55 +51,49 @@
 		"fontoxpath": "3.17.2",
 		"fs-extra": "9.1.0",
 		"fswin": "3.21.107",
-		"globby": "11.0.3",
 		"html-webpack-plugin": "5.5.0",
-		"http-auth": "4.1.5",
+		"http-auth": "4.1.9",
 		"http-proxy-middleware": "2.0.1",
 		"inquirer": "8.0.0",
 		"inquirer-checkbox-plus-prompt": "1.0.1",
 		"loader-utils": "3.2.0",
 		"mini-css-extract-plugin": "2.4.5",
-		"multer": "1.4.2",
+		"multer": "1.4.5-lts.1",
+		"node-fetch": "3.2.10",
 		"p-map": "4.0.0",
 		"path-to-regexp": "6.2.0",
 		"pdfkit": "0.12.1",
 		"picomatch": "2.3.1",
 		"prettier": "2.3.2",
-		"prompt-confirm": "2.0.4",
 		"recast": "0.20.4",
-		"request": "2.88.2",
-		"request-promise-native": "1.0.9",
 		"requirejs": "2.3.6",
-		"slimdom-sax-parser": "1.4.0",
+		"slimdom": "4.0.2",
 		"strip-ansi": "6.0.0",
 		"strip-color": "0.1.0",
-		"supports-color": "8.1.1",
-		"terser": "5.10.0",
-		"terser-webpack-plugin": "5.3.0",
+		"terser-webpack-plugin": "5.3.3",
 		"to-utf-8": "1.3.0",
 		"type-is": "1.6.18",
 		"unzipper": "0.10.11",
 		"uuid": "8.3.2",
 		"webpack": "5.65.0",
 		"webpack-dev-middleware": "5.3.0",
-		"wrap-ansi": "7.0.0",
-		"xml2js": "0.4.23"
+		"wrap-ansi": "7.0.0"
 	},
 	"devDependencies": {
 		"@babel/eslint-plugin": "7.14.5",
-		"@fontoxml/eslint-config": "4.0.2",
-		"chai": "4.3.4",
+		"@fontoxml/eslint-config": "4.0.3",
+		"chai": "4.3.6",
 		"cross-env": "7.0.3",
 		"eslint": "7.29.0",
 		"eslint-config-prettier": "8.3.0",
 		"eslint-plugin-import": "2.23.4",
 		"eslint-plugin-prettier": "3.4.0",
 		"eslint-plugin-simple-import-sort": "7.0.0",
-		"mocha": "8.3.2",
-		"mocha-junit-reporter": "2.0.0",
+		"mocha": "10.0.0",
+		"mocha-junit-reporter": "2.0.2",
 		"nyc": "15.1.0",
 		"prettier": "2.3.2",
 		"tmp": "0.2.1",
-		"ws": "7.4.4"
+		"ws": "7.5.8"
 	}
 }

package/src/App.js

@@ -284,7 +284,7 @@ export default class FontoXMLDevelopmentToolsApp {
 	/**
 	 * Returns an object with information that a module could use to reason about which fdt instance it is used for.
 	 *
-	 * @return {{name: *, version: ?string}}
+	 * @return {{name: string, version?: string}}
 	 */
 	getInfo() {
 		return {

package/src/FdtCommand.js

@@ -18,7 +18,7 @@ export default class FdtCommand extends ask.Command {
 	/**
 	 * @constructor
 	 * @param {string} commandName
-	 * @param {function(AskNicelyRequest, FdtResponse)} [controller]
+	 * @param {(request: AskNicelyRequest, response: FdtResponse) => (void | Promise<void>)} [controller]
 	 */
 	constructor(commandName, controller) {
 		super(commandName, controller);
@@ -80,7 +80,7 @@ export default class FdtCommand extends ask.Command {
 	/**
 	 * Set the main controller.
 	 *
-	 * @param {string|function(AskNicelyRequest, FdtResponse)} [controller]
+	 * @param {string|(request: AskNicelyRequest, response: FdtResponse) => (void | Promise<void>)} [controller]
 	 *
 	 * @return {FdtCommand} This command.
 	 */
@@ -114,7 +114,7 @@ export default class FdtCommand extends ask.Command {
 	 * Register a hidden command as a child of this, and register this as parent of the child.
 	 *
 	 * @param {string|Command} commandName The identifying name of this option, unique for its ancestry.
-	 * @param {string|function(AskNicelyRequest, FdtResponse)} [controller]
+	 * @param {string|(request: AskNicelyRequest, response: FdtResponse) => (void | Promise<void>)} [controller]
 	 *
 	 * @return {Command} The child command.
 	 */

package/src/FdtLicense.js

@@ -1,8 +1,8 @@
 import compareVersions from 'compare-versions';
 import fs from 'fs';
+import fetch, { Blob, File, FormData } from 'node-fetch';
 import os from 'os';
 import path from 'path';
-import requestPromise from 'request-promise-native';
 import util from 'util';
 
 import getParentDirectoryContainingFileSync from './getParentDirectoryContainingFileSync.js';
@@ -418,34 +418,27 @@ export default class FdtLicense {
 	validateAndUpdateLicenseFile() {
 		return this.getLicenseFileBuffer()
 			.then((licenseFileBuffer) => {
-				// Remotely validate the license file.
-				return requestPromise.post(
-					`${this._backendBaseUrl}/license/validate`,
-					{
-						formData: {
-							request: {
-								value: JSON.stringify(
-									this._getSystemTelemetryData()
-								),
-								options: {
-									contentType: 'application/json',
-								},
-							},
-							license: {
-								value: licenseFileBuffer,
-								options: {
-									filename: DEFAULT_LICENSE_FILENAME,
-									contentType: 'application/octet-stream',
-								},
-							},
-						},
-						resolveWithFullResponse: true,
-						simple: false,
-					}
+				// Remotely get the required data.
+				const form = new FormData();
+				form.set(
+					'request',
+					JSON.stringify(this._getSystemTelemetryData())
 				);
+				form.set(
+					'license',
+					new File([licenseFileBuffer], DEFAULT_LICENSE_FILENAME, {
+						type: 'application/octet-stream',
+					})
+				);
+
+				// Remotely validate the license file.
+				return fetch(`${this._backendBaseUrl}/license/validate`, {
+					body: form,
+					method: 'POST',
+				});
 			})
 			.catch((error) => {
-				if (error.hasOwnProperty('solution')) {
+				if (error.solution) {
 					throw error;
 				}
 
@@ -453,25 +446,30 @@ export default class FdtLicense {
 					`Could not get response from license server. Please check if you have a working internet connection.`
 				);
 			})
-			.then((response) => {
-				switch (response.statusCode) {
+			.then(async (response) => {
+				switch (response.status) {
 					case 200: {
-						// Validate response before writing to disk.
-						const validationResult =
-							this._decodeAndValidateLicenseFileData(
-								response.body
-							);
-						if (validationResult.error) {
+						let body;
+
+						try {
+							body = await response.text();
+							// Validate response before writing to disk.
+							const validationResult =
+								this._decodeAndValidateLicenseFileData(body);
+							if (validationResult.error) {
+								throw validationResult.error;
+							}
+						} catch (_error) {
 							throw new Error(
-								'Invalid updated license data received while checking license.'
+								`Invalid updated license data received while checking license.`
 							);
 						}
 
 						// Update license file on disk.
-						return writeFile(this._license.filename, response.body)
+						return writeFile(this._license.filename, body)
 							.catch((_error) => {
 								throw new Error(
-									'Could not update local license file.'
+									`Could not update local license file.`
 								);
 							})
 							.then(() => {
@@ -493,7 +491,7 @@ export default class FdtLicense {
 								this.app.getInfo().name
 							} license validate' to check your license.`
 						);
-						error.statusCode = response.statusCode;
+						error.statusCode = response.status;
 						throw error;
 					}
 					case 401:
@@ -503,14 +501,14 @@ export default class FdtLicense {
 								this.app.getInfo().name
 							} license validate' to check your license.`
 						);
-						error.statusCode = response.statusCode;
+						error.statusCode = response.status;
 						throw error;
 					}
 					default: {
 						const error = new Error(
-							`Error while checking license (${response.statusCode}).`
+							`Error while checking license (${response.status}).`
 						);
-						error.statusCode = response.statusCode;
+						error.statusCode = response.status;
 						throw error;
 					}
 				}
@@ -529,38 +527,30 @@ export default class FdtLicense {
 		return this.getLicenseFileBuffer()
 			.then((licenseFileBuffer) => {
 				// Remotely get the required data.
-				return requestPromise.post(
-					`${this._backendBaseUrl}/product/data`,
-					{
-						formData: {
-							request: {
-								value: JSON.stringify(
-									Object.assign(
-										this._getSystemTelemetryData(),
-										{
-											products: productsWithData,
-										}
-									)
-								),
-								options: {
-									contentType: 'application/json',
-								},
-							},
-							license: {
-								value: licenseFileBuffer,
-								options: {
-									filename: DEFAULT_LICENSE_FILENAME,
-									contentType: 'application/octet-stream',
-								},
-							},
-						},
-						resolveWithFullResponse: true,
-						simple: false,
-					}
+				const form = new FormData();
+				form.set(
+					'request',
+					JSON.stringify(
+						Object.assign(this._getSystemTelemetryData(), {
+							products: productsWithData,
+						})
+					)
+				);
+				form.set(
+					'license',
+					new File([licenseFileBuffer], DEFAULT_LICENSE_FILENAME, {
+						type: 'application/octet-stream',
+					})
 				);
+
+				// Remotely validate the license file.
+				return fetch(`${this._backendBaseUrl}/product/data`, {
+					body: form,
+					method: 'POST',
+				});
 			})
 			.catch((error) => {
-				if (error.hasOwnProperty('solution')) {
+				if (error.solution) {
 					throw error;
 				}
 
@@ -568,18 +558,16 @@ export default class FdtLicense {
 					`Could not get response from license server. Please check if you have a working internet connection.`
 				);
 			})
-			.then((response) => {
-				switch (response.statusCode) {
+			.then(async (response) => {
+				switch (response.status) {
 					case 200: {
-						let data;
 						try {
-							data = JSON.parse(response.body);
-						} catch (_error) {
+							return await response.json();
+						} catch (_err) {
 							throw new Error(
-								'Invalid response data while getting data for products.'
+								`Invalid response data while getting data for products.`
 							);
 						}
-						return data;
 					}
 					case 400: {
 						const error = new Error(
@@ -587,7 +575,7 @@ export default class FdtLicense {
 								this.app.getInfo().name
 							} license validate' to check your license.`
 						);
-						error.statusCode = response.statusCode;
+						error.statusCode = response.status;
 						throw error;
 					}
 					case 401:
@@ -597,21 +585,21 @@ export default class FdtLicense {
 								this.app.getInfo().name
 							} license validate' to check your license.`
 						);
-						error.statusCode = response.statusCode;
+						error.statusCode = response.status;
 						throw error;
 					}
 					case 404: {
 						const error = new Error(
 							'Could not get requested data, because one or more of the requested products or their data does not exist.'
 						);
-						error.statusCode = response.statusCode;
+						error.statusCode = response.status;
 						throw error;
 					}
 					default: {
 						const error = new Error(
-							`Error while getting data for products (${response.statusCode}).`
+							`Error while getting data for products (${response.status}).`
 						);
-						error.statusCode = response.statusCode;
+						error.statusCode = response.status;
 						throw error;
 					}
 				}
@@ -649,47 +637,40 @@ export default class FdtLicense {
 	sendTelemetry(data) {
 		return this.getLicenseFileBuffer()
 			.then((licenseFileBuffer) => {
-				return requestPromise.post(
-					`${this._backendBaseUrl}/telemetry`,
-					{
-						formData: {
-							request: {
-								value: JSON.stringify(
-									Object.assign(
-										this._getSystemTelemetryData(),
-										{
-											data,
-										}
-									)
-								),
-								options: {
-									contentType: 'application/json',
-								},
-							},
-							license: {
-								value: licenseFileBuffer,
-								options: {
-									filename: DEFAULT_LICENSE_FILENAME,
-									contentType: 'application/octet-stream',
-								},
-							},
-						},
-						resolveWithFullResponse: true,
-						simple: false,
-						timeout: 10000,
-					}
+				// Remotely get the required data.
+				const form = new FormData();
+				form.set(
+					'request',
+					JSON.stringify(
+						Object.assign(this._getSystemTelemetryData(), {
+							data,
+						})
+					)
+				);
+				form.set(
+					'license',
+					new File([licenseFileBuffer], DEFAULT_LICENSE_FILENAME, {
+						type: 'application/octet-stream',
+					})
 				);
+
+				// Remotely validate the license file.
+				return fetch(`${this._backendBaseUrl}/telemetry`, {
+					body: form,
+					method: 'POST',
+					timeout: 10000,
+				});
 			})
 			.then((response) => {
-				switch (response.statusCode) {
+				switch (response.status) {
 					case 200:
 					case 204:
 						break;
 					default: {
 						const error = new Error(
-							`Error while sending telemetry (${response.statusCode}).`
+							`Error while sending telemetry (${response.status}).`
 						);
-						error.statusCode = response.statusCode;
+						error.statusCode = response.status;
 						throw error;
 					}
 				}

package/src/ModuleRegistrationApi.js

@@ -8,6 +8,12 @@ const CONTEXTINFORMERS = Symbol('context informers');
 const LOCATION = Symbol('location');
 const PACKAGEJSON = Symbol('package.json');
 
+/** @typedef {import('./App').default} App */
+/** @typedef {import('./ConfigManager').default} ConfigManager */
+/** @typedef {import('./FdtCommand').default} FdtCommand */
+
+/** @typedef {(request: AskNicelyRequest, response: FdtResponse) => void} ContextInformer */
+
 /**
  * The unified API for registering module functionality with the FDT instance. The callback exposed
  * by a module will get an instance of ModuleRegistrationApi to register itself with.
@@ -22,16 +28,21 @@ export default class ModuleRegistrationApi {
 	 * @constructor
 	 */
 	constructor(app, moduleLocation) {
+		/** @type {App} */
 		this[APP] = app;
 
+		/** @type {string} */
 		this[LOCATION] = moduleLocation;
 
+		/** @type {{ name: string, version?: string, description?: string }} */
 		this[PACKAGEJSON] = JSON.parse(
 			readFileSync(path.join(this[LOCATION], 'package.json'), 'utf-8')
 		);
 
+		/** @type {ContextInformer[]} */
 		this[CONTEXTINFORMERS] = [];
 
+		/** @type {boolean} */
 		this.hidden = false;
 
 		Object.assign(this, ask);
@@ -40,9 +51,9 @@ export default class ModuleRegistrationApi {
 	/**
 	 * Should not be called by a module. Loads and evaluates the Javascript code belonging to a module.
 	 *
-	 * @param {...*} extra
+	 * @param {...any} extraArguments
 	 */
-	async load(...extra) {
+	async load(...extraArguments) {
 		const defaultExport = (
 			await import(pathToFileURL(path.join(this[LOCATION], 'index.js')))
 		).default;
@@ -51,7 +62,7 @@ export default class ModuleRegistrationApi {
 			throw new Error(`${this[PACKAGEJSON].name} is not a function.`);
 		}
 
-		defaultExport(this, ...extra);
+		await defaultExport(this, ...extraArguments);
 	}
 
 	/**
@@ -59,7 +70,7 @@ export default class ModuleRegistrationApi {
 	 *
 	 * @see App#getInfo
 	 *
-	 * @return {object} The app information.
+	 * @return {{name: string, version?: string}} The app information.
 	 */
 	getAppInfo() {
 		return this[APP].getInfo();
@@ -68,7 +79,7 @@ export default class ModuleRegistrationApi {
 	/**
 	 * Returns metadata about the module that is being registered.
 	 *
-	 * @return {{name, version, builtIn, description, path}} The module information.
+	 * @return {{name: string, version?: string, builtIn: boolean, description?: string, path: string}} The module information.
 	 */
 	getInfo() {
 		return {
@@ -80,15 +91,28 @@ export default class ModuleRegistrationApi {
 		};
 	}
 
+	/**
+	 * Retrieve the path to a registered module by its name.
+	 *
+	 * NOTE: Only paths to modules loaded earlier than the current module can be looked up.
+	 *
+	 * @param {string} moduleName The name of the module (see its package.json).
+	 *
+	 * @return {(string|undefined)}
+	 */
+	getPathToModule(moduleName) {
+		return this[APP].getPathToModule(moduleName);
+	}
+
 	/**
 	 * Adds a command to the root of the FDT instance.
 	 *
 	 * @see FdtCommand#addCommand
 	 *
 	 * @param {string} commandName
-	 * @param {string|function(AskNicelyRequest, SpeakSoftly)} [controller]
+	 * @param {string|(request: AskNicelyRequest, response: FdtResponse) => (void | Promise<void>)} [controller]
 	 *
-	 * @return {Command} The command object that was created.
+	 * @return {FdtCommand} The command object that was created.
 	 */
 	registerCommand(commandName, controller) {
 		const command = this[APP].cli.addCommand(commandName, controller);
@@ -102,9 +126,9 @@ export default class ModuleRegistrationApi {
 	 * @see FdtCommand#addHiddenCommand
 	 *
 	 * @param {string} commandName
-	 * @param {string|function(AskNicelyRequest, SpeakSoftly)} [controller]
+	 * @param {string|(request: AskNicelyRequest, response: FdtResponse) => (void | Promise<void>)} [controller]
 	 *
-	 * @return {Command} The command object that was created.
+	 * @return {FdtCommand} The command object that was created.
 	 */
 	registerHiddenCommand(commandName, controller) {
 		const command = this[APP].cli.addHiddenCommand(commandName, controller);
@@ -117,11 +141,13 @@ export default class ModuleRegistrationApi {
 	 *
 	 * @see ConfigManager#registerConfiguration
 	 *
+	 * @template {*} [TValue=*]
+	 *
 	 * @param {string} configName
-	 * @param {*}      defaultValue
-	 * @param {*|function(config): ?*} [serialize]
+	 * @param {TValue} defaultValue
+	 * @param {*|((config: TValue) => * | null)} [serialize]
 	 *
-	 * @return {*} The configuration value.
+	 * @return {TValue} The configuration value.
 	 */
 	registerConfiguration(configName, defaultValue, serialize) {
 		return this[APP].config.registerConfig(
@@ -134,9 +160,11 @@ export default class ModuleRegistrationApi {
 	/**
 	 * Get the registered configuration.
 	 *
+	 * @template {*} [TValue=*]
+	 *
 	 * @param {string} configName
 	 *
-	 * @return {*} The configuration value.
+	 * @return {TValue} The configuration value.
 	 */
 	getConfiguration(configName) {
 		return this[APP].config[configName];
@@ -146,9 +174,9 @@ export default class ModuleRegistrationApi {
 	 * Register a subcontroller to render additional info provided by a module in the "who" command
 	 * provided by FDT.
 	 *
-	 * @param {function(AskNicelyRequest, SpeakSoftly)} contextInformer
+	 * @param {ContextInformer} contextInformer
 	 *
-	 * @return {Object} The context informer.
+	 * @return {ContextInformer} The context informer.
 	 */
 	registerContextInformer(contextInformer) {
 		this[CONTEXTINFORMERS].push(contextInformer);
@@ -159,7 +187,7 @@ export default class ModuleRegistrationApi {
 	/**
 	 * Should not be called by a module. Return the list of context informers registered by this module.
 	 *
-	 * @return {Array} The context informers.
+	 * @return {ContextInformer[]} The context informers.
 	 */
 	getContextInformers() {
 		return this[CONTEXTINFORMERS].slice(0);

package/src/addCoreModulesToApp.js

@@ -16,6 +16,14 @@ export default async function addCoreModulesToApp(app, options) {
 	);
 	coreModule.hidden = true;
 
+	// Load the shared module and hide it from listing.
+	const sharedModule = await app.enableBuiltInModule(
+		path.join(__dirname, 'modules', 'shared'),
+		app,
+		options
+	);
+	sharedModule.hidden = true;
+
 	// Load modules from configuration dot-rc file.
 	(Array.isArray(moduleConfig) ? moduleConfig : []).map((modulePath) => {
 		try {