This is an automated email from the ASF dual-hosted git repository.
kou pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-js.git
The following commit(s) were added to refs/heads/main by this push:
new f43c01d chore: bump typedoc from 0.28.13 to 0.28.17 (#397)
f43c01d is described below
commit f43c01dd84ec189d1ec8c004779d30da03944aed
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
AuthorDate: Thu Mar 5 11:30:29 2026 +0900
chore: bump typedoc from 0.28.13 to 0.28.17 (#397)
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.28.13 to
0.28.17.
<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.17</h2>
<h3>Bug Fixes</h3>
<ul>
<li>Improved handling of comments for type aliases which have been
declaration merged with functions, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3064";>#3064</a>.</li>
<li>Fixed anchor link generation to members named <code>$</code>, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3065";>#3065</a>.</li>
<li>Corrected typing of the <code>plugin</code> option to permit
functions, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3066";>#3066</a>.</li>
<li>Warnings about unused <code>@param</code> tags will now be properly
suppressed when they come from declaration files and
the suppressCommentWarningsInDeclarationFiles option is enabled, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3070";>#3070</a>.</li>
<li>Fixed conversion of types referencing type parameters on functions,
<a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3071";>#3071</a>.</li>
</ul>
<h3>Thanks!</h3>
<ul>
<li><a href="https://github.com/pjeby";><code>@pjeby</code></a></li>
</ul>
<h2>v0.28.16</h2>
<h3>Bug Fixes</h3>
<ul>
<li>Fixed an issue causing TypeDoc to fail to generate documentation
when implementing interfaces, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3052";>#3052</a>.</li>
<li>Fixed an issue preventing automatic entry point discovery on
Windows, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3057";>#3057</a>.</li>
<li>Improved vertical positioning of text icons, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3056";>#3056</a>.</li>
<li>TypeDoc no longer includes source location information for type
literal reflections. This could sometimes
cause TypeDoc to infer the wrong path when resolving base paths for
display.</li>
<li>Adjusted markdown rendering to allow <code>markdownItLoader</code>
to override more rendering <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3055";>#3055</a>.</li>
</ul>
<h3>Features</h3>
<ul>
<li>Added support for regions for <code>@include</code> in
<code>.tsx</code>, <code>.cjs</code>, and <code>.mjs</code> file
references <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3048";>#3048</a>.</li>
<li>Comments for TS-in-JS <code>@typedef</code> tags may now specify
modifier tags with the inline tag syntax <code>{@mod}</code>.
This makes it possible to add modifier tags to these members, which
previously was not possible as
TypeScript's parsing stops for these members at the next non-braced tag,
<a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2916";>#2916</a>
and <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3050";>#3050</a>.</li>
<li>A <code>typedoc-config.schema.json</code> is now included in the
root of the package with a JSON schema for TypeDoc's
configuration file. The schema for the latest version is also published
at <a
href="https://typedoc.org/schema.json";>https://typedoc.org/schema.json</a>
and will automatically be picked up when writing typedoc.json files if
you are using VSCode, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3054";>#3054</a>.</li>
</ul>
<h3>Thanks!</h3>
<ul>
<li><a href="https://github.com/a10nik";><code>@a10nik</code></a></li>
<li><a href="https://github.com/kozi";><code>@kozi</code></a></li>
<li><a href="https://github.com/Lakuna";><code>@Lakuna</code></a></li>
</ul>
<h2>v0.28.15</h2>
<h3>Features</h3>
<ul>
<li>The <code>gitRevision</code> option now accepts the special value
<code>{branch}</code>, which indicates source links should use
the current git branch for links, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3041";>#3041</a>.</li>
<li>Introduced <code>validation.invalidPath</code> for suppressing
warnings caused by referencing relative paths which
do not exist when building the documentation, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3033";>#3033</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.17 (2026-02-13)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>Improved handling of comments for type aliases which have been
declaration merged with functions, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3064";>#3064</a>.</li>
<li>Fixed anchor link generation to members named <code>$</code>, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3065";>#3065</a>.</li>
<li>Corrected typing of the <code>plugin</code> option to permit
functions, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3066";>#3066</a>.</li>
<li>Warnings about unused <code>@param</code> tags will now be properly
suppressed when they come from declaration files and
the suppressCommentWarningsInDeclarationFiles option is enabled, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3070";>#3070</a>.</li>
<li>Fixed conversion of types referencing type parameters on functions,
<a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3071";>#3071</a>.</li>
</ul>
<h3>Thanks!</h3>
<ul>
<li><a href="https://github.com/pjeby";><code>@pjeby</code></a></li>
</ul>
<h2>v0.28.16 (2026-01-12)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>Fixed an issue causing TypeDoc to fail to generate documentation
when implementing interfaces, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3052";>#3052</a>.</li>
<li>Fixed an issue preventing automatic entry point discovery on
Windows, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3057";>#3057</a>.</li>
<li>Improved vertical positioning of text icons, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3056";>#3056</a>.</li>
<li>TypeDoc no longer includes source location information for type
literal reflections. This could sometimes
cause TypeDoc to infer the wrong path when resolving base paths for
display.</li>
<li>Adjusted markdown rendering to allow <code>markdownItLoader</code>
to override more rendering <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3055";>#3055</a>.</li>
</ul>
<h3>Features</h3>
<ul>
<li>Added support for regions for <code>@include</code> in
<code>.tsx</code>, <code>.cjs</code>, and <code>.mjs</code> file
references <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3048";>#3048</a>.</li>
<li>Comments for TS-in-JS <code>@typedef</code> tags may now specify
modifier tags with the inline tag syntax <code>{@mod}</code>.
This makes it possible to add modifier tags to these members, which
previously was not possible as
TypeScript's parsing stops for these members at the next non-braced tag,
<a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/2916";>#2916</a>
and <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3050";>#3050</a>.</li>
<li>A <code>typedoc-config.schema.json</code> is now included in the
root of the package with a JSON schema for TypeDoc's
configuration file. The schema for the latest version is also published
at <a
href="https://typedoc.org/schema.json";>https://typedoc.org/schema.json</a>
and will automatically be picked up when writing typedoc.json files if
you are using VSCode, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3054";>#3054</a>.</li>
</ul>
<h3>Thanks!</h3>
<ul>
<li><a href="https://github.com/a10nik";><code>@a10nik</code></a></li>
<li><a href="https://github.com/kozi";><code>@kozi</code></a></li>
<li><a href="https://github.com/Lakuna";><code>@Lakuna</code></a></li>
</ul>
<h2>v0.28.15 (2025-11-29)</h2>
<h3>Features</h3>
<ul>
<li>The <code>gitRevision</code> option now accepts the special value
<code>{branch}</code>, which indicates source links should use
the current git branch for links, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3041";>#3041</a>.</li>
<li>Introduced <code>validation.invalidPath</code> for suppressing
warnings caused by referencing relative paths which
do not exist when building the documentation, <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3033";>#3033</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/882cfb95ad97af81d98d10b4850967819d898477";><code>882cfb9</code></a>
Update changelog for release</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/89dda48e93879da0e4ddaf13d7a2a43c922389a7";><code>89dda48</code></a>
Bump version to 0.28.17</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/5ac59d8989f9c5cef69f3acc7f221e630dbc64c2";><code>5ac59d8</code></a>
Slightly improve docs for plugin creation</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/6f5938947bc30580141fd4087da882dc929ff465";><code>6f59389</code></a>
Update example dependencies</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/977c604e78577f1aea8bd44ee4fb9b436737487f";><code>977c604</code></a>
Fix <a
href="https://redirect.github.com/TypeStrong/TypeDoc/issues/3070";>#3070</a></li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/6aba264042da6ac3e70b497a9d7871b3fdb7ec88";><code>6aba264</code></a>
Fix OIDC published plugins author links on site</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/9574e72d178596de0bd526764000e2d80d049a57";><code>9574e72</code></a>
Fix substitution types</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/2e1967b0a16b05818d06e9771ec99ac8786ffb10";><code>2e1967b</code></a>
Even more docs</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/56274747a6a140e4878f700c8cca3033275617da";><code>5627474</code></a>
Fix formatting</li>
<li><a
href="https://github.com/TypeStrong/typedoc/commit/f97ec69527ba66a11f5c7012bdb76dfa064b9d54";><code>f97ec69</code></a>
Improve docs for declaration references</li>
<li>Additional commits viewable in <a
href="https://github.com/TypeStrong/TypeDoc/compare/v0.28.13...v0.28.17";>compare
view</a></li>
</ul>
</details>
<details>
<summary>Maintainer changes</summary>
<p>This version was pushed to npm by [GitHub Actions](<a
href="https://www.npmjs.com/~GitHub";>https://www.npmjs.com/~GitHub</a>
Actions), a new releaser for typedoc since your current version.</p>
</details>
<br />
[](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 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>
---
package-lock.json | 54 +++++++++++++++++++++++++++---------------------------
package.json | 2 +-
2 files changed, 28 insertions(+), 28 deletions(-)
diff --git a/package-lock.json b/package-lock.json
index 7ca064a..a8f5540 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -66,7 +66,7 @@
"rollup": "4.59.0",
"rxjs": "7.8.2",
"ts-jest": "29.1.4",
- "typedoc": "0.28.13",
+ "typedoc": "0.28.17",
"typescript": "5.4.5",
"typescript-eslint": "8.54.0",
"vinyl-buffer": "1.0.1",
@@ -1436,16 +1436,16 @@
}
},
"node_modules/@gerrit0/mini-shiki": {
- "version": "3.12.2",
- "resolved":
"https://registry.npmjs.org/@gerrit0/mini-shiki/-/mini-shiki-3.12.2.tgz";,
- "integrity":
"sha512-HKZPmO8OSSAAo20H2B3xgJdxZaLTwtlMwxg0967scnrDlPwe6j5+ULGHyIqwgTbFCn9yv/ff8CmfWZLE9YKBzA==",
+ "version": "3.23.0",
+ "resolved":
"https://registry.npmjs.org/@gerrit0/mini-shiki/-/mini-shiki-3.23.0.tgz";,
+ "integrity":
"sha512-bEMORlG0cqdjVyCEuU0cDQbORWX+kYCeo0kV1lbxF5bt4r7SID2l9bqsxJEM0zndaxpOUT7riCyIVEuqq/Ynxg==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@shikijs/engine-oniguruma": "^3.12.2",
- "@shikijs/langs": "^3.12.2",
- "@shikijs/themes": "^3.12.2",
- "@shikijs/types": "^3.12.2",
+ "@shikijs/engine-oniguruma": "^3.23.0",
+ "@shikijs/langs": "^3.23.0",
+ "@shikijs/themes": "^3.23.0",
+ "@shikijs/types": "^3.23.0",
"@shikijs/vscode-textmate": "^10.0.2"
}
},
@@ -3403,40 +3403,40 @@
}
},
"node_modules/@shikijs/engine-oniguruma": {
- "version": "3.12.2",
- "resolved":
"https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.12.2.tgz";,
- "integrity":
"sha512-hozwnFHsLvujK4/CPVHNo3Bcg2EsnG8krI/ZQ2FlBlCRpPZW4XAEQmEwqegJsypsTAN9ehu2tEYe30lYKSZW/w==",
+ "version": "3.23.0",
+ "resolved":
"https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.23.0.tgz";,
+ "integrity":
"sha512-1nWINwKXxKKLqPibT5f4pAFLej9oZzQTsby8942OTlsJzOBZ0MWKiwzMsd+jhzu8YPCHAswGnnN1YtQfirL35g==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@shikijs/types": "3.12.2",
+ "@shikijs/types": "3.23.0",
"@shikijs/vscode-textmate": "^10.0.2"
}
},
"node_modules/@shikijs/langs": {
- "version": "3.12.2",
- "resolved":
"https://registry.npmjs.org/@shikijs/langs/-/langs-3.12.2.tgz";,
- "integrity":
"sha512-bVx5PfuZHDSHoBal+KzJZGheFuyH4qwwcwG/n+MsWno5cTlKmaNtTsGzJpHYQ8YPbB5BdEdKU1rga5/6JGY8ww==",
+ "version": "3.23.0",
+ "resolved":
"https://registry.npmjs.org/@shikijs/langs/-/langs-3.23.0.tgz";,
+ "integrity":
"sha512-2Ep4W3Re5aB1/62RSYQInK9mM3HsLeB91cHqznAJMuylqjzNVAVCMnNWRHFtcNHXsoNRayP9z1qj4Sq3nMqYXg==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@shikijs/types": "3.12.2"
+ "@shikijs/types": "3.23.0"
}
},
"node_modules/@shikijs/themes": {
- "version": "3.12.2",
- "resolved":
"https://registry.npmjs.org/@shikijs/themes/-/themes-3.12.2.tgz";,
- "integrity":
"sha512-fTR3QAgnwYpfGczpIbzPjlRnxyONJOerguQv1iwpyQZ9QXX4qy/XFQqXlf17XTsorxnHoJGbH/LXBvwtqDsF5A==",
+ "version": "3.23.0",
+ "resolved":
"https://registry.npmjs.org/@shikijs/themes/-/themes-3.23.0.tgz";,
+ "integrity":
"sha512-5qySYa1ZgAT18HR/ypENL9cUSGOeI2x+4IvYJu4JgVJdizn6kG4ia5Q1jDEOi7gTbN4RbuYtmHh0W3eccOrjMA==",
"dev": true,
"license": "MIT",
"dependencies": {
- "@shikijs/types": "3.12.2"
+ "@shikijs/types": "3.23.0"
}
},
"node_modules/@shikijs/types": {
- "version": "3.12.2",
- "resolved":
"https://registry.npmjs.org/@shikijs/types/-/types-3.12.2.tgz";,
- "integrity":
"sha512-K5UIBzxCyv0YoxN3LMrKB9zuhp1bV+LgewxuVwHdl4Gz5oePoUFrr9EfgJlGlDeXCU1b/yhdnXeuRvAnz8HN8Q==",
+ "version": "3.23.0",
+ "resolved":
"https://registry.npmjs.org/@shikijs/types/-/types-3.23.0.tgz";,
+ "integrity":
"sha512-3JZ5HXOZfYjsYSk0yPwBrkupyYSLpAE26Qc0HLghhZNGTZg/SKxXIIgoxOpmmeQP0RRSDJTk1/vPfw9tbw+jSQ==",
"dev": true,
"license": "MIT",
"dependencies": {
@@ -12822,13 +12822,13 @@
}
},
"node_modules/typedoc": {
- "version": "0.28.13",
- "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.28.13.tgz";,
- "integrity":
"sha512-dNWY8msnYB2a+7Audha+aTF1Pu3euiE7ySp53w8kEsXoYw7dMouV5A1UsTUY345aB152RHnmRMDiovuBi7BD+w==",
+ "version": "0.28.17",
+ "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.28.17.tgz";,
+ "integrity":
"sha512-ZkJ2G7mZrbxrKxinTQMjFqsCoYY6a5Luwv2GKbTnBCEgV2ihYm5CflA9JnJAwH0pZWavqfYxmDkFHPt4yx2oDQ==",
"dev": true,
"license": "Apache-2.0",
"dependencies": {
- "@gerrit0/mini-shiki": "^3.12.0",
+ "@gerrit0/mini-shiki": "^3.17.0",
"lunr": "^2.3.9",
"markdown-it": "^14.1.0",
"minimatch": "^9.0.5",
diff --git a/package.json b/package.json
index 089cf08..06b74dc 100644
--- a/package.json
+++ b/package.json
@@ -100,7 +100,7 @@
"rollup": "4.59.0",
"rxjs": "7.8.2",
"ts-jest": "29.1.4",
- "typedoc": "0.28.13",
+ "typedoc": "0.28.17",
"typescript": "5.4.5",
"typescript-eslint": "8.54.0",
"vinyl-buffer": "1.0.1",
