umberto 9.2.0 → 9.3.0

package/CHANGELOG.md

@@ -1,6 +1,21 @@
 Changelog
 =========
 
+## [9.3.0](https://github.com/cksource/umberto/compare/v9.2.0...v9.3.0) (January 27, 2026)
+
+### Features
+
+* The API documentation builder now generates dedicated pages for [`Enum`](https://www.typescriptlang.org/docs/handbook/enums.html) types, presented in a format similar to object definitions.
+
+### Bug fixes
+
+* Improved rendering of `typedef` pages for union types by displaying their supported values, which were previously not shown.
+
+### Other changes
+
+* Improved rendering of [`templateLiteral`](https://www.typescriptlang.org/docs/handbook/2/template-literal-types.html) types that reference a module. They are now rendered as clickable links pointing to the corresponding page.
+
+
 ## [9.2.0](https://github.com/cksource/umberto/compare/v9.1.3...v9.2.0) (January 7, 2026)
 
 ### Features
@@ -39,20 +54,6 @@ Changelog
 
 * Added support for the `environment` field in Sentry configuration.
 
-
-## [9.1.0](https://github.com/cksource/umberto/compare/v9.0.0...v9.1.0) (November 24, 2025)
-
-### Features
-
-* Introduced support for [Sentry](https://sentry.io/welcome/) in the generated documentation.
-
-  Umberto configuration can now specify the `sentry` key that allows loading the Sentry SDK on production hosts: https://ckeditor.com/docs and https://ckeditor5.github.io/docs/nightly.
-
-### Other changes
-
-* Improve performance of `api-builder` and `validate-links` scripts.
-* Migrate from `cheerio` to `htmlparser2` and friends.
-
 ---
 
 To see all releases, visit the [release page](https://github.com/cksource/umberto/releases).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "umberto",
-  "version": "9.2.0",
+  "version": "9.3.0",
   "description": "CKSource Documentation builder",
   "main": "src/index.js",
   "files": [
@@ -76,4 +76,4 @@
   "hexo": {
     "version": "8.1.1"
   }
-}
+}

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

@@ -64,6 +64,7 @@ module.exports = class AbstractParser {
 			case ReflectionKind.Class:
 			case ReflectionKind.Interface:
 			case ReflectionKind.TypeAlias:
+			case ReflectionKind.Enum:
 				separator = '~';
 				break;
 
@@ -148,6 +149,7 @@ module.exports = class AbstractParser {
 				return 'constant';
 
 			case ReflectionKind.TypeAlias:
+			case ReflectionKind.Enum:
 				return 'typedef';
 		}
 	}

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

@@ -14,7 +14,7 @@ module.exports = class TypeParser extends AbstractParser {
 	 * @returns {Boolean}
 	 */
 	canParse( item ) {
-		return item.kind === ReflectionKind.TypeAlias;
+		return item.kind === ReflectionKind.TypeAlias || item.kind === ReflectionKind.Enum;
 	}
 
 	/**

package/src/helpers/extract-longname.js

@@ -26,6 +26,35 @@ module.exports = str => {
 		longnames: [ str ]
 	};
 
+	// `templateLiteral` - simplified version - matches `${ ... }` only.
+	if ( str.startsWith( '`${' ) && str.endsWith( '}`' ) ) {
+		result.prefix = str.slice( 0, 4 ); // Backtick, dollar sign, opening bracket, space.
+		result.suffix = str.slice( -3 ); // Space, closing bracket, backtick.
+
+		const inner = str.slice( 3, -2 ).trim();
+
+		// Allow lists (union) separated by '|' or ',' (consistent with '.<...>' parsing)
+		result.longnames = inner.split( /[|,]+/ ).map( l => l.trim() );
+
+		// Build separators array in the same style as for '.<...>'
+		result.separators = [];
+
+		const separatorsRegex = /[,|]/g;
+		let separatorsMatch = separatorsRegex.exec( inner );
+
+		while ( separatorsMatch !== null ) {
+			if ( separatorsMatch[ 0 ] === ',' ) {
+				result.separators.push( `${ separatorsMatch[ 0 ] } ` );
+			} else {
+				result.separators.push( ` ${ separatorsMatch[ 0 ] } ` );
+			}
+
+			separatorsMatch = separatorsRegex.exec( inner );
+		}
+
+		return result;
+	}
+
 	if ( str.indexOf( '.<' ) !== -1 ) {
 		const match = /^([\w]+\.<\(*)([^)>]+)([)>]+)$/.exec( str );
 

package/themes/umberto/layout/gloria/_api-docs/class.pug

@@ -7,4 +7,4 @@ block prepend content
 //- Make sure to add the report issue widget at the end of the page.
 block append content
 	if page.reportIssueWidget
-		// TODO: Add report issue widget.
+		//- TODO: Add report issue widget.

package/themes/umberto/layout/gloria/_api-docs/interface.pug

@@ -7,4 +7,4 @@ block prepend content
 //- Make sure to add the report issue widget at the end of the page.
 block append content
 	if page.reportIssueWidget
-		// TODO: Add report issue widget.
+		//- TODO: Add report issue widget.

package/themes/umberto/layout/gloria/_api-docs/mixin.pug

@@ -7,4 +7,4 @@ block prepend content
 //- Make sure to add the report issue widget at the end of the page.
 block append content
 	if page.reportIssueWidget
-		// TODO: Add report issue widget.
+		//- TODO: Add report issue widget.

package/themes/umberto/layout/gloria/_api-docs/module.pug

@@ -7,4 +7,4 @@ block prepend content
 //- Make sure to add the report issue widget at the end of the page.
 block append content
 	if page.reportIssueWidget
-		// TODO: Add report issue widget.
+		//- TODO: Add report issue widget.

package/themes/umberto/layout/gloria/_api-docs/namespace.pug

@@ -7,4 +7,4 @@ block prepend content
 //- Make sure to add the report issue widget at the end of the page.
 block append content
 	if page.reportIssueWidget
-		// TODO: Add report issue widget.
+		//- TODO: Add report issue widget.

package/themes/umberto/layout/gloria/_api-docs/typedef.pug

@@ -9,20 +9,29 @@ block prepend content
 	+apiHeader( { iconPath: 'assets/' + umbertoVersion + '/gloria/img/data.svg', kind: 'Typedef' } )
 
 block append content
-	if data.types.length == 1 && data.types[ 0 ] == 'function'
-		div.typedef-callback
-			if isNonEmptyArray( data.params )
-				h4.b-h4 Parameters
-				+paramsMixin( data.params )
+	if Array.isArray( data.types )
+		//- Inline callback
+		if data.types.length == 1 && data.types[ 0 ] == 'function'
+			div.typedef-callback
+				if isNonEmptyArray( data.params )
+					h4.b-h4 Parameters
+					+paramsMixin( data.params )
 
-			if isNonEmptyArray( data.returns )
-				h4.b-h4 Returns
-				dl
-					each ret in data.returns
-						+return( ret )
+				if isNonEmptyArray( data.returns )
+					h4.b-h4 Returns
+					dl
+						each ret in data.returns
+							+return( ret )
 
-			if isNonEmptyArray( data.see )
-				+related( data.see )
+				if isNonEmptyArray( data.see )
+					+related( data.see )
+		//- Union
+		else if data.types.length
+			div( class="main-description" )
+				h4.b-h4 Value
+				p
+					code
+						+type( data.types )
 
 	if data.firedBy
 		h2.b-h2 Fired by
@@ -34,4 +43,4 @@ block append content
 //- Make sure to add the report issue widget at the end of the page.
 block append content
 	if page.reportIssueWidget
-		// TODO: Add report issue widget.
+		//- TODO: Add report issue widget.