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

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

@@ -1,25 +1,19 @@
 import path from 'path';
-import xml2js from 'xml2js';
+import { parseXmlDocument } from 'slimdom';
 
-const parseString = xml2js.parseString;
+function createFileNameForNewDocument(content) {
+	let rootElementName = null;
 
-function createIdForNewDocument(content, callback) {
-	parseString(content, function (error, result) {
-		let rootElementName;
-		if (!error) {
-			const rootElements = Object.keys(result);
-			if (rootElements.length) {
-				rootElementName = rootElements[0];
-			}
-		}
-
-		const timestamp = new Date();
-		const fileName = `${timestamp.getTime()}${
-			rootElementName ? `-${rootElementName}` : ''
-		}.xml`;
+	try {
+		const document = parseXmlDocument(content);
+		rootElementName = document.documentElement.localName;
+	} catch (_err) {
+		// do nothing
+	}
 
-		callback(null, fileName);
-	});
+	return `${new Date().getTime()}${
+		rootElementName ? `-${rootElementName}` : ''
+	}.xml`;
 }
 
 function configureDocumentPostRouteHandler(config) {
@@ -31,68 +25,63 @@ function configureDocumentPostRouteHandler(config) {
 		}
 
 		const content = req.body.content;
-		createIdForNewDocument(content, function (_error, fileName) {
-			const context = req.body.context;
-			const currentSession = req.getFontoSession(
-				context.editSessionToken
-			);
-			const documentId = path
-				.join(folderId, fileName)
-				.replace(/\\/g, '/');
-			const metadata = req.body.metadata;
-			const documentContext = {
-				isLockAcquired: true,
-			};
-			documentContext.documentMetadata = metadata;
+		const fileName = createFileNameForNewDocument(content);
+		const context = req.body.context;
+		const currentSession = req.getFontoSession(context.editSessionToken);
+		const documentId = path.join(folderId, fileName).replace(/\\/g, '/');
+		const metadata = req.body.metadata;
+		const documentContext = {
+			isLockAcquired: true,
+		};
+		documentContext.documentMetadata = metadata;
 
-			req.cms.createNew(
-				documentId,
-				content,
-				currentSession,
-				(error, documentId) => {
-					if (error) {
-						res.status(400).send(error);
-						return;
-					}
+		req.cms.createNew(
+			documentId,
+			content,
+			currentSession,
+			(error, documentId) => {
+				if (error) {
+					res.status(400).send(error);
+					return;
+				}
 
-					req.cms.getLatestRevisionId(
-						documentId,
-						currentSession.editSessionToken,
-						(error, revisionId) => {
-							if (error) {
-								res.status(500).send(error);
-								return;
-							}
+				req.cms.getLatestRevisionId(
+					documentId,
+					currentSession.editSessionToken,
+					(error, revisionId) => {
+						if (error) {
+							res.status(500).send(error);
+							return;
+						}
 
-							const documentLoadLock = {
-								...config.documentLoadLock,
-								...config.documentLoadLockOverrides[documentId],
-							};
+						const documentLoadLock = {
+							...config.documentLoadLock,
+							...config.documentLoadLockOverrides[documentId],
+						};
 
-							res.status(201)
-								.set(
-									'content-type',
-									'application/json; charset=utf-8'
-								)
-								.json({
-									documentId,
-									revisionId,
-									content,
-									documentContext,
-									metadata,
-									lock: {
-										isLockAcquired:
-											documentLoadLock.isLockAcquired,
-										isLockAvailable:
-											documentLoadLock.isLockAvailable,
-										reason: documentLoadLock.lockReason,
-									},
-								});
-						}
-					);
-				}
-			);
-		});
+						res.status(201)
+							.set(
+								'content-type',
+								'application/json; charset=utf-8'
+							)
+							.json({
+								documentId,
+								revisionId,
+								content,
+								documentContext,
+								metadata,
+								lock: {
+									isLockAcquired:
+										documentLoadLock.isLockAcquired,
+									isLockAvailable:
+										documentLoadLock.isLockAvailable,
+									reason: documentLoadLock.lockReason,
+								},
+							});
+					}
+				);
+			}
+		);
 	};
 }
 

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

@@ -1,7 +1,7 @@
-import evaluateXPathToBoolean from 'fontoxpath';
-import { slimdom, sync } from 'slimdom-sax-parser';
+import fontoxpath from 'fontoxpath';
+import { Node, parseXmlDocument } from 'slimdom';
 
-const { TEXT_NODE, ELEMENT_NODE } = slimdom.Node;
+const { TEXT_NODE, ELEMENT_NODE } = Node;
 
 const DEFAULT_FIND_AND_REPLACE_PRESEARCH_CONFIG = {
 	blockElementXPathTest:
@@ -23,7 +23,8 @@ function getSearchableTextForDom(findAndReplacePresearchConfig, dom) {
 
 		if (
 			node.nodeType !== ELEMENT_NODE ||
-			evaluateXPathToBoolean(
+			// eslint-disable-next-line import/no-named-as-default-member
+			fontoxpath.evaluateXPathToBoolean(
 				findAndReplacePresearchConfig.removedElementXPathTest,
 				node
 			)
@@ -34,7 +35,8 @@ function getSearchableTextForDom(findAndReplacePresearchConfig, dom) {
 		}
 
 		if (
-			evaluateXPathToBoolean(
+			// eslint-disable-next-line import/no-named-as-default-member
+			fontoxpath.evaluateXPathToBoolean(
 				findAndReplacePresearchConfig.outOfOrderElementXPathTest,
 				node
 			)
@@ -47,7 +49,8 @@ function getSearchableTextForDom(findAndReplacePresearchConfig, dom) {
 		}
 
 		if (
-			evaluateXPathToBoolean(
+			// eslint-disable-next-line import/no-named-as-default-member
+			fontoxpath.evaluateXPathToBoolean(
 				findAndReplacePresearchConfig.blockElementXPathTest,
 				node
 			)
@@ -95,7 +98,7 @@ function getResultForDocumentId(
 				try {
 					const searchableText = getSearchableTextForDom(
 						findAndReplacePresearchConfig,
-						sync(content)
+						parseXmlDocument(content)
 					);
 					if (!searchableText.match(new RegExp(searchTerm, 'gi'))) {
 						resolve(null);

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

@@ -1,7 +1,17 @@
 import PDFDocument from 'pdfkit';
 
+let warningForDeprecationWasLogged = false;
+
 export default function configureDocumentPreviewRouteHandler(_config) {
 	return (req, res) => {
+		// Log Deprecation Warning
+		if (!warningForDeprecationWasLogged) {
+			console.warn(
+				'/n [fontoxml-publication-preview add-on] This API is deprecated and it will be removed in 8.4.0. Please refer to https://documentation.fontoxml.com/latest/upcoming-removals-8-4-167dd6e00dd4 to get more information.'
+			);
+			warningForDeprecationWasLogged = true;
+		}
+
 		const pdf = new PDFDocument();
 		pdf.pipe(res);
 

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

@@ -0,0 +1,69 @@
+export default function configureDocumentRevisionGetPostRouteHandler() {
+	return (req, res) => {
+		const documentsRevisions = req.body.documentsRevisions;
+		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 documentPromises = documentsRevisions.map((documentRevisions) => {
+			const documentId = documentRevisions.documentId;
+
+			const documentExists = req.cms.existsSync(documentId);
+			if (!documentExists) {
+				return {
+					documentId,
+					status: 404,
+				};
+			}
+
+			const revisionPromises = documentRevisions.revisionIds.map(
+				(revisionId) => {
+					return new Promise((resolve, _) => {
+						req.cms.loadRevision(
+							documentId,
+							revisionId,
+							editSessionToken,
+							(error, content) => {
+								const revisionResponse = {
+									revisionId,
+								};
+
+								if (error) {
+									revisionResponse.status = 404;
+								} else {
+									revisionResponse.status = 200;
+									revisionResponse.revision = {
+										content,
+									};
+								}
+								resolve(revisionResponse);
+							}
+						);
+					});
+				}
+			);
+
+			return Promise.all(revisionPromises).then((revisions) => {
+				return {
+					documentId,
+					status: 200,
+					revisions,
+				};
+			});
+		});
+
+		Promise.all(documentPromises).then((results) => {
+			const response = {
+				results,
+			};
+
+			res.status(200)
+				.set('content-type', 'application/json; charset=utf-8')
+				.json(response);
+		});
+	};
+}

package/src/modules/editor/src/commands/command.convert.editor.controller.js

@@ -1,7 +1,7 @@
 import fs from 'fs-extra';
+import inquirer from 'inquirer';
 import path from 'path';
 import { performance } from 'perf_hooks';
-import Confirm from 'prompt-confirm';
 
 import convertEditorWithOutput from './api/convertEditorWithOutput.js';
 
@@ -28,9 +28,16 @@ export default async function editorConvertEditorCommand(req, res) {
 
 	if (
 		!doNotOverwrite &&
-		!(await new Confirm(
-			'The conversion will overwrite all files in the working directory, are you sure you want to continue?'
-		).run())
+		!(await inquirer
+			.prompt([
+				{
+					type: 'confirm',
+					name: 'confirm',
+					message:
+						'The conversion will overwrite all files in the working directory, are you sure you want to continue?',
+				},
+			])
+			.then((answers) => !!answers.confirm))
 	) {
 		res.break();
 		res.notice('Aborted');

package/src/modules/editor/src/commands/command.convert.package.controller.js

@@ -1,9 +1,9 @@
 import fastGlob from 'fast-glob';
 import fs from 'fs-extra';
+import inquirer from 'inquirer';
 import pMap from 'p-map';
 import path from 'path';
 import { performance } from 'perf_hooks';
-import Confirm from 'prompt-confirm';
 
 import outputWarningsByFilename from '../helpers/outputWarningsByFilename.js';
 import prettifyJsFile from '../helpers/prettifyJsFile.js';
@@ -39,9 +39,16 @@ export default async function editorConvertPackageCommand(req, res) {
 
 	if (
 		!doNotOverwrite &&
-		!(await new Confirm(
-			'The conversion will overwrite all files in the working directory, are you sure you want to continue?'
-		).run())
+		!(await inquirer
+			.prompt([
+				{
+					type: 'confirm',
+					name: 'confirm',
+					message:
+						'The conversion will overwrite all files in the working directory, are you sure you want to continue?',
+				},
+			])
+			.then((answers) => !!answers.confirm))
 	) {
 		res.break();
 		res.notice('Aborted');

package/src/modules/editor/src/getWebpackConfig.js

@@ -56,6 +56,15 @@ export default function getWebpackConfig(appConfig, appManifest, options) {
 		srcFolder: picomatch.makeRe(`${paths.srcFolder}**/*`),
 		testAssets: picomatch.makeRe(`${paths.testAssetsFolder}**/*`),
 
+		// Fds imports
+		// TODO: Remove backward compatibility, this is for pre 7.16.0 editors.
+		platformVendorsFdsImport: picomatch.makeRe(
+			`${paths.platformFolder}fontoxml-vendors/src/fds/*`
+		),
+		platformLinkedVendorsFdsImport: picomatch.makeRe(
+			`${paths.platformLinkedFolder}fontoxml-vendors/src/fds/*`
+		),
+
 		// Deep imports
 		platformDeepImport: picomatch.makeRe(
 			`${paths.platformFolder}*/src/*/**/*`
@@ -383,6 +392,10 @@ export default function getWebpackConfig(appConfig, appManifest, options) {
 							regExps.platformDeepImport,
 							regExps.platformLinkedDeepImport,
 						],
+						importPathExcludeRegExps: [
+							regExps.platformVendorsFdsImport,
+							regExps.platformLinkedVendorsFdsImport,
+						],
 						fdtOutputPlugin,
 					}),
 			].filter(Boolean),

package/src/modules/editor/src/webpackPlugins/CheckDeepImportsResolvePlugin.js

@@ -84,6 +84,10 @@ export default class CheckDeepImportsResolvePlugin {
 						// Does the import target an undesired path?
 						this.options.importPathRegExps.some((regExp) =>
 							regExp.test(request.path)
+						) &&
+						// But does not match an excluded regexp.
+						!this.options.importPathExcludeRegExps.some((regExp) =>
+							regExp.test(request.path)
 						)
 					) {
 						// Make the absolute paths easier to read.

package/src/modules/editor-pre-7-7-0/src/api/downloadEditorSDK.js

@@ -1,4 +1,4 @@
-import requestPromise from 'request-promise-native';
+import fetch from 'node-fetch';
 
 /**
  * Download a zipped Fonto Editor SDK.
@@ -44,16 +44,19 @@ export default function downloadEditorSDK(sdkVersion, req, res) {
 		.then((productData) => {
 			const downloadUri =
 				productData.products['editor'].selfContained.uri;
-			return requestPromise
-				.get(downloadUri, {
-					resolveWithFullResponse: true,
-					simple: false,
-					encoding: null,
-				})
-				.then((response) => {
-					switch (response.statusCode) {
+			return fetch(downloadUri, { method: 'GET' }).then(
+				async (response) => {
+					switch (response.status) {
 						case 200:
-							return response.body;
+							try {
+								return Buffer.from(
+									await response.arrayBuffer()
+								);
+							} catch (_err) {
+								throw new Error(
+									`Invalid response data from the Fonto Editor SDK server.`
+								);
+							}
 						case 401:
 						case 403:
 							throw new Error(
@@ -65,9 +68,10 @@ export default function downloadEditorSDK(sdkVersion, req, res) {
 							);
 						default:
 							throw new Error(
-								`Invalid response from the Fonto Editor SDK server (${response.statusCode}).`
+								`Invalid response from the Fonto Editor SDK server (${response.status}).`
 							);
 					}
-				});
+				}
+			);
 		});
 }

package/src/modules/editor-pre-7-7-0/src/api/executeAndLog.js

@@ -1,6 +1,6 @@
+import { supportsColor } from 'chalk';
 import cp from 'child_process';
 import os from 'os';
-import supportsColor from 'supports-color';
 
 export default (
 	res,
@@ -14,7 +14,8 @@ export default (
 	return new Promise((resolve, reject) => {
 		const errors = [];
 		const env = { ...process.env };
-		if (supportsColor.stdout) {
+
+		if (supportsColor) {
 			env.FORCE_COLOR = true;
 		}
 

package/src/modules/editor-pre-7-7-0/src/api/schema/compile.js

@@ -1,5 +1,4 @@
-import requestPromise from 'request-promise-native';
-import url from 'url';
+import fetch, { File, FormData } from 'node-fetch';
 
 /**
  * Compile a schema zip archive using the schema compile service.
@@ -12,34 +11,29 @@ import url from 'url';
 export default async (baseUrl, compressedSchema) => {
 	let response;
 	try {
-		response = await requestPromise.post(
-			url.resolve(baseUrl, '/api/compile'),
-			{
-				formData: {
-					data: {
-						options: {
-							contentType: 'application/zip',
-							filename: 'schema.zip',
-						},
-						value: compressedSchema,
-					},
-				},
-				resolveWithFullResponse: true,
-				simple: false,
-			}
+		const form = new FormData();
+		form.set(
+			'schema',
+			new File([compressedSchema], 'schema.zip', {
+				type: 'application/zip',
+			}),
+			'schema.zip'
 		);
+
+		const compileUrl = new URL('/api/compile', baseUrl);
+		response = await fetch(compileUrl.href, { method: 'POST', body: form });
 	} catch (_error) {
 		throw new Error('Could not connect to the schema compile service.');
 	}
 
-	switch (response.statusCode) {
+	switch (response.status) {
 		case 200:
 		case 400:
 			try {
-				return JSON.parse(response.body);
-			} catch (_error) {
+				return await response.json();
+			} catch (_err) {
 				throw new Error(
-					'Invalid response data from the schema compile service.'
+					`Invalid response data from the schema compile service.`
 				);
 			}
 		case 401:
@@ -49,7 +43,7 @@ export default async (baseUrl, compressedSchema) => {
 			);
 		default:
 			throw new Error(
-				`Invalid response from the schema compile service (${response.statusCode}).`
+				`Invalid response from the schema compile service (${response.status}).`
 			);
 	}
 };

package/src/modules/editor-pre-7-7-0/src/api/schema/createSchemaPackages.js

@@ -90,6 +90,14 @@ async function createPackageSchemaLocationsJsFile(
 	]);
 
 	await writeAstProgramToFile(schemaLocationsFilePath, schemaLocationsJsAst);
+
+	await fs.remove(
+		path.join(
+			packageDirectoryPath,
+			'src',
+			useTypeScript ? 'SCHEMA_LOCATIONS.js' : 'SCHEMA_LOCATIONS.ts'
+		)
+	);
 }
 
 /**

package/src/modules/editor-pre-7-7-0/src/api/schema/getSchemaFontoJson.js

@@ -2,6 +2,80 @@ import fs from 'fs-extra';
 import os from 'os';
 import path from 'path';
 
+/**
+ * Validate the schema fonto.json file contents.
+ *
+ * @param {string} fontoJson The schema fonto.json contents.
+ *
+ * @throws If the schema fonto Json is invalid.
+ */
+export function validateSchemaFontoJson(fontoJson) {
+	if (!fontoJson.rootSchemas) {
+		throw new Error('Missing "rootSchemas" property in fonto.json.');
+	}
+
+	if (
+		typeof fontoJson.rootSchemas !== 'object' ||
+		Array.isArray(fontoJson.rootSchemas)
+	) {
+		throw new Error(
+			'The "rootSchemas" property is not an object in fonto.json.'
+		);
+	}
+
+	const xsdPaths = Object.keys(fontoJson.rootSchemas);
+	const requireLocations = xsdPaths.length > 1;
+	xsdPaths.forEach((xsdPath) => {
+		const schemaPackage = fontoJson.rootSchemas[xsdPath];
+
+		if (typeof schemaPackage !== 'object' || Array.isArray(schemaPackage)) {
+			throw new Error(
+				`Root schema "${xsdPath}" is not an object in fonto.json.`
+			);
+		}
+
+		if (!schemaPackage.packageName) {
+			throw new Error(
+				`Root schema "${xsdPath}" does not have a valid "packageName" property in fonto.json.`
+			);
+		}
+
+		// If there are multiple root schemas, the location property is required.
+		if (
+			requireLocations &&
+			(!schemaPackage.locations || !schemaPackage.locations.length)
+		) {
+			const error = new Error(
+				!schemaPackage.locations
+					? `Root schema "${xsdPath}" is missing the "locations" property, which is required when having multipe root schemas in fonto.json.`
+					: `Root schema "${xsdPath}" has an empty "locations" property, which is not allowed when having multipe root schemas in fonto.json.`
+			);
+
+			const solution = [
+				'Make sure to set locations for each schema in fonto.json when having multipe root schemas.',
+				'See: https://documentation.fontoxml.com/latest/schema-experiences-7d818ffb9db5',
+			];
+
+			error.solution = solution.join(os.EOL);
+			throw error;
+		}
+
+		// Validate the locations property, if there is any.
+		if (
+			schemaPackage.locations &&
+			(!Array.isArray(schemaPackage.locations) ||
+				schemaPackage.locations.some(
+					(schemaLocation) =>
+						typeof schemaLocation !== 'string' || !schemaLocation
+				))
+		) {
+			throw new Error(
+				`Root schema "${xsdPath}" has an invalid "locations" property in fonto.json.`
+			);
+		}
+	});
+}
+
 /**
  * Get the schema fonto.json file contents.
  *
@@ -10,7 +84,7 @@ import path from 'path';
  * @return {Promise<Object>} Returns the contents of fonto.json.
  *
  * @async
- * @throws If the required directory or files do not exist.
+ * @throws If the required directory or files do not exist or the schema fonto json is invalid.
  */
 export default async function getSchemaFontoJson(inputPath) {
 	if (!inputPath) {
@@ -38,53 +112,7 @@ export default async function getSchemaFontoJson(inputPath) {
 		throw new Error('The required fonto.json could not be parsed.');
 	}
 
-	if (!fontoJson.rootSchemas) {
-		throw new Error('Missing rootSchemas property in fonto.json.');
-	}
-
-	const xsdPaths = Object.keys(fontoJson.rootSchemas);
-	xsdPaths.forEach((xsdPath) => {
-		const schemaPackage = fontoJson.rootSchemas[xsdPath];
-		if (!schemaPackage.packageName) {
-			throw new Error(
-				`Root schema "${xsdPath}" has no package name in fonto.json.`
-			);
-		}
-
-		if (
-			schemaPackage.locations &&
-			(!Array.isArray(schemaPackage.locations) ||
-				schemaPackage.locations.some(
-					(schemaLocation) => typeof schemaLocation !== 'string'
-				))
-		) {
-			throw new Error(
-				`Root schema "${xsdPath}" has invalid locations in fonto.json.`
-			);
-		}
-
-		// In case of referencing multiple schemas, verify that each has valid locations.
-		if (
-			xsdPaths.length > 1 &&
-			(!schemaPackage.locations ||
-				!schemaPackage.locations.length ||
-				schemaPackage.locations.some(
-					(schemaLocation) => !schemaLocation
-				))
-		) {
-			const error = new Error(
-				'One or more schemas in fonto.json do not have valid locations associated.'
-			);
-
-			const solution = [
-				'Make sure to set locations for each schema in fonto.json.',
-				'See: https://documentation.fontoxml.com/latest/schema-experiences-7d818ffb9db5',
-			];
-
-			error.solution = solution.join(os.EOL);
-			throw error;
-		}
-	});
+	validateSchemaFontoJson(fontoJson);
 
 	return fontoJson;
 }