chore(deps): update dependency typedoc to v0.28.12

[renovate]

This PR contains the following updates:

Package	Change	Age	Confidence
typedoc (source)	0.27.9 -> 0.28.12

---

Release Notes

TypeStrong/TypeDoc (typedoc)

v0.28.12

Compare Source

Bug Fixes

• Variables marked with @enum now work for symbols imported from another module, #​3003.
• Improved magic introduced with #​2999 to work with imported symbols, #​3003.
• Fixed relative link resolution to file names containing percent encoded URLs, #​3006.
• Linking to the project's README file with a relative link will now behave as expected, #​3006.
• Reduced unnecessary HTML element rendering in default theme.
  API: Reflection.hasComment and Comment.hasVisibleComponent now accepts an optional notRenderedTags parameter.

v0.28.11

Compare Source

Features

• Object properties declared with shorthand property assignment will now use the variable's comment
  if they do not have their own comment, #​2999.

Bug Fixes

• Fixed link resolution not working correctly in first comment on the file in some cases, #​2994.
• Optional methods are now rendered with a trailing ? in the reflection preview and signature, #​2995.
• The compilerOptions option now functions properly with non-boolean options, #​3000.
• Configuration errors within the compilerOptions option are now handled gracefully, #​3000.
• Fixed improper casing of "Type Declaration" header, #​3002.

v0.28.10

Compare Source

Bug Fixes

• Fixed inconsistent anchors on module pages for re-exports, #​2990.
• Markdown references which appear to be footnotes will no longer be checked for links, #​2991.

v0.28.9

Compare Source

Features

• Add support for TypeScript 5.9, #​2989.

Bug Fixes

• Fixed bug introduced in 0.28.8 where TypeDoc could not render docs when members inherited from a complex type alias, #​2982.
• Fixed automatic discovery of entry points when not running in packages mode, #​2988.
• Fixed discovery of package.json file when running with entry points containing a glob, #​2985.

v0.28.8

Compare Source

Features

• If using JS config files, the plugin function can now be given plugin functions to load.
• Permit - within tag names to support typescript-json-schema's @TJS-type tag, #​2972.
• Exposed Context.createSymbolId for use by plugins.

Bug Fixes

• Relative links in <img srcset> will now be discovered by TypeDoc, #​2975.
• Relative links in <source src> and <source srcset> elements will now be discovered by TypeDoc, #​2975.
• Improved inherited from/overwrites link discovery to point to parent properties in more cases, #​2978

Thanks!

• @​jonathanhefner
• @​laymonage

v0.28.7

Compare Source

Features

• Introduced the @sortStrategy tag to override the sort option on a specific reflection, #​2965.

Bug Fixes

• Classes and functions exported with export { type X } are no longer missing comments, #​2970.
• Setting locale to an unknown value will now cause TypeDoc to operate in English instead of a debug locale.
• Array options will now report an error if set to a non-array/non-string value.

v0.28.6

Compare Source

Features

• TypeDoc now supports resolving relative paths in links to the package directory as belonging to the project, #​2961.
• Declarations without comments will now check for comments on their export specifier, #​2964.

Bug Fixes

• Attempting to highlight a supported language which is not enabled is now a warning, not an error, #​2956.
• Improved compatibility with CommonMark's link parsing, #​2959.
• Classes, variables, and functions exported with export { type X } are now detected and converted as interfaces/type aliases, #​2962.
• Improved warning messaging for links to symbols which were resolved, but the symbols were not included in the documentation, #​2967.
• Fixed an issue preventing nested documents from being deserialized from TypeDoc's JSON output or used in packages mode, #​2969.

Thanks!

• @​yGuy

v0.28.5

Compare Source

Bug Fixes

• References to type aliases defined as mapped types will now correctly create a reference to the type alias, #​2954.
• ignoredHighlightLanguages can now be used to prevent warnings for codeblocks containing languages
  which are supported by Shiki but are not loaded, #​2956.

v0.28.4

Compare Source

Features

• The navigation in the default theme will now attempt to break long names onto multiple lines, #​2940.
• Added German (de) localization, #​2941.

Bug Fixes

• TypeDoc's default theme now uses the same chevron for all collapsible elements, #​2924
  The chevronSmall helper is now deprecated and will be removed with v0.29.0.
• Classes/interfaces marked with @hidden will no longer appear in the
  "Hierarchy" section of the docs.
• TypeDoc now handles wildcard JSDoc types, #​2949.

Thanks!

• @​blutorange
• @​bkeepers

v0.28.3

Compare Source

Bug Fixes

• @inline now functions when referencing tuple types, #​2932.
• @link links to the current page are now rendered, #​2934.
• @includeCode now supports regions in TypeScript files with .mts and .cts file extensions, #​2935.
• Aliased symbols (re-exports) are now resolved before checking if they are excluded/external, #​2937.
• Improved error reporting when paths including Windows separators are provided as globs, #​2938.

v0.28.2

Compare Source

Features

• @group none and @category none will now render their children without a section
  heading in the default theme, #​2922.
• Added @disableGroups tag to completely disable the grouping mechanism for a
  given reflection, #​2922.

Bug Fixes

• Variables using @class now correctly handle @category, #​2914.
• Variables using @class now include constructor parameters, #​2914.
• Variables using @class with a generic first constructor function now adopt
  that function's type parameters as the class type parameters, #​2914.
• When printing entry point globs which fail to match any paths, TypeDoc will no longer normalize the glob, #​2918.
• Inlining types can now handle more type variants, #​2920.
• Fixed behavior of externalSymbolLinkMappings option when URL is set to #, #​2921.
• Fixed broken links within module pages when structure-dir router was used, #​2928.
• Type parameters on JS classes defined with @typedef now correctly handle the constraint, #​2929.
• API: toString on types containing index signatures now behave correctly, #​2917.
• Added @inlineType to the list of tags excluded by default.

v0.28.1

Compare Source

Features

• Object properties declared with shorthand property assignment will now use the variable's comment
  if they do not have their own comment, #​2999.

Bug Fixes

• Fixed link resolution not working correctly in first comment on the file in some cases, #​2994.
• Optional methods are now rendered with a trailing ? in the reflection preview and signature, #​2995.
• The compilerOptions option now functions properly with non-boolean options, #​3000.
• Configuration errors within the compilerOptions option are now handled gracefully, #​3000.
• Fixed improper casing of "Type Declaration" header, #​3002.

v0.28.0

Compare Source

Breaking Changes

• TypeDoc now expects all input globs paths to be specified with / path separators, #​2825.
• TypeDoc's --entryPointStrategy merge mode now requires JSON from at least version 0.28.0.
• Removed jp translations from lang, to migrate switch to ja.
• File name references in intentionallyNotExported now use a package name/package relative path instead of an absolute path for matching.
• The source-order sort ordering now considers package names / package relative paths instead of using the absolute paths to a file.
• TypeDoc will only check for a project README file next to the discovered package.json file if --readme is not set
  this change improves handling of monorepo setups where some packages have readme files and others do not, #​2875.
• Function-like variable exports will now only be automatically converted as function types if
  they are initialized with a function expression. TypeDoc can be instructed to convert them as functions
  with the @function tag, #​2881.
• Object literal type alias types will now be converted in a way which causes them to be rendered more similarly
  to how interfaces are rendered, #​2817.

API Breaking Changes

• ProjectReflection.getReflectionFromSymbol and ProjectReflection.getSymbolFromReflection have been moved to Context
• Path and PathArray parameter types now always contain normalized paths.
• Introduced a Router which is used for URL creation. Reflection.url,
  Reflection.anchor, and Reflection.hasOwnDocument have been removed.
• Deserializer.reviveProject(s) no longer accepts an option to add project documents.
• Deserializer.reviveProjects now requires an alwaysCreateEntryPointModule option.
• Comment.serializeDisplayParts no longer requires a serializer argument.
• ReflectionSymbolId.fileName is now optional, TypeDoc now stores a combination of a package name and package relative path instead.
  The fileName property will be present when initially created, but is not serialized.
• Removed DeclarationReflection.relevanceBoost attribute which was added for plugins, but never used.
• i18n proxy is no longer passed to many functions, instead, reference i18n exported from the module directly.
• ReflectionKind.singularString and ReflectionKind.pluralString now returns translated strings.
  The methods on Internationalization to do this previously have been removed.
• The HTML output structure for the search box has changed to support the new modal.
• DefaultThemeRenderContext's typeDeclaration and typeDetailsIfUseful
  methods now require both a reflection and a type in order to support
  @expandType

Features

• Add support for TypeScript 5.8.x
• The search modal in the HTML output has been rewritten to provide better mobile support
• Added a --router option which can be used to modify TypeDoc's output folder
  structure. This can be extended with plugins, #​2111.
• Introduced the @primaryExport modifier tag to provide more fine grained
  control over export conversion order, #​2856
• Introduced packagesRequiringDocumentation option for validation.notDocumented, TypeDoc will expect comments to be present for symbols in the specified packages.
• TypeDoc now exports a typedoc/browser entrypoint for parsing and using serialized JSON files, #​2528.
• Type packageOptions as Partial<TypeDocOptions>, #​2878.
• TypeDoc will now warn if an option which should only be set at the root level is set in packageOptions, #​2878.
• Introduced @function tag to force TypeDoc to convert variable declarations with a type annotation as functions, #​2881.
• Exposed a TypeDoc global object in the HTML theme which can be used to prevent TypeDoc from using localStorage, #​2872.
• Introduced @preventInline and @inlineType tags for further control extending the @inline tag, #​2862.
• Introduced @preventExpand and @expandType tags for further control extending the @expand tag, #​2862.
• API: Introduced DefaultThemeRenderContext.reflectionIcon for more granular control over displayed reflection icons.

Bug Fixes

• TypeDoc will now only create references for symbols re-exported from modules.
• Variable-functions will now prefer placing the comment on the signature if there is only one signature present, #​2824.
• User filter settings will no longer sometimes cause the search to have fewer visible results than expected.
• Fixed handling of expando functions which were also merged with a namespace, #​2876.
• Fixed rendering of function types within arrays and union types, #​2892.
• Fixed an issue where if the theme JS didn't load, the page wouldn't be shown, #​2894.

Thanks!

• @​crimx
• @​jsmith2-coveo
• @​phoneticallySAARTHaK
• @​XeroAlpha

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.

[renovate]

⚠️ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

• any of the package files in this branch needs updating, or
• the branch becomes conflicted, or
• you click the rebase/retry checkbox if found above, or
• you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: package-lock.json

npm warn Unknown env config "store". This will stop working in the next major version of npm.
npm error code ERESOLVE
npm error ERESOLVE could not resolve
npm error
npm error While resolving: [email protected]
npm error Found: [email protected]
npm error node_modules/typedoc
npm error   dev typedoc@"0.28.12" from the root project
npm error
npm error Could not resolve dependency:
npm error peer typedoc@"0.26.x || 0.27.x" from [email protected]
npm error node_modules/typedoc-plugin-missing-exports
npm error   dev typedoc-plugin-missing-exports@"3.1.0" from the root project
npm error
npm error Conflicting peer dependency: [email protected]
npm error node_modules/typedoc
npm error   peer typedoc@"0.26.x || 0.27.x" from [email protected]
npm error   node_modules/typedoc-plugin-missing-exports
npm error     dev typedoc-plugin-missing-exports@"3.1.0" from the root project
npm error
npm error Fix the upstream dependency conflict, or retry
npm error this command with --force or --legacy-peer-deps
npm error to accept an incorrect (and potentially broken) dependency resolution.
npm error
npm error
npm error For a full report see:
npm error /runner/cache/others/npm/_logs/2025-09-01T08_46_18_290Z-eresolve-report.txt
npm error A complete log of this run can be found in: /runner/cache/others/npm/_logs/2025-09-01T08_46_18_290Z-debug-0.log

[renovate]

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.06%. Comparing base (2d7eecb) to head (1d48a94).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5887   +/-   ##
=======================================
  Coverage   95.06%   95.06%           
=======================================
  Files         307      307           
  Lines        8031     8031           
  Branches     1627     1627           
=======================================
  Hits         7635     7635           
  Misses        396      396           

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.