umberto 6.1.2 → 7.0.1

package/src/data-converter/converters/typedoc/constantparser.js

@@ -6,18 +6,19 @@
 'use strict';
 
 const AbstractParser = require( './abstractparser' );
+const ReflectionKind = require( './reflectionkind' );
 
 module.exports = class ConstantParser extends AbstractParser {
 	/**
-	 * @param {TypedocReflectionMeta} item
+	 * @param {BaseReflection} item
 	 * @returns {Boolean}
 	 */
 	canParse( item ) {
-		return item.kindString === 'Variable';
+		return item.kind === ReflectionKind.Variable;
 	}
 
 	/**
-	 * @param {TypedocReflection<'Variable'>} item
+	 * @param {VariableReflection} item
 	 * @param {String} parentName
 	 * @returns {Object}
 	 */
@@ -26,6 +27,7 @@ module.exports = class ConstantParser extends AbstractParser {
 			// Needed for post-processing once all project reflections are converted.
 			_signature: item,
 
+			id: item.id,
 			name: item.name,
 			memberof: parentName,
 			longname: this.getLongName( item, parentName ),

package/src/data-converter/converters/typedoc/constructorparser.js

@@ -6,18 +6,19 @@
 'use strict';
 
 const MethodParser = require( './methodparser' );
+const ReflectionKind = require( './reflectionkind' );
 
 module.exports = class ConstructorParser extends MethodParser {
 	/**
-	 * @param {TypedocReflectionMeta} item
+	 * @param {BaseReflection} item
 	 * @returns {Boolean}
 	 */
 	canParse( item ) {
-		return item.kindString === 'Constructor';
+		return item.kind === ReflectionKind.Constructor;
 	}
 
 	/**
-	 * @param {TypedocReflection<'Constructor'>} item
+	 * @param {ConstructorReflection} item
 	 * @param {String} parentName
 	 * @returns {Array.<Object>}
 	 */

package/src/data-converter/converters/typedoc/errorparser.js

@@ -9,26 +9,20 @@ const AbstractParser = require( './abstractparser' );
 
 module.exports = class ErrorParser extends AbstractParser {
 	/**
-	 * @param {TypedocReflectionMeta} item
+	 * @param {BaseReflection} item
 	 * @returns {Boolean}
 	 */
 	canParse( item ) {
-		return item.kindString === 'Error';
+		return item.isCKEditor5Error === true;
 	}
 
 	/**
-	 * @param {TypedocReflection<'Error'>} item
+	 * @param {CKEditor5ErrorReflection} item
 	 * @returns {Object}
 	 */
 	parse( item ) {
 		return {
-			_signature: [
-				{},
-				// As errors are our custom implementation, TypeDoc does not allow creating `parameters` property for them. Error parameters
-				// are passed in `typeParameters` property. To process the error parameters properly, we manually map `typeParameters` into
-				// `parameters` property.
-				{ parameters: item.typeParameters }
-			],
+			_signature: [ {}, item ],
 
 			kind: this.getKind( item ),
 			scope: 'inner',

package/src/data-converter/converters/typedoc/eventparser.js

@@ -9,15 +9,15 @@ const AbstractParser = require( './abstractparser' );
 
 module.exports = class EventParser extends AbstractParser {
 	/**
-	 * @param {TypedocReflectionMeta} item
+	 * @param {BaseReflection} item
 	 * @returns {Boolean}
 	 */
 	canParse( item ) {
-		return item.kindString === 'Event';
+		return item.isCKEditor5Event === true;
 	}
 
 	/**
-	 * @param {TypedocReflection<'Event'>} item
+	 * @param {CKEditor5EventReflection} item
 	 * @param {String} parentName
 	 * @returns {Object}
 	 */
@@ -28,13 +28,7 @@ module.exports = class EventParser extends AbstractParser {
 
 		return {
 			// Needed for post-processing once all project reflections are converted.
-			_signature: [
-				{},
-				// As events are our custom implementation, TypeDoc does not allow creating `parameters` property for them. Event parameters
-				// are passed in `typeParameters` property. To process the event parameters properly, we manually map `typeParameters` into
-				// `parameters` property.
-				{ parameters: item.typeParameters }
-			],
+			_signature: [ {}, item ],
 
 			name: item.name,
 			memberof: parentName,

package/src/data-converter/converters/typedoc/functionparser.js

@@ -6,18 +6,19 @@
 'use strict';
 
 const AbstractParser = require( './abstractparser' );
+const ReflectionKind = require( './reflectionkind' );
 
 module.exports = class FunctionParser extends AbstractParser {
 	/**
-	 * @param {TypedocReflectionMeta} item
+	 * @param {BaseReflection} item
 	 * @returns {Boolean}
 	 */
 	canParse( item ) {
-		return item.kindString === 'Function';
+		return item.kind === ReflectionKind.Function;
 	}
 
 	/**
-	 * @param {TypedocReflection<'Function'>} item
+	 * @param {FunctionReflection} item
 	 * @param {String} parentName
 	 * @returns {Array.<Object>}
 	 */
@@ -27,6 +28,7 @@ module.exports = class FunctionParser extends AbstractParser {
 				// Needed for post-processing once all project reflections are converted.
 				_signature: signature,
 
+				id: item.id,
 				name: item.name,
 				memberof: parentName,
 				longname: this.getLongName( item, parentName ),

package/src/data-converter/converters/typedoc/interfaceparser.js

@@ -6,18 +6,19 @@
 'use strict';
 
 const AbstractParser = require( './abstractparser' );
+const ReflectionKind = require( './reflectionkind' );
 
 module.exports = class InterfaceParser extends AbstractParser {
 	/**
-	 * @param {TypedocReflectionMeta} item
+	 * @param {BaseReflection} item
 	 * @returns {Boolean}
 	 */
 	canParse( item ) {
-		return item.kindString === 'Interface';
+		return item.kind === ReflectionKind.Interface;
 	}
 
 	/**
-	 * @param {TypedocReflection<'Interface'>} item
+	 * @param {InterfaceReflection} item
 	 * @param {String} parentName
 	 * @returns {Object}
 	 */
@@ -26,6 +27,7 @@ module.exports = class InterfaceParser extends AbstractParser {
 			// Needed for post-processing once all project reflections are converted.
 			_signature: item,
 
+			id: item.id,
 			name: item.name,
 			memberof: parentName,
 			longname: this.getLongName( item, parentName ),

package/src/data-converter/converters/typedoc/methodparser.js

@@ -6,18 +6,19 @@
 'use strict';
 
 const AbstractParser = require( './abstractparser' );
+const ReflectionKind = require( './reflectionkind' );
 
 module.exports = class MethodParser extends AbstractParser {
 	/**
-	 * @param {TypedocReflectionMeta} item
+	 * @param {BaseReflection} item
 	 * @returns {Boolean}
 	 */
 	canParse( item ) {
-		return item.kindString === 'Method';
+		return item.kind === ReflectionKind.Method;
 	}
 
 	/**
-	 * @param {TypedocReflection<ConstructorOrMethod>} item
+	 * @param {MethodReflection|ConstructorReflection} item
 	 * @param {String} parentName
 	 * @returns {Array.<Object>}
 	 */
@@ -27,6 +28,7 @@ module.exports = class MethodParser extends AbstractParser {
 				// Needed for post-processing once all project reflections are converted.
 				_signature: signature,
 
+				id: item.id,
 				name: item.name,
 				memberof: parentName,
 				longname: this.getLongName( item, parentName ),
@@ -64,7 +66,7 @@ module.exports = class MethodParser extends AbstractParser {
 	/**
 	 * Returns the access type for the item based on its signatures.
 	 *
-	 * @param {TypedocReflection<ConstructorOrMethod>} item
+	 * @param {MethodReflection|ConstructorReflection} item
 	 * @param {Number} sourceIndex
 	 * @returns {'public'|'internal'|'protected'|'private'}
 	 */

package/src/data-converter/converters/typedoc/moduleparser.js

@@ -6,22 +6,28 @@
 'use strict';
 
 const AbstractParser = require( './abstractparser' );
+const ReflectionKind = require( './reflectionkind' );
 
 module.exports = class ModuleParser extends AbstractParser {
 	/**
-	 * @param {TypedocReflectionMeta} item
+	 * @param {BaseReflection} item
 	 * @returns {Boolean}
 	 */
 	canParse( item ) {
-		return item.kindString === 'Module';
+		return item.kind === ReflectionKind.Module;
 	}
 
 	/**
-	 * @param {TypedocReflection<'Module'>} item
+	 * @param {ModuleReflection} item
 	 * @returns {Object}
 	 */
 	parse( item ) {
+		if ( !item.name.includes( '/' ) ) {
+			item.name += '/index';
+		}
+
 		return {
+			id: item.id,
 			name: item.name,
 			longname: this.getLongName( item ),
 			kind: this.getKind( item ),

package/src/data-converter/converters/typedoc/propertyparser.js

@@ -6,33 +6,28 @@
 'use strict';
 
 const AbstractParser = require( './abstractparser' );
+const ReflectionKind = require( './reflectionkind' );
 
 module.exports = class PropertyParser extends AbstractParser {
 	/**
-	 * @param {TypedocReflectionMeta} item
+	 * @param {BaseReflection} item
 	 * @returns {Boolean}
 	 */
 	canParse( item ) {
-		return item.kindString === 'Property' && item.name !== 'constructor';
+		return item.kind === ReflectionKind.Property;
 	}
 
 	/**
-	 * @param {TypedocReflection<'Property'>} item
+	 * @param {PropertyReflection} item
 	 * @param {String} parentName
 	 * @returns {Object}
 	 */
 	parse( item, parentName ) {
-		// By default, a comment that is associated in the source code with the property, is bound to the item itself, as anyone would
-		// expect. TypeDoc works differently for a callable property, for which the comment is moved down to the property signature.
-		// Hence, we must extract it back from the property signature to be able to display it correctly in the API docs.
-		const description = isCallableProperty( item ) ?
-			this.getComment( item.type.declaration.signatures[ 0 ] ) :
-			this.getComment( item );
-
 		return {
 			// Needed for post-processing once all project reflections are converted.
 			_signature: [ item, {} ],
 
+			id: item.id,
 			name: item.name,
 			memberof: parentName,
 			longname: this.getLongName( item, parentName ),
@@ -44,7 +39,7 @@ module.exports = class PropertyParser extends AbstractParser {
 			optional: this.isOptional( item ),
 			kind: this.getKind( item ),
 			extraId: this.getExtraId( item ),
-			description,
+			description: this.getComment( item ),
 			file: this.getFile( item ),
 			skipSource: this.shouldSkipSource( item ),
 			deprecated: this.isDeprecated( item ),
@@ -60,7 +55,7 @@ module.exports = class PropertyParser extends AbstractParser {
 	/**
 	 * Returns the default value of an item defined by the `@defaultValue` or `@default` tags.
 	 *
-	 * @param {TypedocReflection} item
+	 * @param {PropertyReflection} item
 	 * @returns {String}
 	 */
 	getDefault( item ) {
@@ -77,19 +72,3 @@ module.exports = class PropertyParser extends AbstractParser {
 		return defaultTag.content[ 0 ].text;
 	}
 };
-
-/**
- * @param {TypedocReflectionType} item
- * @returns {Boolean}
- */
-function isCallableProperty( item ) {
-	if ( item.type.type !== 'reflection' ) {
-		return false;
-	}
-
-	if ( !Array.isArray( item.type.declaration.signatures ) ) {
-		return false;
-	}
-
-	return true;
-}

package/src/data-converter/converters/typedoc/referenceparser.js

@@ -0,0 +1,41 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+const AbstractParser = require( './abstractparser' );
+const ReflectionKind = require( './reflectionkind' );
+
+module.exports = class ReferenceParser extends AbstractParser {
+	/**
+	 * @param {BaseReflection} item
+	 * @returns {Boolean}
+	 */
+	canParse( item ) {
+		return item.kind === ReflectionKind.Reference;
+	}
+
+	/**
+	 * @param {ReferenceReflection} item
+	 * @param {String} parentName
+	 * @returns {Object}
+	 */
+	parse( item, parentName ) {
+		return {
+			// Needed for post-processing once all project reflections are converted.
+			_signature: item,
+
+			id: item.id,
+			name: item.name,
+			memberof: parentName,
+			longname: this.getLongName( item, parentName ),
+			file: this.getFile( item ),
+
+			_isReference: true,
+
+			targetDoclet: null
+		};
+	}
+};

package/src/data-converter/converters/typedoc/reflectionkind.js

@@ -0,0 +1,34 @@
+/**
+ * @license Copyright (c) 2017-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+'use strict';
+
+// To avoid linking Umberto and Typedoc, let's keep this file in sync with the `ReflectionKind` enum.
+// See: https://typedoc.org/api/enums/Models.ReflectionKind.html
+
+module.exports.Accessor = 262144;
+module.exports.CallSignature = 4096;
+module.exports.Class = 128;
+module.exports.Constructor = 512;
+module.exports.ConstructorSignature = 16384;
+module.exports.Document = 8388608;
+module.exports.Enum = 8;
+module.exports.EnumMember = 16;
+module.exports.Function = 64;
+module.exports.GetSignature = 524288;
+module.exports.IndexSignature = 8192;
+module.exports.Interface = 256;
+module.exports.Method = 2048;
+module.exports.Module = 2;
+module.exports.Namespace = 4;
+module.exports.Parameter = 32768;
+module.exports.Project = 1;
+module.exports.Property = 1024;
+module.exports.Reference = 4194304;
+module.exports.SetSignature = 1048576;
+module.exports.TypeAlias = 2097152;
+module.exports.TypeLiteral = 65536;
+module.exports.TypeParameter = 131072;
+module.exports.Variable = 32;