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

package/src/modules/editor-pre-7-7-0/test/api/init/fixtures/configjs-7160.js

@@ -0,0 +1,45 @@
+// This configuration file defines constants that can be used throughout the rest of your FontoXML
+// Editor configuration. You can configure existing product options, or create custom configuration
+// options. Values that you set here may be either a value or an asynchronous promise to a value,
+// and can be used in other files by importing the configurationManager and using
+// configurationManager.get().
+// For more information:
+// https://documentation.fontoxml.com/latest/configurationmanager-3e0d8dbacb90
+import configurationManager from 'fontoxml-configuration/src/configurationManager';
+
+// Enable an experiment where, when pressing enter at the edges of elements, the cursor is prevented
+// from ending up in positions that are not reachable using the cursor keys.
+// For more information:
+// https://documentation.fontoxml.com/latest/enable-experiment-correct-selection-after-enter-8d2ce78e26b8
+configurationManager.set(
+	'enable-experiment/correct-selection-after-enter',
+	true
+);
+
+// The node name of the element that will be created for paragraphs in pasted plain-text content.
+// The configuration value is the paragraph counterpart element name.
+// Additional clipboard configuration can be found in the editor-clipboard-configuration package.
+// For more information:
+// https://documentation.fontoxml.com/latest/configure-clipboard-behavior-bc607964d3f5
+// https://documentation.fontoxml.com/latest/paragraph-node-name-for-pasting-94d4327c8363
+//
+// TODO 👉: Verify that "p" is a sensible default text container.
+// Example:
+// configurationManager.set('paragraph-node-name-for-pasting', 'p');
+
+// Set to an array of objects to determine the identifying attributes for which a GUID will be
+// generated automatically.
+// For more information:
+// https://documentation.fontoxml.com/latest/unique-id-configurations-94fe53ca7bfb
+//
+// TODO 👉: If identifier attributes are missing, add them.
+// TODO 👉: Adjust the selector to exclude elements where identifiers are not desired.
+// Example:
+// configurationManager.set('unique-id-configurations', [
+//    {
+//        selector: 'self::*',
+//        namespaceURI: null,
+//        localName: 'id',
+//        strategy: 'unique-for-document',
+//    },
+// ]);

package/src/modules/editor-pre-7-7-0/test/api/init/fixtures/configjs-800.js

@@ -0,0 +1,45 @@
+// This configuration file defines constants that can be used throughout the rest of your FontoXML
+// Editor configuration. You can configure existing product options, or create custom configuration
+// options. Values that you set here may be either a value or an asynchronous promise to a value,
+// and can be used in other files by importing the configurationManager and using
+// configurationManager.get().
+// For more information:
+// https://documentation.fontoxml.com/latest/configurationmanager-3e0d8dbacb90
+import configurationManager from 'fontoxml-configuration/src/configurationManager';
+import xq from 'fontoxml-selectors/src/xq';
+
+// Enable an experiment where, when pressing enter at the edges of elements, the cursor is prevented
+// from ending up in positions that are not reachable using the cursor keys.
+// For more information:
+// https://documentation.fontoxml.com/latest/enable-experiment-correct-selection-after-enter-8d2ce78e26b8
+configurationManager.set(
+	'enable-experiment/correct-selection-after-enter',
+	true
+);
+
+// The node name of the element that will be created for paragraphs in pasted plain-text content.
+// The configuration value is the paragraph counterpart element name.
+// Additional clipboard configuration can be found in the editor-clipboard-configuration package.
+// For more information:
+// https://documentation.fontoxml.com/latest/configure-clipboard-behavior-bc607964d3f5
+// https://documentation.fontoxml.com/latest/paragraph-node-name-for-pasting-94d4327c8363
+//
+// TODO 👉: Verify that "p" is a sensible default text container.
+configurationManager.set('paragraph-node-name-for-pasting', 'p');
+
+// Set to an array of objects to determine the identifying attributes for which a GUID will be
+// generated automatically.
+// For more information:
+// https://documentation.fontoxml.com/latest/unique-id-configurations-94fe53ca7bfb
+//
+// TODO 👉: If identifier attributes are missing, add them.
+// TODO 👉: Adjust the selector to exclude elements where identifiers are not desired.
+// Example:
+// configurationManager.set('unique-id-configurations', [
+//    {
+//        selector: xq`self::*`,
+//        namespaceURI: null,
+//        localName: 'id',
+//        strategy: 'unique-for-document',
+//    },
+// ]);

package/src/modules/editor-pre-7-7-0/test/api/init/fixtures/configjs-810.js

@@ -0,0 +1,32 @@
+// This configuration file defines constants that can be used throughout the rest of your FontoXML
+// Editor configuration. You can configure existing product options, or create custom configuration
+// options. Values that you set here may be either a value or an asynchronous promise to a value,
+// and can be used in other files by importing the configurationManager and using
+// configurationManager.get().
+// For more information:
+// https://documentation.fontoxml.com/latest/configurationmanager-3e0d8dbacb90
+import configurationManager from 'fontoxml-configuration/src/configurationManager';
+import namespaceManager from 'fontoxml-dom-namespaces/src/namespaceManager';
+import xq from 'fontoxml-selectors/src/xq';
+
+// Set to an array of objects to determine the identifying attributes for which a GUID will be
+// generated automatically.
+// For more information:
+// https://documentation.fontoxml.com/latest/unique-id-configurations-94fe53ca7bfb
+//
+// TODO 👉: If identifier attributes are missing, add them.
+// TODO 👉: Adjust the selector to exclude elements where identifiers are not desired.
+configurationManager.set('unique-id-configurations', [
+	{
+		selector: xq`self::*`,
+		namespaceURI: null,
+		localName: 'id',
+		strategy: 'unique-for-document',
+	},
+]);
+
+// Register namespaces with prefixes.
+// For more information:
+// https://documentation.fontoxml.com/latest/namespacemanager-c80956c5d6d7
+// https://documentation.fontoxml.com/latest/namespaces-2b1bbc7b4f79
+namespaceManager.addNamespace('mml', 'http://www.w3.org/1998/Math/MathML');

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

@@ -505,93 +505,84 @@ describe('api/schema/buildSchemaExperienceConfigurationModel', () => {
 			throw new Error('No fixtures found.');
 		}
 
-		const fixturesBlacklist = [];
+		const fixturesBlacklist = ['invalid-fonto-json'];
 		fixtures.forEach((fixture) => {
-			const testFunction = fixturesBlacklist.includes(fixture)
-				? it.skip
-				: it;
-
-			testFunction(
-				`can build model for fixture "${fixture}"`,
-				async function () {
-					this.slow(500);
-
-					const fixturePath = path.join(fixturesPath, fixture);
-					const compiledSchemaFilePath = path.join(
-						fixturePath,
-						'compiledSchema.json'
-					);
-					const fontoJsonFilePath = path.join(
-						fixturePath,
-						'fonto.json'
-					);
+			if (fixturesBlacklist.includes(fixture)) {
+				return;
+			}
 
-					// Recompile the schema using the schema compiler when updating snapshots and the compiled schema does NOT exist.
-					if (
-						UPDATE_SNAPSHOTS &&
-						!(await fs
-							.access(compiledSchemaFilePath)
-							.then(() => true)
-							.catch(() => false))
-					) {
-						this.timeout(120000);
-						this.slow(60000);
-						console.warn(
-							mochaColoring(
-								'error stack',
-								`      - Compiling schema for fixture "${fixture}"...`
-							)
-						);
-						const schemaCompileResults = await compileSchema(
-							fixturePath
-						);
-						await fs.writeJson(
-							compiledSchemaFilePath,
-							schemaCompileResults
-						);
-					}
+			it(`can build model for fixture "${fixture}"`, async function () {
+				this.slow(500);
 
-					// Build the schema model.
-					const fontoJson = await fs.readJson(fontoJsonFilePath);
-					const schemaPackagesByXsdPath = fontoJson.rootSchemas;
-					const compiledSchemaResultsByXsdPath = await fs.readJson(
-						compiledSchemaFilePath
-					);
-					const prefixByNamespaceUri = getprefixByNamespaceUri(
-						compiledSchemaResultsByXsdPath
-					);
-					const result = buildSchemaExperienceConfigurationModel(
-						schemaPackagesByXsdPath,
-						compiledSchemaResultsByXsdPath,
-						prefixByNamespaceUri
-					);
+				const fixturePath = path.join(fixturesPath, fixture);
+				const compiledSchemaFilePath = path.join(
+					fixturePath,
+					'compiledSchema.json'
+				);
+				const fontoJsonFilePath = path.join(fixturePath, 'fonto.json');
 
-					// Sanity check.
-					sanityCheckResult(
-						result,
-						schemaPackagesByXsdPath,
-						compiledSchemaResultsByXsdPath
+				// Recompile the schema using the schema compiler when updating snapshots and the compiled schema does NOT exist.
+				if (
+					UPDATE_SNAPSHOTS &&
+					!(await fs
+						.access(compiledSchemaFilePath)
+						.then(() => true)
+						.catch(() => false))
+				) {
+					this.timeout(120000);
+					this.slow(60000);
+					console.warn(
+						mochaColoring(
+							'error stack',
+							`      - Compiling schema for fixture "${fixture}"...`
+						)
 					);
-
-					// Assert against snapshot, and optionally update the snapshot.
-					const serializedResult = JSON.stringify(
-						result,
-						(_key, value) => {
-							return value instanceof Map
-								? Array.from(value.entries())
-								: value instanceof Set
-								? Array.from(value)
-								: value;
-						},
-						'\t'
+					const schemaCompileResults = await compileSchema(
+						fixturePath
 					);
-					const snapshotPath = path.join(
-						fixturePath,
-						'model.out.json'
+					await fs.writeJson(
+						compiledSchemaFilePath,
+						schemaCompileResults
 					);
-					await assertFixtureSnapshot(serializedResult, snapshotPath);
 				}
-			);
+
+				// Build the schema model.
+				const fontoJson = await fs.readJson(fontoJsonFilePath);
+				const schemaPackagesByXsdPath = fontoJson.rootSchemas;
+				const compiledSchemaResultsByXsdPath = await fs.readJson(
+					compiledSchemaFilePath
+				);
+				const prefixByNamespaceUri = getprefixByNamespaceUri(
+					compiledSchemaResultsByXsdPath
+				);
+				const result = buildSchemaExperienceConfigurationModel(
+					schemaPackagesByXsdPath,
+					compiledSchemaResultsByXsdPath,
+					prefixByNamespaceUri
+				);
+
+				// Sanity check.
+				sanityCheckResult(
+					result,
+					schemaPackagesByXsdPath,
+					compiledSchemaResultsByXsdPath
+				);
+
+				// Assert against snapshot, and optionally update the snapshot.
+				const serializedResult = JSON.stringify(
+					result,
+					(_key, value) => {
+						return value instanceof Map
+							? Array.from(value.entries())
+							: value instanceof Set
+							? Array.from(value)
+							: value;
+					},
+					'\t'
+				);
+				const snapshotPath = path.join(fixturePath, 'model.out.json');
+				await assertFixtureSnapshot(serializedResult, snapshotPath);
+			});
 		});
 	});
 });

package/src/modules/editor-pre-7-7-0/test/api/schema/fixtures/dita-example-schema-bundle/listOfFiles.json

@@ -1,15 +1,7 @@
 [
-	"LICENSE.md",
-	"README.md",
 	"catalog.xml",
-	"compiledSchema.json",
 	"fonto.json",
-	"listOfFiles.json",
-	"model.out.json",
-	"schema/",
-	"schema/base/",
 	"schema/base/catalog.xml",
-	"schema/base/xsd/",
 	"schema/base/xsd/basemap.xsd",
 	"schema/base/xsd/basetopic.xsd",
 	"schema/base/xsd/commonElementGrp.xsd",
@@ -32,20 +24,14 @@
 	"schema/base/xsd/topicMod.xsd",
 	"schema/base/xsd/utilitiesDomain.xsd",
 	"schema/base/xsd/xml.xsd",
-	"schema/bookmap/",
 	"schema/bookmap/catalog.xml",
-	"schema/bookmap/xsd/",
 	"schema/bookmap/xsd/bookmap.xsd",
 	"schema/bookmap/xsd/bookmapGrp.xsd",
 	"schema/bookmap/xsd/bookmapMod.xsd",
 	"schema/catalog.xml",
-	"schema/ditaval/",
 	"schema/ditaval/catalog.xml",
-	"schema/ditaval/xsd/",
 	"schema/ditaval/xsd/ditaval.xsd",
-	"schema/fontoxml/",
 	"schema/fontoxml/catalog.xml",
-	"schema/fontoxml/constraints/",
 	"schema/fontoxml/constraints/machineryTaskbodyConstraintMod.xsd",
 	"schema/fontoxml/constraints/strictCommonElementConstraint.xsd",
 	"schema/fontoxml/constraints/strictCommonElementConstraintInt.xsd",
@@ -62,7 +48,6 @@
 	"schema/fontoxml/constraints/strictTblDeclConstraint.xsd",
 	"schema/fontoxml/constraints/strictTopicConstraint.xsd",
 	"schema/fontoxml/constraints/strictTroubleshootingConstraint.xsd",
-	"schema/fontoxml/shells/",
 	"schema/fontoxml/shells/basemap.xsd",
 	"schema/fontoxml/shells/basetopic.xsd",
 	"schema/fontoxml/shells/bookmap.xsd",
@@ -89,9 +74,7 @@
 	"schema/fontoxml/shells/task.xsd",
 	"schema/fontoxml/shells/topic.xsd",
 	"schema/fontoxml/shells/troubleshooting.xsd",
-	"schema/learning/",
 	"schema/learning/catalog.xml",
-	"schema/learning/xsd/",
 	"schema/learning/xsd/learning2Domain.xsd",
 	"schema/learning/xsd/learningAggregationsTopicrefConstraintMod.xsd",
 	"schema/learning/xsd/learningAssessment.xsd",
@@ -126,23 +109,17 @@
 	"schema/learning/xsd/learningSummary.xsd",
 	"schema/learning/xsd/learningSummaryGrp.xsd",
 	"schema/learning/xsd/learningSummaryMod.xsd",
-	"schema/machineryIndustry/",
 	"schema/machineryIndustry/catalog.xml",
-	"schema/machineryIndustry/xsd/",
 	"schema/machineryIndustry/xsd/machineryTask.xsd",
 	"schema/machineryIndustry/xsd/machineryTaskbodyConstraintIntMod.xsd",
 	"schema/machineryIndustry/xsd/machineryTaskbodyConstraintMod.xsd",
-	"schema/subjectScheme/",
 	"schema/subjectScheme/catalog.xml",
-	"schema/subjectScheme/xsd/",
 	"schema/subjectScheme/xsd/classifyDomain.xsd",
 	"schema/subjectScheme/xsd/classifyMap.xsd",
 	"schema/subjectScheme/xsd/subjectScheme.xsd",
 	"schema/subjectScheme/xsd/subjectSchemeGrp.xsd",
 	"schema/subjectScheme/xsd/subjectSchemeMod.xsd",
-	"schema/technicalContent/",
 	"schema/technicalContent/catalog.xml",
-	"schema/technicalContent/xsd/",
 	"schema/technicalContent/xsd/abbreviateDomain.xsd",
 	"schema/technicalContent/xsd/concept.xsd",
 	"schema/technicalContent/xsd/conceptGrp.xsd",
@@ -163,8 +140,6 @@
 	"schema/technicalContent/xsd/glossrefDomain.xsd",
 	"schema/technicalContent/xsd/map.xsd",
 	"schema/technicalContent/xsd/markupDomain.xsd",
-	"schema/technicalContent/xsd/mathml/",
-	"schema/technicalContent/xsd/mathml/mathml3/",
 	"schema/technicalContent/xsd/mathml/mathml3/mathml3-common.xsd",
 	"schema/technicalContent/xsd/mathml/mathml3/mathml3-content.xsd",
 	"schema/technicalContent/xsd/mathml/mathml3/mathml3-presentation.xsd",
@@ -178,8 +153,6 @@
 	"schema/technicalContent/xsd/releaseManagementDomain.xsd",
 	"schema/technicalContent/xsd/softwareDomain.xsd",
 	"schema/technicalContent/xsd/strictTaskbodyConstraintMod.xsd",
-	"schema/technicalContent/xsd/svg/",
-	"schema/technicalContent/xsd/svg/svg11/",
 	"schema/technicalContent/xsd/svg/svg11/local.xsd",
 	"schema/technicalContent/xsd/svg/svg11/svg-animation.xsd",
 	"schema/technicalContent/xsd/svg/svg11/svg-animevents-attrib.xsd",
@@ -231,19 +204,11 @@
 	"schema/technicalContent/xsd/troubleshootingMod.xsd",
 	"schema/technicalContent/xsd/uiDomain.xsd",
 	"schema/technicalContent/xsd/xmlDomain.xsd",
-	"schema/xnal/",
 	"schema/xnal/catalog.xml",
-	"schema/xnal/xsd/",
 	"schema/xnal/xsd/xnalDomain.xsd",
-	"xslt/",
-	"xslt/unit test/",
 	"xslt/unit test/TestBrokenFileXslt.xml",
-	"xslt/unit test/TestMixedContent-result.html",
-	"xslt/unit test/TestMixedContent.xspec",
 	"xslt/unit test/inputFuleFileTest.xml",
 	"xslt/unit test/inputFuleFileTest2.xml",
 	"xslt/unit test/outputFuleFileTest.xml",
-	"xslt/unit test/outputFuleFileTest2.xml",
-	"xslt/xsltFixBrokenContent.xsl",
-	"xslt/xsltMixedContent.xsl"
+	"xslt/unit test/outputFuleFileTest2.xml"
 ]

package/src/modules/editor-pre-7-7-0/test/api/schema/fixtures/invalid-fonto-json/fonto.json

@@ -0,0 +1 @@
+This is not a JSON file.

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

@@ -0,0 +1,174 @@
+import assert from 'assert';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+import getSchemaFontoJson, {
+	validateSchemaFontoJson,
+} from '../../../src/api/schema/getSchemaFontoJson.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+describe('api/schema/getSchemaFontoJson', () => {
+	it('can get a schema fonto.json', async () => {
+		const fixturePath = path.join(__dirname, 'fixtures', 'abstract-test');
+		const fontoJson = await getSchemaFontoJson(fixturePath);
+		assert.deepEqual(fontoJson, {
+			rootSchemas: {
+				'abstractTest.xsd': {
+					packageName: 'abstract-test-sx-shell',
+					locations: ['urn:fonto:abstract:test'],
+				},
+			},
+		});
+	});
+
+	it('throws when the directory does not exist', async () => {
+		const fixturePath = path.join(__dirname, 'fixtures', 'non-existing');
+		await getSchemaFontoJson(fixturePath)
+			.then(() => {
+				throw new Error('Should have thrown.');
+			})
+			.catch((error) => {
+				assert.ok(error);
+				assert.ok(
+					error.message.match(/Schema source path does not exist/)
+				);
+			});
+	});
+
+	it('throws when the fonto.json file does not exist', async () => {
+		const fixturePath = path.join(__dirname, 'fixtures');
+		await getSchemaFontoJson(fixturePath)
+			.then(() => {
+				throw new Error('Should have thrown.');
+			})
+			.catch((error) => {
+				assert.ok(error);
+				assert.ok(
+					error.message.match(/schema source path does not exist/)
+				);
+			});
+	});
+
+	it('throws when the fonto.json could not be parsed', async () => {
+		const fixturePath = path.join(
+			__dirname,
+			'fixtures',
+			'invalid-fonto-json'
+		);
+		await getSchemaFontoJson(fixturePath)
+			.then(() => {
+				throw new Error('Should have thrown.');
+			})
+			.catch((error) => {
+				assert.ok(error);
+				assert.ok(error.message.match(/could not be parsed/));
+			});
+	});
+
+	describe('validateSchemaFontoJson', () => {
+		it('throws when there is no rootSchemas property', () => {
+			assert.throws(() => {
+				validateSchemaFontoJson({});
+			}, /Missing "rootSchemas" property/);
+		});
+
+		it('throws when a rootSchemas property is not an object', () => {
+			assert.throws(() => {
+				validateSchemaFontoJson({ rootSchemas: [] });
+			}, /The "rootSchemas" property is not an object/);
+		});
+
+		it('throws when a root schema is not an object', () => {
+			assert.throws(() => {
+				validateSchemaFontoJson({ rootSchemas: { 'test.xsd': [] } });
+			}, /Root schema "test.xsd" is not an object/);
+		});
+
+		it('throws when a root schema is missing the packageName property', () => {
+			assert.throws(() => {
+				validateSchemaFontoJson({ rootSchemas: { 'test.xsd': {} } });
+			}, /Root schema "test.xsd" does not have a valid "packageName" property/);
+		});
+
+		it('throws when a root schema has an invalid location property', () => {
+			// Non array.
+			assert.throws(() => {
+				validateSchemaFontoJson({
+					rootSchemas: {
+						'test.xsd': {
+							packageName: 'test-package',
+							locations: {},
+						},
+					},
+				});
+			}, /Root schema "test.xsd" has an invalid "locations" property/);
+
+			// Non string value.
+			assert.throws(() => {
+				validateSchemaFontoJson({
+					rootSchemas: {
+						'test.xsd': {
+							packageName: 'test-package',
+							locations: [false],
+						},
+					},
+				});
+			}, /Root schema "test.xsd" has an invalid "locations" property/);
+
+			// Empty string value.
+			assert.throws(() => {
+				validateSchemaFontoJson({
+					rootSchemas: {
+						'test.xsd': {
+							packageName: 'test-package',
+							locations: [''],
+						},
+					},
+				});
+			}, /Root schema "test.xsd" has an invalid "locations" property/);
+		});
+
+		it('throws when there are multiple root schemas but one is missing the location property', () => {
+			// Missing locations property.
+			assert.throws(() => {
+				validateSchemaFontoJson({
+					rootSchemas: {
+						'test1.xsd': {
+							packageName: 'test-package',
+							locations: ['urn:test1'],
+						},
+						'test2.xsd': {
+							packageName: 'test-package',
+						},
+						'test3.xsd': {
+							packageName: 'test-package',
+							locations: ['urn:test1'],
+						},
+					},
+				});
+			}, /Root schema "test2.xsd" is missing the "locations" property/);
+
+			// Empty locations property.
+			assert.throws(() => {
+				validateSchemaFontoJson({
+					rootSchemas: {
+						'test1.xsd': {
+							packageName: 'test-package',
+							locations: ['urn:test1'],
+						},
+						'test2.xsd': {
+							packageName: 'test-package',
+							locations: [],
+						},
+						'test3.xsd': {
+							packageName: 'test-package',
+							locations: ['urn:test1'],
+						},
+					},
+				});
+			}, /Root schema "test2.xsd" has an empty "locations" property/);
+		});
+	});
+});

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

@@ -43,10 +43,8 @@ describe('api/schema/schemaZipHelpers', () => {
 			);
 
 			const directory = await unzipper.Open.buffer(zipBuffer);
-			const listOfFiles = [];
-			directory.files.forEach((file) => {
-				listOfFiles.push(file.path);
-			});
+			// Sort this list to guarrantee that the order is always the same
+			const listOfFiles = directory.files.map((file) => file.path).sort();
 
 			const listOfFilesInJson = await fs.readJson(
 				path.join(fixturePath, 'listOfFiles.json')
@@ -82,6 +80,14 @@ describe('api/schema/schemaZipHelpers', () => {
 				path.join(tmpDir.path, 'schema/learning')
 			);
 
+			// Remove fonto.json
+			await fs.remove(path.join(tmpDir.path, 'fonto.json'));
+			// Link fonto.json
+			await fs.ensureSymlink(
+				path.join(fixturePath, 'fonto.json'),
+				path.join(tmpDir.path, 'fonto.json')
+			);
+
 			try {
 				await testSchemaBundle(tmpDir.path);
 			} finally {