@fontoxml/fontoxml-development-tools 3.10.0 → 3.12.0-beta.1

package/src/modules/connectors/index.js

@@ -1,23 +1,116 @@
-import commandBuild from './src/command.build.js';
-import commandDownloadSelfContained from './src/command.download-self-contained.js';
-import commandInit from './src/command.init.js';
-import commandRun from './src/command.run.js';
-import commandUpgrade from './src/command.upgrade.js';
-import commandVersions from './src/command.versions.js';
+import path from 'path';
+import { fileURLToPath, pathToFileURL } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 export default async (moduleRegistration) => {
-	const connectorsCommand = moduleRegistration
-		.registerHiddenCommand('connectors')
-		.setDescription('Provides tools for working with Fonto Connectors.')
+	const options = {
+		licenseProductName: 'connectors',
+		licensesRequired: ['connectors'],
+		productLabel: 'Fonto Connectors',
+		commandPrefix: 'connectors',
+
+		documentationConfigurationGuide:
+			'http://documentation.fontoxml.com/display/FC/Connectors+configuration',
+		documentationExecuteError:
+			'http://documentation.fontoxml.com/display/FC/Troubleshooting',
+		documentationGettingStartedGuide:
+			'http://documentation.fontoxml.com/display/FC/Getting+started',
+
+		defaultHttpPort: 6010,
+		defaultHttpsPort: 6011,
+		defaultImageName: 'fonto-connectors',
+		defaultImageTag: 'latest',
+
+		manifestFileName: '.fontoxmlConnectorsManifest',
+		manifestVersionPropertyName: 'connectorsVersion',
+
+		instanceBuildDockerfilePath: path.join(
+			__dirname,
+			'instanceBuild',
+			'Dockerfile.build'
+		),
+		instanceDevBuildDirectoryPath: path.join(__dirname, 'instanceDevBuild'),
+		instanceDevBuildDockerfilePath: path.join(
+			__dirname,
+			'instanceBuild',
+			'Dockerfile.run'
+		),
+		instanceTemplateDirectoryPath: path.join(__dirname, 'instanceTemplate'),
+
+		requiredConfiguration: [
+			'editor',
+			'templates',
+			'documentProcessing.xml',
+		],
+		temporaryDirectoryName: '.connectorsTmp',
+		temporaryBuildDirectoryName: '.connectorsBuildTmp',
+		whitelist: [
+			// Required.
+			'documentProcessing.xml',
+			'editor',
+			'processing',
+			'templates',
+			// Optional
+			'initializer-files',
+			'nlog.config',
+		],
 
-		.addRequiredProductLicenses(['connectors'])
+		debugEnvEntries: {
+			fc__logging__logLevel: 'Trace',
+		},
+	};
+
+	const command = moduleRegistration
+		.registerHiddenCommand(options.commandPrefix)
+		.setDescription(
+			`Provides tools for working with ${options.productLabel}.`
+		)
+
+		.addRequiredProductLicenses(options.licensesRequired)
 		.setHideIfMissingRequiredProductLicenses()
 		.setAsHelpCommand();
 
-	commandBuild(moduleRegistration, connectorsCommand);
-	commandDownloadSelfContained(moduleRegistration, connectorsCommand);
-	commandInit(moduleRegistration, connectorsCommand);
-	commandRun(moduleRegistration, connectorsCommand);
-	commandUpgrade(moduleRegistration, connectorsCommand);
-	commandVersions(moduleRegistration, connectorsCommand);
+	if (options.commandAlias) {
+		command.addAlias(options.commandAlias);
+	}
+
+	const sharedModulePath = moduleRegistration.getPathToModule(
+		'@fontoxml/fontoxml-development-tools-module-shared'
+	);
+
+	// Add the docker based commands.
+	const addBackendDockerCommandsPath = pathToFileURL(
+		path.resolve(sharedModulePath, 'src/addBackendDockerCommands.js')
+	);
+	const addBackendDockerCommands = (
+		await import(addBackendDockerCommandsPath)
+	).default;
+	addBackendDockerCommands(moduleRegistration, command, options);
+
+	// Add the version commands.
+	const addBackendVersionsCommandsPath = pathToFileURL(
+		path.resolve(sharedModulePath, 'src/addBackendVersionsCommands.js')
+	);
+	const addBackendVersionsCommands = (
+		await import(addBackendVersionsCommandsPath)
+	).default;
+	addBackendVersionsCommands(moduleRegistration, command, options);
+
+	// Add the download-self-contained command.
+	const addBackendDownloadSelfContainedCommandsPath = pathToFileURL(
+		path.resolve(
+			sharedModulePath,
+			'src/addBackendDownloadSelfContainedCommands.js'
+		)
+	);
+	const addBackendDownloadSelfContainedCommands = (
+		await import(addBackendDownloadSelfContainedCommandsPath)
+	).default;
+	addBackendDownloadSelfContainedCommands(
+		moduleRegistration,
+		command,
+		options
+	);
 };

package/src/modules/connectors/instanceBuild/Dockerfile.build

@@ -1,4 +1,4 @@
-FROM ${connectorsImage}
+FROM ${image}
 
 COPY ./instance .
 

package/src/modules/connectors/instanceBuild/Dockerfile.run

@@ -1,4 +1,4 @@
-FROM ${connectorsImage}
+FROM ${image}
 
 COPY ./instance .
 

package/src/modules/connectors/instanceDevBuild/docker-compose.yml

@@ -11,5 +11,5 @@ services:
         env_file:
             - .env
         ports:
-            - ${connectorsHttpPort}:80
-            - ${connectorsHttpsPort}:443
+            - ${httpPort}:80
+            - ${httpsPort}:443

package/src/modules/content-quality/index.js

@@ -1,27 +1,108 @@
-import commandBuild from './src/command.build.js';
-import commandDownloadSelfContained from './src/command.download-self-contained.js';
-import commandInit from './src/command.init.js';
-import commandRun from './src/command.run.js';
-import commandUpgrade from './src/command.upgrade.js';
-import commandVersions from './src/command.versions.js';
-import constants from './src/utilities/constants.js';
-
-export default (moduleRegistration) => {
-	const fcqCommand = moduleRegistration
-		.registerCommand(constants.COMMAND_PREFIX)
+import path from 'path';
+import { fileURLToPath, pathToFileURL } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export default async (moduleRegistration) => {
+	const options = {
+		licenseProductName: 'content-quality',
+		licensesRequired: ['content-quality'],
+		productLabel: 'Fonto Content Quality',
+		commandPrefix: 'content-quality',
+		commandAlias: 'fcq',
+
+		documentationConfigurationGuide:
+			'https://documentation.fontoxml.com/latest/configuration-f6814dd919fd',
+		documentationExecuteError:
+			'https://documentation.fontoxml.com/latest/troubleshooting-fc105f9f1e60',
+		documentationGettingStartedGuide:
+			'https://documentation.fontoxml.com/latest/getting-started-86c3404e841c',
+
+		defaultHttpPort: 6000,
+		defaultImageName: 'fonto-content-quality',
+		defaultImageTag: 'latest',
+
+		manifestFileName: '.fontoxmlFcqManifest',
+		manifestVersionPropertyName: 'fcqVersion',
+
+		instanceBuildDockerfilePath: path.join(
+			__dirname,
+			'instanceBuild',
+			'Dockerfile'
+		),
+		instanceDevBuildDirectoryPath: path.join(__dirname, 'instanceDevBuild'),
+		instanceDevBuildDockerfilePath: path.join(
+			__dirname,
+			'instanceBuild',
+			'Dockerfile'
+		),
+		instanceTemplateDirectoryPath: path.join(__dirname, 'instanceTemplate'),
+
+		requiredConfiguration: ['Configuration'],
+		temporaryDirectoryName: '.contentQualityTmp',
+		temporaryBuildDirectoryName: '.contentQualityBuildTmp',
+		whitelist: [
+			// Required.
+			'Configuration',
+			// Optional.
+			'nlog.config',
+		],
+
+		debugEnvEntries: {
+			Logging__LogLevel__Default: 'Trace',
+		},
+	};
+
+	const command = moduleRegistration
+		.registerCommand(options.commandPrefix)
 		.setDescription(
-			'Provides tools to build a Fonto Content Quality instance.'
+			`Provides tools for working with ${options.productLabel}.`
 		)
-		.addAlias(constants.COMMAND_PREFIX_ALIAS)
 
-		.addRequiredProductLicenses(['content-quality'])
+		.addRequiredProductLicenses(options.licensesRequired)
 		.setHideIfMissingRequiredProductLicenses()
 		.setAsHelpCommand();
 
-	commandBuild(moduleRegistration, fcqCommand);
-	commandDownloadSelfContained(moduleRegistration, fcqCommand);
-	commandInit(moduleRegistration, fcqCommand);
-	commandRun(moduleRegistration, fcqCommand);
-	commandUpgrade(moduleRegistration, fcqCommand);
-	commandVersions(moduleRegistration, fcqCommand);
+	if (options.commandAlias) {
+		command.addAlias(options.commandAlias);
+	}
+
+	const sharedModulePath = moduleRegistration.getPathToModule(
+		'@fontoxml/fontoxml-development-tools-module-shared'
+	);
+
+	// Add the docker based commands.
+	const addBackendDockerCommandsPath = pathToFileURL(
+		path.resolve(sharedModulePath, 'src/addBackendDockerCommands.js')
+	);
+	const addBackendDockerCommands = (
+		await import(addBackendDockerCommandsPath)
+	).default;
+	addBackendDockerCommands(moduleRegistration, command, options);
+
+	// Add the version commands.
+	const addBackendVersionsCommandsPath = pathToFileURL(
+		path.resolve(sharedModulePath, 'src/addBackendVersionsCommands.js')
+	);
+	const addBackendVersionsCommands = (
+		await import(addBackendVersionsCommandsPath)
+	).default;
+	addBackendVersionsCommands(moduleRegistration, command, options);
+
+	// Add the download-self-contained command.
+	const addBackendDownloadSelfContainedCommandsPath = pathToFileURL(
+		path.resolve(
+			sharedModulePath,
+			'src/addBackendDownloadSelfContainedCommands.js'
+		)
+	);
+	const addBackendDownloadSelfContainedCommands = (
+		await import(addBackendDownloadSelfContainedCommandsPath)
+	).default;
+	addBackendDownloadSelfContainedCommands(
+		moduleRegistration,
+		command,
+		options
+	);
 };

package/src/modules/content-quality/instanceBuild/Dockerfile

@@ -1,4 +1,4 @@
-FROM ${fcqImage}
+FROM ${image}
 
 # copy files
 COPY ./instance .

package/src/modules/content-quality/instanceDevBuild/docker-compose.yml

@@ -6,4 +6,4 @@ services:
         env_file:
             - .env
         ports:
-            - '${fcqPort}:80'
+            - '${httpPort}:80'

package/src/modules/core/src/precontroller.help.js

@@ -64,26 +64,26 @@ export default (moduleRegistration, app) => {
 			res.debug(command.longDescription);
 		}
 
-		if (command.children.length) {
+		const visibleChildren = command.children.filter((child) => {
+			if (child.hidden) {
+				return false;
+			}
+
+			if (
+				child.hideIfMissingRequiredProductLicenses &&
+				!req.fdt.license.hasProductLicenses(
+					child.requiredProductLicenses
+				)
+			) {
+				return false;
+			}
+
+			return true;
+		});
+		if (visibleChildren.length) {
 			res.caption('Child commands');
-			command.children
+			visibleChildren
 				.sort(sortByName)
-				.filter((child) => {
-					if (child.hidden) {
-						return false;
-					}
-
-					if (
-						child.hideIfMissingRequiredProductLicenses &&
-						!req.fdt.license.hasProductLicenses(
-							child.requiredProductLicenses
-						)
-					) {
-						return false;
-					}
-
-					return true;
-				})
 				.forEach((child) =>
 					res.definition(child.name, child.description)
 				);
@@ -94,15 +94,12 @@ export default (moduleRegistration, app) => {
 			res.properties(command.parameters.map(toParameterRow));
 		}
 
-		const options = command.options;
-		if (options.length) {
+		const visibleOptions = command.options.filter(
+			(option) => !option.hidden
+		);
+		if (visibleOptions.length) {
 			res.caption('Options');
-			res.properties(
-				options
-					.filter((option) => !option.hidden)
-					.sort(sortByName)
-					.map(toOptionRow)
-			);
+			res.properties(visibleOptions.sort(sortByName).map(toOptionRow));
 		}
 
 		const examples = command.examples;

package/src/modules/document-history/index.js

@@ -1,27 +1,108 @@
-import commandBuild from './src/command.build.js';
-import commandDownloadSelfContained from './src/command.download-self-contained.js';
-import commandInit from './src/command.init.js';
-import commandRun from './src/command.run.js';
-import commandUpgrade from './src/command.upgrade.js';
-import commandVersions from './src/command.versions.js';
-import constants from './src/utilities/constants.js';
-
-export default (moduleRegistration) => {
-	const fdhCommand = moduleRegistration
-		.registerCommand(constants.COMMAND_PREFIX)
+import path from 'path';
+import { fileURLToPath, pathToFileURL } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export default async (moduleRegistration) => {
+	const options = {
+		licenseProductName: 'document-history',
+		licensesRequired: ['document-history'],
+		productLabel: 'Fonto Document History',
+		commandPrefix: 'document-history',
+		commandAlias: 'fdh',
+
+		documentationConfigurationGuide:
+			'https://documentation.fontoxml.com/latest/fonto-document-history-5a117c375303',
+		documentationExecuteError:
+			'https://documentation.fontoxml.com/latest/fonto-document-history-5a117c375303',
+		documentationGettingStartedGuide:
+			'https://documentation.fontoxml.com/latest/fonto-document-history-5a117c375303',
+
+		defaultHttpPort: 6030,
+		defaultImageName: 'fonto-document-history',
+		defaultImageTag: 'latest',
+
+		manifestFileName: '.fontoxmlFdhManifest',
+		manifestVersionPropertyName: 'fdhVersion',
+
+		instanceBuildDockerfilePath: path.join(
+			__dirname,
+			'instanceBuild',
+			'Dockerfile'
+		),
+		instanceDevBuildDirectoryPath: path.join(__dirname, 'instanceDevBuild'),
+		instanceDevBuildDockerfilePath: path.join(
+			__dirname,
+			'instanceBuild',
+			'Dockerfile'
+		),
+		instanceTemplateDirectoryPath: path.join(__dirname, 'instanceTemplate'),
+
+		requiredConfiguration: ['Configuration'],
+		temporaryDirectoryName: '.documentHistoryTmp',
+		temporaryBuildDirectoryName: '.documentHistoryBuildTmp',
+		whitelist: [
+			// Required.
+			'Configuration',
+			// Optional.
+			'nlog.config',
+		],
+
+		debugEnvEntries: {
+			Logging__LogLevel__Default: 'Trace',
+		},
+	};
+
+	const command = moduleRegistration
+		.registerCommand(options.commandPrefix)
 		.setDescription(
-			'Provides tools for working with Fonto Document History.'
+			`Provides tools for working with ${options.productLabel}.`
 		)
-		.addAlias(constants.COMMAND_PREFIX_ALIAS)
 
-		.addRequiredProductLicenses(['document-history'])
+		.addRequiredProductLicenses(options.licensesRequired)
 		.setHideIfMissingRequiredProductLicenses()
 		.setAsHelpCommand();
 
-	commandBuild(moduleRegistration, fdhCommand);
-	commandDownloadSelfContained(moduleRegistration, fdhCommand);
-	commandInit(moduleRegistration, fdhCommand);
-	commandRun(moduleRegistration, fdhCommand);
-	commandUpgrade(moduleRegistration, fdhCommand);
-	commandVersions(moduleRegistration, fdhCommand);
+	if (options.commandAlias) {
+		command.addAlias(options.commandAlias);
+	}
+
+	const sharedModulePath = moduleRegistration.getPathToModule(
+		'@fontoxml/fontoxml-development-tools-module-shared'
+	);
+
+	// Add the docker based commands.
+	const addBackendDockerCommandsPath = pathToFileURL(
+		path.resolve(sharedModulePath, 'src/addBackendDockerCommands.js')
+	);
+	const addBackendDockerCommands = (
+		await import(addBackendDockerCommandsPath)
+	).default;
+	addBackendDockerCommands(moduleRegistration, command, options);
+
+	// Add the version commands.
+	const addBackendVersionsCommandsPath = pathToFileURL(
+		path.resolve(sharedModulePath, 'src/addBackendVersionsCommands.js')
+	);
+	const addBackendVersionsCommands = (
+		await import(addBackendVersionsCommandsPath)
+	).default;
+	addBackendVersionsCommands(moduleRegistration, command, options);
+
+	// Add the download-self-contained command.
+	const addBackendDownloadSelfContainedCommandsPath = pathToFileURL(
+		path.resolve(
+			sharedModulePath,
+			'src/addBackendDownloadSelfContainedCommands.js'
+		)
+	);
+	const addBackendDownloadSelfContainedCommands = (
+		await import(addBackendDownloadSelfContainedCommandsPath)
+	).default;
+	addBackendDownloadSelfContainedCommands(
+		moduleRegistration,
+		command,
+		options
+	);
 };

package/src/modules/document-history/instanceBuild/Dockerfile

@@ -1,4 +1,4 @@
-FROM ${fdhImage}
+FROM ${image}
 
 # copy files
 COPY ./instance .

package/src/modules/document-history/instanceDevBuild/docker-compose.yml

@@ -6,4 +6,4 @@ services:
         env_file:
             - .env
         ports:
-            - '${fdhPort}:80'
+            - '${httpPort}:80'

package/src/modules/editor/dev-cms/connectors-cms-standard/configureConnectorsCmsStandardDocumentRouter.js

@@ -2,12 +2,14 @@ import express from 'express';
 
 import configureDocumentCompareRouteHandler from './configureDocumentCompareRouteHandler.js';
 import configureDocumentGetRouteHandler from './configureDocumentGetRouteHandler.js';
+import configureDocumentHistoryGetPostRouteHandler from './configureDocumentHistoryGetPostRouteHandler.js';
 import configureDocumentHistoryGetRouteHandler from './configureDocumentHistoryGetRouteHandler.js';
 import configureDocumentLockPutRouteHandler from './configureDocumentLockPutRouteHandler.js';
 import configureDocumentPostRouteHandler from './configureDocumentPostRouteHandler.js';
 import configureDocumentPresearchPostRouteHandler from './configureDocumentPresearchPostRouteHandler.js';
 import configureDocumentPreviewRouteHandler from './configureDocumentPreviewRouteHandler.js';
 import configureDocumentPutRouteHandler from './configureDocumentPutRouteHandler.js';
+import configureDocumentRevisionGetPostRouteHandler from './configureDocumentRevisionGetPostRouteHandler.js';
 import configureDocumentRevisionGetRouteHandler from './configureDocumentRevisionGetRouteHandler.js';
 import configureDocumentStatePostRouteHandler from './configureDocumentStatePostRouteHandler.js';
 
@@ -25,6 +27,10 @@ function configureConnectorsCmsStandardDocumentRouter(config) {
 		.route('/connectors/cms/standard/document/history')
 		.get(configureDocumentHistoryGetRouteHandler());
 
+	connectorsCmsStandardDocumentRouter
+		.route('/connectors/cms/standard/document/history/get')
+		.post(configureDocumentHistoryGetPostRouteHandler());
+
 	connectorsCmsStandardDocumentRouter
 		.route('/connectors/cms/standard/document/compare')
 		.get(configureDocumentCompareRouteHandler());
@@ -49,6 +55,10 @@ function configureConnectorsCmsStandardDocumentRouter(config) {
 		.route('/connectors/cms/standard/document/revision')
 		.get(configureDocumentRevisionGetRouteHandler());
 
+	connectorsCmsStandardDocumentRouter
+		.route('/connectors/cms/standard/document/revision/get')
+		.post(configureDocumentRevisionGetPostRouteHandler());
+
 	return connectorsCmsStandardDocumentRouter;
 }
 

package/src/modules/editor/dev-cms/connectors-cms-standard/configureDocumentHistoryGetPostRouteHandler.js

@@ -0,0 +1,51 @@
+export default function configureDocumentHistoryGetPostRouteHandler() {
+	return (req, res) => {
+		const documentIds = req.body.documentIds;
+		const correlationIdRepository = req.repositories.correlationId;
+
+		// Because these requests do not originate from the editor, but from another server, we
+		// have no edit session token. We do, however, have an correlationId which we may resolve
+		// to the editSessionToken used by the corresponding call to the proxy
+		const editSessionToken =
+			correlationIdRepository.getEditSessionTokenForRequest(req);
+
+		const promises = documentIds.map((documentId) => {
+			return new Promise((resolve, _) => {
+				req.cms.loadHistory(
+					documentId,
+					editSessionToken,
+					(error, revisions) => {
+						const historyResponse = { documentId };
+						if (error) {
+							historyResponse.status = 404;
+						} else {
+							historyResponse.status = 200;
+
+							const newestRevision = revisions[0];
+							const newestRevisionIsWorkingCopy =
+								!!newestRevision &&
+								newestRevision._editSessionToken ===
+									editSessionToken;
+
+							historyResponse.history = {
+								newestRevisionIsWorkingCopy,
+								revisions,
+							};
+						}
+						resolve(historyResponse);
+					}
+				);
+			});
+		});
+
+		Promise.all(promises).then((results) => {
+			const response = {
+				results,
+			};
+
+			res.status(200)
+				.set('content-type', 'application/json; charset=utf-8')
+				.json(response);
+		});
+	};
+}