Bump typedoc from 0.27.9 to 0.28.0 (#6)

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.27.9 to
0.28.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/TypeStrong/TypeDoc/releases">typedoc's
releases</a>.</em></p>
<blockquote>
<h2>v0.28.0</h2>
<h3>Breaking Changes</h3>
<ul>
<li>TypeDoc now expects all input globs paths to be specified with
<code>/</code> path separators, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2825">#2825</a>.</li>
<li>TypeDoc's <code>--entryPointStrategy merge</code> mode now requires
JSON from at least version 0.28.0.</li>
<li>Removed <code>jp</code> translations from <code>lang</code>, to
migrate switch to <code>ja</code>.</li>
<li>File name references in <code>intentionallyNotExported</code> now
use a package name/package relative path instead of an absolute path for
matching.</li>
<li>The <code>source-order</code> sort ordering now considers package
names / package relative paths instead of using the absolute paths to a
file.</li>
<li>TypeDoc will only check for a project README file next to the
discovered <code>package.json</code> file if <code>--readme</code> is
not set
this change improves handling of monorepo setups where some packages
have readme files and others do not, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2875">#2875</a>.</li>
<li>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 <code>@function</code> tag, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2881">#2881</a>.</li>
<li>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, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2817">#2817</a>.</li>
</ul>
<h3>API Breaking Changes</h3>
<ul>
<li><code>ProjectReflection.getReflectionFromSymbol</code> and
<code>ProjectReflection.getSymbolFromReflection</code> have been moved
to <code>Context</code></li>
<li><code>Path</code> and <code>PathArray</code> parameter types now
always contain normalized paths.</li>
<li>Introduced a <code>Router</code> which is used for URL creation.
<code>Reflection.url</code>,
<code>Reflection.anchor</code>, and
<code>Reflection.hasOwnDocument</code> have been removed.</li>
<li><code>Deserializer.reviveProject(s)</code> no longer accepts an
option to add project documents.</li>
<li><code>Deserializer.reviveProjects</code> now requires an
<code>alwaysCreateEntryPointModule</code> option.</li>
<li><code>Comment.serializeDisplayParts</code> no longer requires a
serializer argument.</li>
<li><code>ReflectionSymbolId.fileName</code> is now optional, TypeDoc
now stores a combination of a package name and package relative path
instead.
The <code>fileName</code> property will be present when initially
created, but is not serialized.</li>
<li>Removed <code>DeclarationReflection.relevanceBoost</code> attribute
which was added for plugins, but never used.</li>
<li><code>i18n</code> proxy is no longer passed to many functions,
instead, reference <code>i18n</code> exported from the module
directly.</li>
<li><code>ReflectionKind.singularString</code> and
<code>ReflectionKind.pluralString</code> now returns translated strings.
The methods on <code>Internationalization</code> to do this previously
have been removed.</li>
<li>The HTML output structure for the search box has changed to support
the new modal.</li>
<li><code>DefaultThemeRenderContext</code>'s
<code>typeDeclaration</code> and <code>typeDetailsIfUseful</code>
methods now require both a reflection and a type in order to support
<code>@expandType</code></li>
</ul>
<h3>Features</h3>
<ul>
<li>Add support for TypeScript 5.8.x</li>
<li>The search modal in the HTML output has been rewritten to provide
better mobile support</li>
<li>Added a <code>--router</code> option which can be used to modify
TypeDoc's output folder
structure. This can be extended with plugins, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2111">#2111</a>.</li>
<li>Introduced the <code>@primaryExport</code> modifier tag to provide
more fine grained
control over export conversion order, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2856">#2856</a></li>
<li>Introduced <code>packagesRequiringDocumentation</code> option for
<code>validation.notDocumented</code>, TypeDoc will expect comments to
be present for symbols in the specified packages.</li>
<li>TypeDoc now exports a <code>typedoc/browser</code> entrypoint for
parsing and using serialized JSON files, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2528">#2528</a>.</li>
<li>Type <code>packageOptions</code> as
<code>Partial&lt;TypeDocOptions&gt;</code>, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2878">#2878</a>.</li>
<li>TypeDoc will now warn if an option which should only be set at the
root level is set in <code>packageOptions</code>, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2878">#2878</a>.</li>
<li>Introduced <code>@function</code> tag to force TypeDoc to convert
variable declarations with a type annotation as functions, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2881">#2881</a>.</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md">typedoc's
changelog</a>.</em></p>
<blockquote>
<h2>v0.28.0 (2025-03-15)</h2>
<h3>Breaking Changes</h3>
<ul>
<li>TypeDoc now expects all input globs paths to be specified with
<code>/</code> path separators, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2825">#2825</a>.</li>
<li>TypeDoc's <code>--entryPointStrategy merge</code> mode now requires
JSON from at least version 0.28.0.</li>
<li>Removed <code>jp</code> translations from <code>lang</code>, to
migrate switch to <code>ja</code>.</li>
<li>File name references in <code>intentionallyNotExported</code> now
use a package name/package relative path instead of an absolute path for
matching.</li>
<li>The <code>source-order</code> sort ordering now considers package
names / package relative paths instead of using the absolute paths to a
file.</li>
<li>TypeDoc will only check for a project README file next to the
discovered <code>package.json</code> file if <code>--readme</code> is
not set
this change improves handling of monorepo setups where some packages
have readme files and others do not, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2875">#2875</a>.</li>
<li>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 <code>@function</code> tag, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2881">#2881</a>.</li>
<li>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, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2817">#2817</a>.</li>
</ul>
<h3>API Breaking Changes</h3>
<ul>
<li><code>ProjectReflection.getReflectionFromSymbol</code> and
<code>ProjectReflection.getSymbolFromReflection</code> have been moved
to <code>Context</code></li>
<li><code>Path</code> and <code>PathArray</code> parameter types now
always contain normalized paths.</li>
<li>Introduced a <code>Router</code> which is used for URL creation.
<code>Reflection.url</code>,
<code>Reflection.anchor</code>, and
<code>Reflection.hasOwnDocument</code> have been removed.</li>
<li><code>Deserializer.reviveProject(s)</code> no longer accepts an
option to add project documents.</li>
<li><code>Deserializer.reviveProjects</code> now requires an
<code>alwaysCreateEntryPointModule</code> option.</li>
<li><code>Comment.serializeDisplayParts</code> no longer requires a
serializer argument.</li>
<li><code>ReflectionSymbolId.fileName</code> is now optional, TypeDoc
now stores a combination of a package name and package relative path
instead.
The <code>fileName</code> property will be present when initially
created, but is not serialized.</li>
<li>Removed <code>DeclarationReflection.relevanceBoost</code> attribute
which was added for plugins, but never used.</li>
<li><code>i18n</code> proxy is no longer passed to many functions,
instead, reference <code>i18n</code> exported from the module
directly.</li>
<li><code>ReflectionKind.singularString</code> and
<code>ReflectionKind.pluralString</code> now returns translated strings.
The methods on <code>Internationalization</code> to do this previously
have been removed.</li>
<li>The HTML output structure for the search box has changed to support
the new modal.</li>
<li><code>DefaultThemeRenderContext</code>'s
<code>typeDeclaration</code> and <code>typeDetailsIfUseful</code>
methods now require both a reflection and a type in order to support
<code>@expandType</code></li>
</ul>
<h3>Features</h3>
<ul>
<li>Add support for TypeScript 5.8.x</li>
<li>The search modal in the HTML output has been rewritten to provide
better mobile support</li>
<li>Added a <code>--router</code> option which can be used to modify
TypeDoc's output folder
structure. This can be extended with plugins, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2111">#2111</a>.</li>
<li>Introduced the <code>@primaryExport</code> modifier tag to provide
more fine grained
control over export conversion order, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2856">#2856</a></li>
<li>Introduced <code>packagesRequiringDocumentation</code> option for
<code>validation.notDocumented</code>, TypeDoc will expect comments to
be present for symbols in the specified packages.</li>
<li>TypeDoc now exports a <code>typedoc/browser</code> entrypoint for
parsing and using serialized JSON files, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2528">#2528</a>.</li>
<li>Type <code>packageOptions</code> as
<code>Partial&lt;TypeDocOptions&gt;</code>, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2878">#2878</a>.</li>
<li>TypeDoc will now warn if an option which should only be set at the
root level is set in <code>packageOptions</code>, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2878">#2878</a>.</li>
<li>Introduced <code>@function</code> tag to force TypeDoc to convert
variable declarations with a type annotation as functions, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2881">#2881</a>.</li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/28f6d6306ab65f9a180c350566218a9100d69915"><code>28f6d63</code></a>
Update changelog for release</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/9ed2e6f5d99775851d9e39c3a59d70e5293d1789"><code>9ed2e6f</code></a>
Bump version to 0.28, upgrade deps</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/de7f969725aa4ad2ebf55d3ad39d5d17e3205cbc"><code>de7f969</code></a>
Fix rendering of index headings</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/4c2712f37e2aa3ccdd36cfd2752df73f4e850280"><code>4c2712f</code></a>
Export new types</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/97de828a8a41d7c20fecc5bcb0f43e0d843a3d75"><code>97de828</code></a>
Update changelog pre-release</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/0f339fa36b8432f7332d68dc284d052f0ad34303"><code>0f339fa</code></a>
Update changelog</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/ceedb737645403f42e67fb8f9f2f989dd8d22225"><code>ceedb73</code></a>
Merge branch 'beta'</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/5eaa1095f53ba3cd5e82c8cf38982e3a2b3bc93c"><code>5eaa109</code></a>
Merge pull request <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2894">#2894</a>
from crimx/patch-1</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/f5d676e56b583d76a40150b41c5ea57e572a6f11"><code>f5d676e</code></a>
Make rendering types more lax</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/309a07cb50dd62f89988ed994545c615b664e66f"><code>309a07c</code></a>
Fix formatting of functions within types</li>
<li>Additional commits viewable in <a
href="https://github.com/TypeStrong/TypeDoc/compare/v0.27.9...v0.28.0">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=typedoc&package-manager=bun&previous-version=0.27.9&new-version=0.28.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

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-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

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)


</details>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Author: dependabot[bot]

package.json

@@ -42,7 +42,7 @@
 		"@total-typescript/tsconfig": "^1.0.4",
 		"@types/bun": "^1.1.6",
 		"consola": "^3.2.3",
-		"typedoc": "^0.27.2",
+		"typedoc": "^0.28.0",
 		"typedoc-plugin-mdn-links": "^5.0.1",
 		"typescript": "^5.5.4"
 	}