chore(deps-dev): bump the docusaurus group across 1 directory with 3 updates

[dependabot]

Bumps the docusaurus group with 1 update in the /docs directory: docusaurus-plugin-typedoc.

Updates docusaurus-plugin-typedoc from 1.0.5 to 1.1.1

Changelog

Sourced from docusaurus-plugin-typedoc's changelog.

1.1.1 (2024-12-03)

Patch Changes

• Allow additional plugins to be loaded via the "plugin" key.

1.1.0 (2024-11-27)

Minor Changes

• [email protected] / [email protected] support

Commits

• d7ea67e Version Packages
• 5ba16e7 fix(docusaurus): allow additional typedoc plugins to load
• 292b7be chore(docs): updated changelog dates
• 6f80d78 Version Packages
• 4d466c9 chore(all): prepare sub-packages
• 19c21a3 Version Packages
• fbfd19b chore(all): final output tweaks
• 5e95bba chore(core): updated docs
• a667e80 chore(all): updated typedoc
• 78f246b chore(all): convert to esm / TypeDoc 0.27 fixes
• Additional commits viewable in compare view

Updates typedoc from 0.26.11 to 0.27.4

Release notes

Sourced from typedoc's releases.

v0.27.4

Features

• API: Introduced new Converter.EVENT_CREATE_PROJECT event which fires when a project is created by the converter, #2800.

Bug Fixes

• Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, #2796.
• @include and @includeCode now work for comments on the entry point for projects with a single entry point, #2800.
• Cascaded modifier tags will no longer be copied into type literals, #2802.
• @summary now works to describe functions within modules, #2803.
• Corrected navigation showing module link as current when not on module page, #2805.

v0.27.3

Features

• Added support for PNG favicons, #2790.
• Improved support for hosting TypeDoc with strict Content Security Policy rules, #2794.

Bug Fixes

• Add special handling for import types with type errors discarded with ts-expect-error, #2792.
• Fixed low contrast in default colors for properties/accessors in light mode, #2795.
• The highlightLanguages option now permits Shiki aliases to be specified rather than just the language ID, #2798.

Thanks!

• @​mikalai-snap
• @​mistic100

v0.27.2

Bug Fixes

• Fix crash with TypeScript 5.5.x, #2789.

v0.27.1

Bug Fixes

• Include classes which inherit from another package in class hierarchy in packages mode, #2467.
• Fixed handling of @categoryDescription and @groupDescription on module pages, #2787.
• Fixed automatic discovery of entry points in packages mode.
• Reverted accidental style change for hierarchy page introduced in 0.27.0
• The hierarchy Expand/Collapse link will now only appear if the hierarchies are different.

v0.27.0 (2024-11-27)

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.27.4 (2024-12-09)

Features

• API: Introduced new Converter.EVENT_CREATE_PROJECT event which fires when a project is created by the converter, #2800.

Bug Fixes

• Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, #2796.
• @include and @includeCode now work for comments on the entry point for projects with a single entry point, #2800.
• Cascaded modifier tags will no longer be copied into type literals, #2802.
• @summary now works to describe functions within modules, #2803.
• Corrected navigation showing module link as current when not on module page, #2805.

v0.27.3 (2024-12-04)

Features

• Added support for PNG favicons, #2790.
• Improved support for hosting TypeDoc with strict Content Security Policy rules, #2794.

Bug Fixes

• Add special handling for import types with type errors discarded with ts-expect-error, #2792.
• Fixed low contrast in default colors for properties/accessors in light mode, #2795.
• The highlightLanguages option now permits Shiki aliases to be specified rather than just the language ID, #2798.

Thanks!

• @​mikalai-snap
• @​mistic100

v0.27.2 (2024-11-29)

Bug Fixes

• Fix crash with TypeScript 5.5.x, #2789.

v0.27.1 (2024-11-28)

Bug Fixes

• Include classes which inherit from another package in class hierarchy in packages mode, #2467.
• Fixed handling of @categoryDescription and @groupDescription on module pages, #2787.
• Fixed automatic discovery of entry points in packages mode.
• Reverted accidental style change for hierarchy page introduced in 0.27.0
• The hierarchy Expand/Collapse link will now only appear if the hierarchies are different.

v0.27.0 (2024-11-27)

... (truncated)

Commits

• 0879c5b Update changelog for release
• 6f2a480 Bump version to 0.27.4
• cf901f4 Fix current location check for index page
• 8680728 Exclude site plugin from linting
• 88b8f2b Add special case for rendering @summary for functions
• b35cfd2 Remove unnecessary test
• c3bc0da Reduce manually maintained duplication in generated site
• 344d4bf Handle @include tags on entry point project
• ed1ac7a Switch from gzip to deflate for compression
• 9dcbd5d Fix handling of cascadedModifierTags
• Additional commits viewable in compare view

Updates typedoc-plugin-markdown from 4.2.10 to 4.3.2

Release notes

Sourced from typedoc-plugin-markdown's releases.

[email protected]

Patch Changes

• Enable {@link} resolution on type alias properties (#732).
• Remove superfluous name attribute when "useHtmlAnchors" is true..
• Escape characters inside @link tags.
• Fixed spacing around inline object declarations.
• Always expose type arguments of reference types as per default theme (#733).

[email protected]

Patch Changes

• Expose type declarations to array types.
• Correctly wrap array of unions in parenthesis (#719).
• Omit inline parameter declarations when not useful (#720).

[email protected]

Minor Changes

• Implemented typedoc 0.27 compatibility support.
• Exposed "typeDeclarationVisibility" option to provide a "compact" output structure (#703).
• Exposed "pageTitleTemplates" option that accepts a string with placeholder or function arguments to control page titles (#715).
• Exposed formatting with prettier options "formatWithPrettier" and "prettierConfigFile" that enables additional formatting of output if Prettier is installed on a project.

Patch Changes

• Improved structure of curried and overloaded signatures (#714) (#718)
• The "hideGroupHeadings" option respects group order (#716)
• Handle Optional types correctly (#719).

Changelog

Sourced from typedoc-plugin-markdown's changelog.

4.3.2 (2024-12-08)

Patch Changes

• Enable {@link} resolution on type alias properties (#732).
• Remove superfluous name attribute when "useHtmlAnchors" is true..
• Escape characters inside @link tags.
• Fixed spacing around inline object declarations.
• Always expose type arguments of reference types as per default theme (#733).

4.3.1 (2024-12-01)

Patch Changes

• Expose type declarations to array types.
• Correctly wrap array of unions in parenthesis (#719).
• Omit inline parameter declarations when not useful (#720).

4.3.0 (2024-11-27)

This release introduces support for TypeDoc 0.27 and some additional UX features and improvements in addition to some bug fixes.

Architectural Changes

Please see the full TypeDoc changelog for additional information.

There are two TypeDoc breaking changes that might effect users of this plugin:

• TypeDoc has converted to ESM and therefore all public and local CommonJs plugins will need to be refactored to ESM.
• TypeScript <5.0 is no longer supported.

Structural Changes

• Parameters list views have been updated to separate params with markdown headings to improve readability when parameters have detailed explanations examples, or sub-properties. If parameters are straightforward and few in number switching to parametersFormat=table might be preferable.
• Improved structure of curried and overloaded signatures.
• Page headings have been simplified to simply display project title as per default theme.

New Features

• Exposed formatting with prettier options "formatWithPrettier" and "prettierConfigFile" that enables additional formatting of Markdown if Prettier is installed on a project.
• Exposed "typeDeclarationVisibility" option to provide a "compact" output structure (#703).
• Exposed "pageTitleTemplates" option that accepts a string with placeholder or function arguments to control page titles (#715).

Patch Changes

• Improved structure of curried and overloaded signatures (#714) (#718)
• The "hideGroupHeadings" option respects group order (#716)
• Handle Optional types correctly (#719).

Commits

• bfb1c60 Version Packages
• 43df8b1 chore(docs): updated typedoc option paths
• f39b42b fix(core): always expose type arguments of reference types as per default theme
• 27caafc chore(docs): updated packages
• ffaa2cd fix(core): enable @link resolution on type alias properties
• 05197cc fix(core): fixed spacing around inline object declarations
• 65ddaff fix(core): escape chars inside @link tags
• 11b5000 chore(all): updated packages
• b2db92c chore(docs): updated docs
• 2619301 chore(docs): updated docs
• Additional commits viewable in compare view

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 <dependency name> major version will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself)
• @dependabot ignore <dependency name> minor version will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself)
• @dependabot ignore <dependency name> will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself)
• @dependabot unignore <dependency name> will remove all of the ignore conditions of the specified dependency
• @dependabot unignore <dependency name> <ignore condition> will remove the ignore condition of the specified dependency and ignore conditions

[zimeg]

@dependabot recreate

[zimeg]

Hmmm... typedoc should've been bumped here I think?

[zimeg]

I'm noticing typedoc-plugin-markdown also isn't being bumped, but both of the latest versions are included in package-lock.json 🤔

Hoping another "recreate" attempt in a few days might fix this! I thought the added >= was confusing but the dependency below kept ^ without receiving an update...

[zimeg]

FWIW that might be unrelated to current build failures related to the sidebar here:

https://github.com/slackapi/node-slack-sdk/actions/runs/12324871475/job/34403193412#step:5:10

../packages/socket-mode/tsconfig.json:15:14 - error TS6053: File '@tsconfig/recommended/tsconfig.json' not found.

15   "extends": "@tsconfig/recommended/tsconfig.json",

[zimeg]

📝 To reduce some stress on the immediate breaking build here:

...we'll be moving away from the typedoc docusaurus plugin long term...

#2122 (review)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.89%. Comparing base (637fca2) to head (7734b5e).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2123   +/-   ##
=======================================
  Coverage   91.89%   91.89%           
=======================================
  Files          38       38           
  Lines       10320    10320           
  Branches      649      649           
=======================================
  Hits         9484     9484           
  Misses        824      824           
  Partials       12       12           

Flag	Coverage Δ
cli-hooks	95.24% <ø> (ø)
cli-test	94.48% <ø> (ø)
oauth	77.39% <ø> (ø)
socket-mode	61.82% <ø> (ø)
web-api	96.88% <ø> (ø)
webhook	96.65% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

[zimeg]

@dependabot recreate

[dependabot]

Superseded by #2126.