build(deps-dev): bump typedoc from 0.27.9 to 0.28.1

[dependabot]

Bumps typedoc from 0.27.9 to 0.28.1.

Release notes

Sourced from typedoc's releases.

v0.28.1

Features

• The TypeDocOptions interface now marks options as optional so it no longer has to be wrapped in Partial for use in config files, #2901.
• API: Expose control methods for deferred conversion for plugin use (typedoc-plugin-missing-exports)
• API: Expose method to disable TypeDoc usage of localStorage without clearing it, #2908.

Bug Fixes

• --watch can now infer entry points from package.json as supported in non-watch mode, #2899.
• @include with regions now works on files with CRLF line endings, #2902.
• Generated page names now correctly handles UTF-8 characters requiring more than 16 bits #2905.
• Fixed a crash when converting module.exports = [], #2909.
• Fixed URL generation which introduced a superfluous ./ in relative links, #2910.

Thanks!

• @​jsmith2-coveo
• @​romainmnr

v0.28.0

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.

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.28.1 (2025-03-20)

Features

• The TypeDocOptions interface now marks options as optional so it no longer has to be wrapped in Partial for use in config files, #2901.
• API: Expose control methods for deferred conversion for plugin use (typedoc-plugin-missing-exports)
• API: Expose method to disable TypeDoc usage of localStorage without clearing it, #2908.

Bug Fixes

• --watch can now infer entry points from package.json as supported in non-watch mode, #2899.
• @include with regions now works on files with CRLF line endings, #2902.
• Generated page names now correctly handles UTF-8 characters requiring more than 16 bits #2905.
• Fixed a crash when converting module.exports = [], #2909.
• Fixed URL generation which introduced a superfluous ./ in relative links, #2910.

Thanks!

• @​jsmith2-coveo
• @​romainmnr

v0.28.0 (2025-03-15)

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.

... (truncated)

Commits

• 6090b3e Update changelog for release
• 6421662 Release v0.28.1
• c7ac719 Update changelog
• a49c6c8 Make clearing TypeDoc fields from local storage optional (#2908)
• b53a220 Fix #2910
• 34ce994 Fix crash when converting array from module.exports
• 2d95afa Merge pull request #2906 from romainmnr/master
• df1033f style: remove useless spaces
• c421520 text(createNormalizedUrl): add UTF8 & emoji tests
• 383e164 fix(createNormalizedUrl): replace String.fromCharCode by String.fromCodePoint
• Additional commits viewable in compare view

Most Recent Ignore Conditions Applied to This Pull Request

Dependency Name	Ignore Conditions
typedoc	[< 0.26, > 0.25.0]

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

[coderabbitai]

Important

Review skipped

Ignore keyword(s) in the title.

⛔ Ignored keywords (1)

• build(

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[dependabot]

Superseded by #2960.