@fontoxml/fontoxml-development-tools 3.7.0-beta.7 → 3.8.0

package/src/modules/editor/dev-cms/connectors-cms-standard/review-annotations/AnnotationDatabase.js

@@ -1,11 +1,14 @@
-'use strict';
+import { v4 as uuid } from 'uuid';
 
-const { v4: uuid } = require('uuid');
-
-const Result = require('./Result');
+import Result, {
+	STATUS_CREATED,
+	STATUS_NOT_FOUND,
+	STATUS_OK,
+	STATUS_OUT_OF_SYNC,
+} from './Result.js';
 
 const DATABASE_FILE_NAME = 'review-annotations-database.json';
-const STATUS_RESOLVED = 'resolved';
+export const STATUS_RESOLVED = 'resolved';
 
 /**
  * Helper function to find a given annotation in a given database. It will look up the annotation
@@ -81,7 +84,7 @@ class MutexLock {
 	}
 }
 
-class AnnotationDatabase {
+export default class AnnotationDatabase {
 	constructor(config) {
 		this._config = config;
 		this._didWarnAboutFilterProperty = false;
@@ -172,21 +175,13 @@ class AnnotationDatabase {
 					annotationId
 				);
 				if (!annotationInDatabase) {
-					return new Result(
-						Result.STATUS_NOT_FOUND,
-						annotationId,
-						null
-					);
+					return new Result(STATUS_NOT_FOUND, annotationId, null);
 				}
 
 				if (
 					annotationInDatabase.status === 'ANNOTATION_STATUS_ARCHIVED'
 				) {
-					return new Result(
-						Result.STATUS_NOT_FOUND,
-						annotationId,
-						null
-					);
+					return new Result(STATUS_NOT_FOUND, annotationId, null);
 				}
 
 				annotationInDatabase.replies =
@@ -195,7 +190,7 @@ class AnnotationDatabase {
 					);
 
 				return new Result(
-					Result.STATUS_OK,
+					STATUS_OK,
 					annotationInDatabase.id,
 					annotationInDatabase
 				);
@@ -251,21 +246,13 @@ class AnnotationDatabase {
 					annotationId
 				);
 				if (!annotationInDatabase) {
-					return new Result(
-						Result.STATUS_NOT_FOUND,
-						annotationId,
-						null
-					);
+					return new Result(STATUS_NOT_FOUND, annotationId, null);
 				}
 
 				if (
 					annotationInDatabase.status === 'ANNOTATION_STATUS_ARCHIVED'
 				) {
-					return new Result(
-						Result.STATUS_NOT_FOUND,
-						annotationId,
-						null
-					);
+					return new Result(STATUS_NOT_FOUND, annotationId, null);
 				}
 
 				if (
@@ -274,11 +261,7 @@ class AnnotationDatabase {
 						annotationToEdit
 					)
 				) {
-					return new Result(
-						Result.STATUS_OUT_OF_SYNC,
-						annotationId,
-						null
-					);
+					return new Result(STATUS_OUT_OF_SYNC, annotationId, null);
 				}
 
 				// Generate a new revision ID for this annotation
@@ -301,11 +284,7 @@ class AnnotationDatabase {
 				database.annotations[
 					database.annotations.indexOf(annotationInDatabase)
 				] = annotationToEdit;
-				return new Result(
-					Result.STATUS_OK,
-					annotationId,
-					annotationToEdit
-				);
+				return new Result(STATUS_OK, annotationId, annotationToEdit);
 			});
 
 			return this._updateDatabase(cms, currentSession, database).then(
@@ -401,19 +380,15 @@ class AnnotationDatabase {
 				annotationIdentifier.id
 			);
 			if (!annotation) {
-				return new Result(Result.STATUS_NOT_FOUND, replyToAdd.id, null);
+				return new Result(STATUS_NOT_FOUND, replyToAdd.id, null);
 			}
 
 			if (annotation.status === 'ANNOTATION_STATUS_ARCHIVED') {
-				return new Result(Result.STATUS_NOT_FOUND, replyToAdd.id, null);
+				return new Result(STATUS_NOT_FOUND, replyToAdd.id, null);
 			}
 
 			if (isAnnotationOutOfSync(annotation, annotationIdentifier)) {
-				return new Result(
-					Result.STATUS_OUT_OF_SYNC,
-					replyToAdd.id,
-					null
-				);
+				return new Result(STATUS_OUT_OF_SYNC, replyToAdd.id, null);
 			}
 
 			replyToAdd.author = {
@@ -429,7 +404,7 @@ class AnnotationDatabase {
 			return this._updateDatabase(cms, currentSession, database).then(
 				() =>
 					new Result(
-						Result.STATUS_CREATED,
+						STATUS_CREATED,
 						replyToAdd.id,
 						replyToAdd,
 						annotation.revisionId
@@ -454,27 +429,15 @@ class AnnotationDatabase {
 				annotationIdentifier.id
 			);
 			if (!annotation) {
-				return new Result(
-					Result.STATUS_NOT_FOUND,
-					replyToEdit.id,
-					null
-				);
+				return new Result(STATUS_NOT_FOUND, replyToEdit.id, null);
 			}
 
 			if (annotation.status === 'ANNOTATION_STATUS_ARCHIVED') {
-				return new Result(
-					Result.STATUS_NOT_FOUND,
-					replyToEdit.id,
-					null
-				);
+				return new Result(STATUS_NOT_FOUND, replyToEdit.id, null);
 			}
 
 			if (isAnnotationOutOfSync(annotation, annotationIdentifier)) {
-				return new Result(
-					Result.STATUS_OUT_OF_SYNC,
-					replyToEdit.id,
-					null
-				);
+				return new Result(STATUS_OUT_OF_SYNC, replyToEdit.id, null);
 			}
 
 			annotation.replies = annotation.replies.map((reply) => {
@@ -490,7 +453,7 @@ class AnnotationDatabase {
 			return this._updateDatabase(cms, currentSession, database).then(
 				() =>
 					new Result(
-						Result.STATUS_OK,
+						STATUS_OK,
 						replyToEdit.id,
 						replyToEdit,
 						annotation.revisionId
@@ -499,6 +462,3 @@ class AnnotationDatabase {
 		});
 	}
 }
-
-module.exports = AnnotationDatabase;
-module.exports.STATUS_RESOLVED = STATUS_RESOLVED;

package/src/modules/editor/dev-cms/connectors-cms-standard/review-annotations/DebuggingConfiguration.js

@@ -1,8 +1,6 @@
 const DEBUG_FILE_NAME = 'review-annotations-debug.json';
 
 class DebugConfiguration {
-	constructor() {}
-
 	_getDebuggingFile(cms, editSessionToken) {
 		if (!cms.existsSync(DEBUG_FILE_NAME)) {
 			return Promise.resolve({
@@ -95,4 +93,4 @@ class DebugConfiguration {
 	}
 }
 
-module.exports = DebugConfiguration;
+export default DebugConfiguration;

package/src/modules/editor/dev-cms/connectors-cms-standard/review-annotations/EarlyReturnSymbol.js

@@ -1 +1 @@
-module.exports = Symbol('EARLY_RETURN');
+export default Symbol('EARLY_RETURN');

package/src/modules/editor/dev-cms/connectors-cms-standard/review-annotations/Result.js

@@ -1,11 +1,11 @@
-const STATUS_OK = 'ok';
-const STATUS_NOT_FOUND = 'not_found';
-const STATUS_FORBIDDEN = 'forbidden';
-const STATUS_OUT_OF_SYNC = 'out_of_sync';
-const STATUS_CREATED = 'created';
+export const STATUS_OK = 'ok';
+export const STATUS_NOT_FOUND = 'not_found';
+export const STATUS_FORBIDDEN = 'forbidden';
+export const STATUS_OUT_OF_SYNC = 'out_of_sync';
+export const STATUS_CREATED = 'created';
 
 // TODO: Implement this properly. i.e. Create a separate Reply & Annotation result class instead of reusing this. Annotations don't need the revisionId property.
-class Result {
+export default class Result {
 	constructor(status, annotationId, annotation, revisionId = null) {
 		this.status = status;
 		this.annotationId = annotationId;
@@ -13,11 +13,3 @@ class Result {
 		this.revisionId = revisionId;
 	}
 }
-
-module.exports = Result;
-
-module.exports.STATUS_OK = STATUS_OK;
-module.exports.STATUS_NOT_FOUND = STATUS_NOT_FOUND;
-module.exports.STATUS_FORBIDDEN = STATUS_FORBIDDEN;
-module.exports.STATUS_OUT_OF_SYNC = STATUS_OUT_OF_SYNC;
-module.exports.STATUS_CREATED = STATUS_CREATED;

package/src/modules/editor/dev-cms/connectors-cms-standard/review-annotations/httpStatusCodeHelpers.js

@@ -1,4 +1,10 @@
-const Result = require('./Result');
+import {
+	STATUS_CREATED,
+	STATUS_FORBIDDEN,
+	STATUS_NOT_FOUND,
+	STATUS_OK,
+	STATUS_OUT_OF_SYNC,
+} from './Result.js';
 
 function getDebugHttpStatusCode(stringToVerify, allowedStatusCodes) {
 	const regexResult = /HTTP-([0-9]{3})(?:-(on-delete))?/g.exec(
@@ -29,15 +35,15 @@ function getDebugHttpStatusCode(stringToVerify, allowedStatusCodes) {
  */
 function mapAnnotationResultStatusToHttpStatusCode(status, hasContent) {
 	switch (status) {
-		case Result.STATUS_OK:
+		case STATUS_OK:
 			return hasContent ? 200 : 204;
-		case Result.STATUS_CREATED:
+		case STATUS_CREATED:
 			return 201;
-		case Result.STATUS_FORBIDDEN:
+		case STATUS_FORBIDDEN:
 			return 403;
-		case Result.STATUS_NOT_FOUND:
+		case STATUS_NOT_FOUND:
 			return 404;
-		case Result.STATUS_OUT_OF_SYNC:
+		case STATUS_OUT_OF_SYNC:
 			return 412;
 		default:
 			return 500;
@@ -55,7 +61,7 @@ function sendDebugHttpResponse(res, foundHttpStatusCode) {
 	res.status(httpStatusCode).end();
 }
 
-module.exports = {
+export default {
 	getDebugHttpStatusCode,
 	mapAnnotationResultStatusToHttpStatusCode,
 	sendDebugHttpResponse,

package/src/modules/editor/dev-cms/connectors-cms-standard/review-annotations/mapAnnotationResult.js

@@ -1,4 +1,4 @@
-const httpStatusCodeHelpers = require('./httpStatusCodeHelpers');
+import httpStatusCodeHelpers from './httpStatusCodeHelpers.js';
 
 /**
  * Maps the annotation result objects to objects that can be parsed by the client.
@@ -6,7 +6,7 @@ const httpStatusCodeHelpers = require('./httpStatusCodeHelpers');
  * @param  {Result} result
  * @return {object}
  */
-function mapAnnotationResultToAnnotationToReturn(result) {
+export default function mapAnnotationResultToAnnotationToReturn(result) {
 	return {
 		status: httpStatusCodeHelpers.mapAnnotationResultStatusToHttpStatusCode(
 			result.status,
@@ -17,5 +17,3 @@ function mapAnnotationResultToAnnotationToReturn(result) {
 			: { id: result.annotationId },
 	};
 }
-
-module.exports = mapAnnotationResultToAnnotationToReturn;

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

@@ -1,9 +1,9 @@
-const FileSystemStore = require('./FileSystemStore');
-const HistoryStore = require('./HistoryStore');
-const MemoryStore = require('./MemoryStore');
-const mergeItems = require('./mergeItems');
+import FileSystemStore from './FileSystemStore.js';
+import HistoryStore from './HistoryStore.js';
+import MemoryStore from './MemoryStore.js';
+import mergeItems from './mergeItems.js';
 
-module.exports = class DevelopmentCms {
+export default class DevelopmentCms {
 	/**
 	 * @param  {Object}  config
 	 */
@@ -231,4 +231,4 @@ module.exports = class DevelopmentCms {
 			callback
 		);
 	}
-};
+}

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

@@ -1,8 +1,8 @@
-const fs = require('fs-extra');
-const path = require('path');
-const utf8 = require('to-utf-8');
+import fs from 'fs-extra';
+import path from 'path';
+import utf8 from 'to-utf-8';
 
-const mergeItems = require('./mergeItems');
+import mergeItems from './mergeItems.js';
 
 /**
  * File extensions to use for specific fileType requests.
@@ -30,7 +30,7 @@ const ASSET_TYPE_BY_EXTENSION = {
 	ogg: 'audio',
 };
 
-module.exports = class FileSystemStore {
+export default class FileSystemStore {
 	constructor(config) {
 		this._filesRootPath = path.join(config.root, 'dev-cms', 'files');
 		this._uploadsRootPath = path.join(config.root, 'dev-cms', 'uploads');
@@ -179,4 +179,4 @@ module.exports = class FileSystemStore {
 
 		return mergeItems(filesItems, uploadsItems);
 	}
-};
+}

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

@@ -1,7 +1,8 @@
-const path = require('path');
-const { v4: uuid } = require('uuid');
-const getFileHash = require('../getFileHash');
-const unmergeableRevisionList = require('./unmergeableRevisionList');
+import path from 'path';
+import { v4 as uuid } from 'uuid';
+
+import getFileHash from '../getFileHash.js';
+import unmergeableRevisionList from './unmergeableRevisionList.js';
 
 function saveHistoryDocument(
 	saveToStore,
@@ -16,7 +17,7 @@ function saveHistoryDocument(
 	saveToStore(historyDocumentId, json, editSessionToken, callback);
 }
 
-module.exports = class HistoryStore {
+export default class HistoryStore {
 	constructor(cms) {
 		this._cms = cms;
 	}
@@ -321,4 +322,4 @@ module.exports = class HistoryStore {
 			}
 		);
 	}
-};
+}

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

@@ -1,6 +1,6 @@
-const path = require('path');
+import path from 'path';
 
-module.exports = class MemoryStore {
+export default class MemoryStore {
 	constructor() {
 		this._documentById = Object.create(null);
 	}
@@ -45,4 +45,4 @@ module.exports = class MemoryStore {
 		);
 		return items.length ? items : null;
 	}
-};
+}

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

@@ -1,4 +1,4 @@
-module.exports = function mergeItems(...lists) {
+export default function mergeItems(...lists) {
 	const itemById = lists.reduce((byId, list) => {
 		if (list) {
 			for (const item of list) {
@@ -9,4 +9,4 @@ module.exports = function mergeItems(...lists) {
 	}, {});
 
 	return Object.keys(itemById).map((id) => itemById[id]);
-};
+}

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

@@ -1 +1 @@
-module.exports = new Set();
+export default new Set();

package/src/modules/editor/dev-cms/connectors-dist/configureAuthMiddleware.js

@@ -1,10 +1,8 @@
-'use strict';
+import fs from 'fs';
+import auth from 'http-auth';
+import path from 'path';
 
-const auth = require('http-auth');
-const fs = require('fs');
-const path = require('path');
-
-const correlationIdRepository = require('../connectors-cms-standard/correlationIdRepository');
+import correlationIdRepository from '../connectors-cms-standard/correlationIdRepository.js';
 
 /**
  * Basic authentication middleware.
@@ -13,7 +11,7 @@ const correlationIdRepository = require('../connectors-cms-standard/correlationI
  *
  * @return {function(req, res, next)}
  */
-module.exports = (config) => {
+export default (config) => {
 	const passwordFilePath = path.join(config.root, 'users.htpasswd');
 	if (config.distAuth && !fs.existsSync(passwordFilePath)) {
 		throw new Error(

package/src/modules/editor/dev-cms/connectors-dist/createMiddleware.js

@@ -1,9 +1,7 @@
-'use strict';
+import express from 'express';
+import path from 'path';
 
-const express = require('express');
-const path = require('path');
-
-const configureAuthMiddleware = require('./configureAuthMiddleware');
+import configureAuthMiddleware from './configureAuthMiddleware.js';
 
 /**
  * Staticly serve the `dist` directory in `config.root`.
@@ -12,7 +10,7 @@ const configureAuthMiddleware = require('./configureAuthMiddleware');
  *
  * @return {function(req, res, next)[]}
  */
-function createMiddleware(config) {
+export default function createMiddleware(config) {
 	return [
 		...(config.distAuth ? [configureAuthMiddleware(config)] : []),
 		express.static(path.join(config.root, 'dist'), {
@@ -21,5 +19,3 @@ function createMiddleware(config) {
 		}),
 	];
 }
-
-module.exports = createMiddleware;

package/src/modules/editor/dev-cms/connectors-health/configureConnectorsHealthRouter.js

@@ -1,18 +1,14 @@
-'use strict';
+import express from 'express';
 
-const express = require('express');
+import configureHealthGetRouteHandler from './configureHealthGetRouteHandler.js';
 
 // eslint-disable-next-line new-cap
 const connectorsConnectorsHealthRouter = express.Router();
 
-const configureHealthGetRouteHandler = require('./configureHealthGetRouteHandler');
-
-function configureConnectorsHealthRouter() {
+export default function configureConnectorsHealthRouter() {
 	connectorsConnectorsHealthRouter
 		.route('/connectors/health')
 		.get(configureHealthGetRouteHandler());
 
 	return connectorsConnectorsHealthRouter;
 }
-
-module.exports = configureConnectorsHealthRouter;

package/src/modules/editor/dev-cms/connectors-health/configureHealthGetRouteHandler.js

@@ -1,14 +1,10 @@
-'use strict';
-
 /**
  * configureHealthGetRouteHandler
  *
  * @return {function(req, res, next)}
  */
-function configureHealthGetRouteHandler() {
+export default function configureHealthGetRouteHandler() {
 	return (_req, res, _next) => {
 		res.status(200).json({ ok: true });
 	};
 }
-
-module.exports = configureHealthGetRouteHandler;

package/src/modules/editor/dev-cms/connectors-health/createMiddleware.js

@@ -1,14 +1,10 @@
-'use strict';
-
-const configureConnectorsHealthRouter = require('./configureConnectorsHealthRouter');
+import configureConnectorsHealthRouter from './configureConnectorsHealthRouter.js';
 
 /**
  * Additional health endpoint for monitoring purposes.
  *
  * @return {function(req, res, next)[]}
  */
-function createMiddleware() {
+export default function createMiddleware() {
 	return [configureConnectorsHealthRouter()];
 }
-
-module.exports = createMiddleware;

package/src/modules/editor/dev-cms/setupDevCms.js

@@ -1,25 +1,26 @@
-'use strict';
-
-const express = require('express');
-const fs = require('fs-extra');
-const path = require('path');
-
-const configureFontoSessionMiddleware = require('./configureFontoSessionMiddleware');
-const configureScopeMiddleware = require('./configureScopeMiddleware');
-
-const connectorsDistCreateMiddleware = require('./connectors-dist/createMiddleware');
-const connectorsCmsStandardCreateMiddleware = require('./connectors-cms-standard/createMiddleware');
-const connectorsHealthCreateMiddleware = require('./connectors-health/createMiddleware');
-
-function setupDevCms(config) {
+import express from 'express';
+import fs from 'fs-extra';
+import path from 'path';
+import { pathToFileURL } from 'url';
+
+import configureFontoSessionMiddleware from './configureFontoSessionMiddleware.js';
+import configureScopeMiddleware from './configureScopeMiddleware.js';
+import connectorsCmsStandardCreateMiddleware from './connectors-cms-standard/createMiddleware.js';
+import connectorsDistCreateMiddleware from './connectors-dist/createMiddleware.js';
+import connectorsHealthCreateMiddleware from './connectors-health/createMiddleware.js';
+
+export default async function setupDevCms(config) {
 	const configureDevCmsPath = path.resolve(
 		config.root,
-		'dev-cms/configureDevCms.js'
+		'dev-cms',
+		'configureDevCms.js'
 	);
 	let devCmsConfig = {};
 
 	if (fs.existsSync(configureDevCmsPath)) {
-		devCmsConfig = require(configureDevCmsPath)(express.Router(), config);
+		devCmsConfig = (
+			await import(pathToFileURL(configureDevCmsPath))
+		).default(express.Router(), config);
 	}
 
 	config.reviewAnnotationFilter = devCmsConfig.reviewAnnotationFilter || null;
@@ -32,5 +33,3 @@ function setupDevCms(config) {
 		...connectorsCmsStandardCreateMiddleware(config, devCmsConfig.routes),
 	];
 }
-
-module.exports = setupDevCms;

package/src/modules/editor/index.js

@@ -1,6 +1,14 @@
-'use strict';
-
-module.exports = (moduleRegistration) => {
+import commandAddons from '../editor-pre-7-7-0/src/command.addons.js';
+import commandInit from '../editor-pre-7-7-0/src/command.init.js';
+import commandSchemaCompile from '../editor-pre-7-7-0/src/command.schema.compile.js';
+import commandUpgrade from '../editor-pre-7-7-0/src/command.upgrade.js';
+import commandVersions from '../editor-pre-7-7-0/src/command.versions.js';
+import commandBuild from './src/commands/command.build.js';
+import commandConvertEditor from './src/commands/command.convert.editor.js';
+import commandConvertPackage from './src/commands/command.convert.package.js';
+import commandRun from './src/commands/command.run.js';
+
+export default (moduleRegistration) => {
 	const editorCommand = moduleRegistration
 		.registerCommand('editor')
 		.setDescription(
@@ -11,20 +19,12 @@ module.exports = (moduleRegistration) => {
 		.setHideIfMissingRequiredProductLicenses()
 		.setAsHelpCommand();
 
-	// Editor commands
-	[
-		// Platform SDK
-		require('../editor-pre-7-7-0/src/command.addons.js'),
-		require('../editor-pre-7-7-0/src/command.init.js'),
-		require('../editor-pre-7-7-0/src/command.upgrade.js'),
-
-		// Building and running
-		require('./src/commands/command.build.js'),
-		require('./src/commands/command.run.js'),
-
-		// Informative
-		require('../editor-pre-7-7-0/src/command.versions.js'),
-	].forEach((mod) => mod(moduleRegistration, editorCommand));
+	commandAddons(moduleRegistration, editorCommand);
+	commandInit(moduleRegistration, editorCommand);
+	commandUpgrade(moduleRegistration, editorCommand);
+	commandBuild(moduleRegistration, editorCommand);
+	commandRun(moduleRegistration, editorCommand);
+	commandVersions(moduleRegistration, editorCommand);
 
 	// Editor convert commands
 	const convertCommand = editorCommand
@@ -34,10 +34,8 @@ module.exports = (moduleRegistration) => {
 		)
 		.setAsHelpCommand();
 
-	[
-		require('./src/commands/command.convert.editor.js'),
-		require('./src/commands/command.convert.package.js'),
-	].forEach((mod) => mod(moduleRegistration, convertCommand));
+	commandConvertEditor(moduleRegistration, convertCommand);
+	commandConvertPackage(moduleRegistration, convertCommand);
 
 	// Editor schema commands
 	const schemaCommand = editorCommand
@@ -45,7 +43,5 @@ module.exports = (moduleRegistration) => {
 		.setDescription('Tools for compiling the schema.')
 		.setAsHelpCommand();
 
-	[require('../editor-pre-7-7-0/src/command.schema.compile.js')].forEach(
-		(mod) => mod(moduleRegistration, schemaCommand)
-	);
+	commandSchemaCompile(moduleRegistration, schemaCommand);
 };

package/src/modules/editor/package.json

@@ -9,5 +9,6 @@
 		"fonto",
 		"fontoxml"
 	],
-	"main": "index.js"
+	"main": "index.js",
+	"type": "module"
 }