@fontoxml/fontoxml-development-tools 3.9.0-beta.2 → 3.9.0-beta.5

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

@@ -36,8 +36,8 @@ async function createPackageManifestJsonFile(packageDirectoryPath) {
  * Create the schema file for a specific package.
  *
  * @param {string} packageDirectoryPath The path to a single package directory.
- * @param {string} packageName The package name.
- * @param {Object} schemaData The schema data for this package.
+ * @param {string} packageName          The package name.
+ * @param {Object} schemaData           The schema data for this package.
  *
  * @return {Promise}
  */
@@ -58,25 +58,27 @@ async function createPackageSchemaJsonFile(
 }
 
 /**
- * Create the SCHEMA_LOCATIONS.js file for a specific package.
+ * Create the SCHEMA_LOCATIONS.ts/js file for a specific package.
  *
- * @param {string} packageDirectoryPath The path to a single package directory.
- * @param {Array<string>} schemaLocations An array of schema locations for this package.
+ * @param {string}        packageDirectoryPath The path to a single package directory.
+ * @param {Array<string>} schemaLocations      An array of schema locations for this package.
+ * @param {boolean}       useTypeScript        Output TypeScript instead of JavaScript.
  *
  * @return {Promise}
  */
 async function createPackageSchemaLocationsJsFile(
 	packageDirectoryPath,
-	schemaLocations = []
+	schemaLocations = [],
+	useTypeScript
 ) {
-	const t = babel.types;
-	// @TODO: @TS: Remove file extensions from imports in generated imports when
-	// supporting TS configuration.
-	const schemaLocationsJsFilePath = path.join(
+	const { types: t } = babel;
+
+	const schemaLocationsFilePath = path.join(
 		packageDirectoryPath,
 		'src',
-		'SCHEMA_LOCATIONS.js'
+		`SCHEMA_LOCATIONS${useTypeScript ? '.ts' : '.js'}`
 	);
+
 	const schemaLocationsJsAst = t.program([
 		t.exportDefaultDeclaration(
 			t.arrayExpression(
@@ -86,19 +88,18 @@ async function createPackageSchemaLocationsJsFile(
 			)
 		),
 	]);
-	await writeAstProgramToFile(
-		schemaLocationsJsFilePath,
-		schemaLocationsJsAst
-	);
+
+	await writeAstProgramToFile(schemaLocationsFilePath, schemaLocationsJsAst);
 }
 
 /**
  * Create a schema package from a compiled schema.
  *
- * @param {string} outputPath The path of the Fonto Editor, or the schema source directory.
- * @param {Object} schemaPackagesByXsdPath The package information by xsd path.
- * @param {Object} compiledSchemaResultsByXsdPath The compiled schema for a package by xsd path.
- * @param {string} xsdPath The path of the xsd file for this package.
+ * @param {string}  outputPath                     The path of the Fonto Editor, or the schema source directory.
+ * @param {Object}  schemaPackagesByXsdPath        The package information by xsd path.
+ * @param {Object}  compiledSchemaResultsByXsdPath The compiled schema for a package by xsd path.
+ * @param {string}  xsdPath                        The path of the xsd file for this package.
+ * @param {boolean} useTypeScript                  Output TypeScript instead of JavaScript.
  *
  * @return {Promise}
  */
@@ -106,7 +107,8 @@ async function createSchemaPackageFromCompiledSchemaResults(
 	outputPath,
 	schemaPackagesByXsdPath,
 	compiledSchemaResultsByXsdPath,
-	xsdPath
+	xsdPath,
+	useTypeScript
 ) {
 	// Resolve the schema package directory path.
 	const schemaPackage = schemaPackagesByXsdPath[xsdPath];
@@ -124,7 +126,8 @@ async function createSchemaPackageFromCompiledSchemaResults(
 		),
 		await createPackageSchemaLocationsJsFile(
 			schemaPackageDirectoryPath,
-			schemaPackage.locations
+			schemaPackage.locations,
+			useTypeScript
 		),
 	]);
 }
@@ -133,16 +136,18 @@ async function createSchemaPackageFromCompiledSchemaResults(
  * Create all schema packages, will also create the fonto-manifest.json file when the package
  * directory does not yet exists.
  *
- * @param {string} outputPath The path of the Fonto Editor, or the schema source directory.
- * @param {Object} schemaPackagesByXsdPath The package information by xsd path.
- * @param {Object} compiledSchemaResultsByXsdPath The compiled schema for a package by xsd path.
+ * @param {string}  outputPath                     The path of the Fonto Editor, or the schema source directory.
+ * @param {Object}  schemaPackagesByXsdPath        The package information by xsd path.
+ * @param {Object}  compiledSchemaResultsByXsdPath The compiled schema for a package by xsd path.
+ * @param {boolean} useTypeScript                  Output TypeScript instead of JavaScript.
  *
  * @return {Promise}
  */
 export default async function createSchemaPackages(
 	outputPath,
 	schemaPackagesByXsdPath,
-	compiledSchemaResultsByXsdPath
+	compiledSchemaResultsByXsdPath,
+	useTypeScript
 ) {
 	await Promise.all(
 		Object.keys(schemaPackagesByXsdPath).map((xsdPath) => {
@@ -150,7 +155,8 @@ export default async function createSchemaPackages(
 				path.resolve(outputPath),
 				schemaPackagesByXsdPath,
 				compiledSchemaResultsByXsdPath,
-				xsdPath
+				xsdPath,
+				useTypeScript
 			);
 		})
 	);

package/src/modules/editor-pre-7-7-0/src/command.init.controller.js

@@ -4,7 +4,7 @@ import path from 'path';
 import unzipper from 'unzipper';
 import { fileURLToPath } from 'url';
 
-import { isNightly, isPre770Editor } from '../../../editorVersions.js';
+import { isNightly } from '../../../editorVersions.js';
 import addonsAddDependencies from './api/addonsAddDependencies.js';
 import createMessageTemplate from './api/createMessageTemplate.js';
 import downloadEditorSDK from './api/downloadEditorSDK.js';
@@ -117,6 +117,14 @@ export default async function editorInitCommand(req, res) {
 		destroySpinner();
 	}
 
+	// Do not initialise with TypeScript when no tsconfig.json is found.
+	const platformHasTsConfig = sdkFiles.some(
+		(file) => file.path === 'tsconfig.json'
+	);
+	const useTypeScript = req.options['output-javascript']
+		? false
+		: platformHasTsConfig;
+
 	// Set the sdkVersion to the actual version, for nightlies it's sets to the specific nightly version string instead of 'nightly'.
 	sdkVersion = sdkManifest.version;
 
@@ -274,15 +282,12 @@ export default async function editorInitCommand(req, res) {
 		return;
 	}
 
-	// @TODO: @TS: Remove file extensions from imports in template files when
-	// supporting TS configuration.
-
 	// Copy the Fonto Editor instance template.
 	destroySpinner = res.spinner('Setting up a new Fonto Editor instance...');
 	const templateDirectoryPath = path.join(
 		__dirname,
 		'..',
-		'instanceTemplate'
+		useTypeScript ? 'instanceTemplateTypeScript' : 'instanceTemplate'
 	);
 	try {
 		await fs.copy(templateDirectoryPath, editorPath, {
@@ -308,7 +313,8 @@ export default async function editorInitCommand(req, res) {
 		await createSchemaPackages(
 			editorPath,
 			fontoJson.rootSchemas,
-			schemaCompileResults
+			schemaCompileResults,
+			useTypeScript
 		);
 	} catch (error) {
 		throw new res.ErrorWithInnerError(
@@ -347,7 +353,8 @@ export default async function editorInitCommand(req, res) {
 			schemaCompileResults,
 			prefixByNamespaceUri,
 			addons,
-			sdkVersion
+			sdkVersion,
+			useTypeScript
 		);
 	} catch (error) {
 		throw new res.ErrorWithInnerError(
@@ -380,12 +387,12 @@ export default async function editorInitCommand(req, res) {
 		destroySpinner();
 	}
 
-	// Creating config/configuration.js.
+	// Creating config/configuration.ts/js.
 	destroySpinner = res.spinner('Creating the config configuration file...');
 	const configConfigurationPath = path.join(
 		editorPath,
 		'config',
-		'configuration.js'
+		`configuration${useTypeScript ? '.ts' : '.js'}`
 	);
 	try {
 		await createConfigConfiguration(
@@ -397,21 +404,23 @@ export default async function editorInitCommand(req, res) {
 		);
 	} catch (error) {
 		throw new res.ErrorWithInnerError(
-			'Could not create the config/configuration.js file.',
+			`Could not create the config/configuration${
+				useTypeScript ? '.ts' : '.js'
+			} file.`,
 			error
 		);
 	} finally {
 		destroySpinner();
 	}
 
-	// Creating config/schemaExperienceResolver.js.
+	// Creating config/schemaExperienceResolver.ts/js.
 	destroySpinner = res.spinner(
 		'Creating the config schema experience resolver file...'
 	);
 	const schemaExperienceResolverPath = path.join(
 		editorPath,
 		'config',
-		'schemaExperienceResolver.js'
+		`schemaExperienceResolver${useTypeScript ? '.ts' : '.js'}`
 	);
 	try {
 		await createSchemaExperienceResolver(
@@ -420,7 +429,9 @@ export default async function editorInitCommand(req, res) {
 		);
 	} catch (error) {
 		throw new res.ErrorWithInnerError(
-			'Could not create the config/schemaExperienceResolver.js file.',
+			`Could not create the config/schemaExperienceResolver${
+				useTypeScript ? '.ts' : '.js'
+			} file.`,
 			error
 		);
 	} finally {
@@ -524,10 +535,8 @@ export default async function editorInitCommand(req, res) {
 
 	destroySpinner();
 
-	// npm install.
-	if (isPre770Editor(sdkVersion)) {
-		await npmInstall(editorPath, res);
-	}
+	// Install NPM depencencies when there's a package.json.
+	await npmInstall(editorPath, res);
 
 	// Done.
 	res.break();

package/src/modules/editor-pre-7-7-0/src/command.init.js

@@ -56,6 +56,12 @@ export default (moduleRegistration, editorCommand) => {
 			'Specify the schema compiler backend base url.'
 		)
 
+		.addHiddenOption(
+			'output-javascript',
+			undefined,
+			'Generate JavaScript instead of TypeScript.'
+		)
+
 		.addOption(
 			'version',
 			undefined,

package/src/modules/editor-pre-7-7-0/src/command.upgrade.controller.js

@@ -1,6 +1,7 @@
 import fs from 'fs-extra';
 import path from 'path';
 import unzipper from 'unzipper';
+import { fileURLToPath } from 'url';
 
 import { isPre770Editor } from '../../../editorVersions.js';
 import convertEditorWithOutput from '../../editor/src/commands/api/convertEditorWithOutput.js';
@@ -18,6 +19,9 @@ import updateConfigFontoManifest from './api/upgrade/updateConfigFontoManifest.j
 import validateAddons from './api/validateAddons.js';
 import validateManifest from './api/validateManifest.js';
 
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
 export default async function editorUpgradeCommand(req, res) {
 	if (req.options['remove-backup']) {
 		// DEV-9386
@@ -308,6 +312,27 @@ export default async function editorUpgradeCommand(req, res) {
 		);
 	}
 
+	// Set up code intelligence if there's a base tsconfig.json and it hasn't
+	// been set up yet.
+	const platformHasTsConfig = await fs.pathExists(
+		path.join(editorPath, 'platform', 'tsconfig.json')
+	);
+	if (platformHasTsConfig) {
+		await fs.copy(
+			path.resolve(
+				__dirname,
+				'..',
+				'instanceTemplateTypeScript',
+				'tsconfig.json'
+			),
+			path.resolve(editorPath, 'tsconfig.json'),
+			{
+				// Silently fail when target already exists.
+				overwrite: false,
+			}
+		);
+	}
+
 	await req.fdt.license.sendTelemetry({
 		product: req.command.parent.name,
 		type: 'selfContained',

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

@@ -1,29 +0,0 @@
-function configureAssetGetRouteHandler(config) {
-	return (req, res) => {
-		const editSessionToken =
-			req.query &&
-			req.query.context &&
-			JSON.parse(req.query.context).editSessionToken;
-
-		let id = req.query.id;
-		if (id && id.indexOf('..') !== -1) {
-			res.status(403).end();
-			return;
-		}
-
-		// Strip assets and /assets prefixes
-		id = id.replace(/^\/?assets/g, '');
-
-		const filePath = req.cms.getPath(id, editSessionToken);
-		if (filePath) {
-			res.sendFile(filePath, {
-				cacheControl: !config.cacheControlDisabled,
-				maxAge: config.cacheControlMaxAge,
-			});
-		} else {
-			res.status(404).end();
-		}
-	};
-}
-
-export default configureAssetGetRouteHandler;

package/src/modules/editor/src/templates/app-entry.cjs

@@ -1,69 +0,0 @@
-(function appEntry() {
-	return Promise.resolve()
-		.then(function () {
-			window.startFontoBootstrap();
-
-			require('fontoxml-shims/src/main');
-
-			const glamor = require('glamor');
-			glamor.styleSheet.maxLength = 4;
-			glamor.plugins.remove(
-				glamor.plugins.fns.find(function (pluginFn) {
-					return pluginFn.name === 'prefixes';
-				})
-			);
-
-			const getQueryParameterByName =
-				require('fontoxml-utils/src/getQueryParameterByName').default;
-			const scope = getQueryParameterByName(
-				window.location.search,
-				'scope'
-			);
-			const configurationManager =
-				require('fontoxml-configuration/src/configurationManager').default;
-			configurationManager.set('scope', scope ? JSON.parse(scope) : {});
-			configurationManager.set(
-				'version-info',
-				require('./generated?type=versionInfo').default
-			);
-			configurationManager.set(
-				'fonto-debug-build',
-				require('./generated?type=debugBuild').default
-			);
-
-			require('./generated?type=styles');
-
-			require('./generated?type=setDefaultConfiguration');
-
-			require('config/configuration');
-
-			return configurationManager.applyDefaults();
-		})
-		.then(function () {
-			require('./generated?type=messages');
-
-			require('./generated?type=configureSxModule');
-
-			require('config/schemaExperienceResolver');
-
-			require('./generated?type=install');
-
-			require('react');
-			const ReactDOM = require('react-dom');
-			const renderApp = require('fontoxml-editor/src/renderApp').default;
-
-			ReactDOM.render(
-				renderApp(),
-				window.document.getElementById('index-app-root')
-			);
-
-			window.completeFontoBootstrap();
-		})
-		.catch(function (error) {
-			if (window.showFontoError) {
-				window.showFontoError(error);
-			} else {
-				throw error;
-			}
-		});
-})();