@fontoxml/fontoxml-development-tools/src/FdtCommand.js

'use strict';

const Fotno = require('fotno');

Fotno.FotnoCommand.addFileNameToSkipForSetControllerCallsites('/fontoxml-development-tools/src/FdtCommand.js');

/**
 * A FDT custom version of Fotno#FotnoCommand that has extra options for checking Fonto specific commands.
 *
 * @augments Fotno.FotnoCommand
 */
class FdtCommand extends Fotno.FotnoCommand {
	/**
	 * @constructor
	 * @param {string} name
	 * @param {function(AskNicelyRequest, SpeakSoftly)} [controller]
	 */
	constructor (name, controller) {
		super(name, controller);

		this.setNewChildClass(FdtCommand);

		this.requiredProductLicenses = [];
		this.requiresEditorRepository = false;
		this.requiresToValidateLicenseFile = false;

		this.addPreController(this._preController.bind(this));
	}

	/**
	 * Pre-controller which performs optional checks before executing the actual controller.
	 *
	 * @param {Object} req
	 * @param {Object} res
	 *
	 * @return {Promise}
	 */
	_preController (req, res) {
		let preControllerPromise = Promise.resolve();

		if (this.requiresEditorRepository) {
			preControllerPromise = preControllerPromise.then(() => {
				req.fdt.editorRepository.throwIfNotInsideEditorRepository();
			});
		}

		if (this.requiresToValidateLicenseFile) {
			preControllerPromise = preControllerPromise.then(() => {
				const destroySpinner = res.spinner('Validating license...');

				return req.fdt.license.validateAndUpdateLicenseFile()
					.then(result => {
						destroySpinner();
						return result;
					})
					.catch(error => {
						destroySpinner();
						throw error;
					});
			});
		}

		if (this.requiredProductLicenses.length > 0) {
			preControllerPromise = preControllerPromise.then(() => {
				const destroySpinner = res.spinner('Checking required product licenses...');

				try {
					req.fdt.license.ensureProductLicenses(this.requiredProductLicenses);
					destroySpinner();
				}
				catch (error) {
					destroySpinner();
					throw error;
				}

				return true;
			});
		}

		return preControllerPromise;
	}

	/**
	 * Add a list of required product licenses for performing this command. If the user does not have
	 * access to a product, the command will fail.
	 *
	 * @param {Array<string>} productIds
	 *
	 * @return {FdtCommand}
	 */
	addRequiredProductLicenses (productIds) {
		this.requiredProductLicenses = this.requiredProductLicenses.concat(productIds);

		return this;
	}

	/**
	 * If set, check the license for validity online before executing the command, fail
	 * otherwise.
	 *
	 * @param {boolean} [validateLicense=true]
	 *
	 * @return {FdtCommand}
	 */
	setRequiresLicenseValidation (validateLicense = true) {
		this.requiresToValidateLicenseFile = !!validateLicense;

		return this;
	}

	/**
	 * If set, check if running from an editor repository before executing the command, fail
	 * otherwise.
	 *
	 * @param {boolean} [value=true]
	 *
	 * @return {FdtCommand}
	 */
	setRequiresEditorRepository (value = true) {
		this.requiresEditorRepository = !!value;

		return this;
	}
}

module.exports = FdtCommand;