build(deps): bump typedoc from 0.26.3 to 0.28.1

[dependabot]

Bumps typedoc from 0.26.3 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.a, < 0.27]

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.

---

Note: Dependabot was ignoring updates to this dependency, but since you've updated it yourself we've started tracking it for you again. 🤖

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)

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
fuels-template	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 6, 2025 7:41pm
ts-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 6, 2025 7:41pm
ts-docs-api	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 6, 2025 7:41pm

[github-actions]

Temporary PR

This PR is published in AWS CodeArtifact with version: pr-3831

Install using the below commands — create-fuels variations are commented out.

PNPM

pnpm config set registry https://npm-packages.fuel.network/ --global
pnpm install fuels@pr-3831
# pnpm create fuels@pr-3831

NPM

npm --registry=https://npm-packages.fuel.network/ install fuels@pr-3831
# npm --registry=https://npm-packages.fuel.network/ create fuels@pr-3831

Bun

npm_config_registry=https://npm-packages.fuel.network/ bun install fuels@pr-3831
# npm_config_registry=https://npm-packages.fuel.network/ bun create fuels@pr-3831

[dependabot]

OK, I won't notify you again about this release, but will get in touch when a new version is available. If you'd rather skip all updates until the next major or minor version, let me know by commenting @dependabot ignore this major version or @dependabot ignore this minor version. You can also ignore all major, minor, or patch releases for a dependency by adding an ignore condition with the desired update_types to your config file.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.

[github-actions]

Coverage Report:

Lines	Branches	Functions	Statements
77.36%(+0%)	71%(+0%)	75.44%(+0%)	77.36%(+0%)

Changed Files:

Coverage values did not change👌.

[petertonysmith94]

Closed in favour of manual upgrades:

• Considering disabling dependabot for lib upgrades #3828

[petertonysmith94]

Closed in favour of manual upgrades:

• Considering disabling dependabot for lib upgrades #3828