Skip to content

[Snyk] Upgrade typedoc from 0.23.28 to 0.28.2 #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Snyk] Upgrade typedoc from 0.23.28 to 0.28.2 #58

wants to merge 1 commit into from

Conversation

patinthehat
Copy link
Member

snyk-top-banner

Snyk has created this PR to upgrade typedoc from 0.23.28 to 0.28.2.

ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.

  • The recommended version is 68 versions ahead of your current version.

  • The recommended version was released a month ago.

Release notes
Package name: typedoc
  • 0.28.2 - 2025-04-07

    Features

    • @ group none and @ category none will now render their children without a section
      heading in the default theme, #2922.
    • Added @ disableGroups tag to completely disable the grouping mechanism for a
      given reflection, #2922.

    Bug Fixes

    • Variables using @ class now correctly handle @ category, #2914.
    • Variables using @ class now include constructor parameters, #2914.
    • Variables using @ class with a generic first constructor function now adopt
      that function's type parameters as the class type parameters, #2914.
    • When printing entry point globs which fail to match any paths, TypeDoc will no longer normalize the glob, #2918.
    • Inlining types can now handle more type variants, #2920.
    • Fixed behavior of externalSymbolLinkMappings option when URL is set to #, #2921.
    • Fixed broken links within module pages when structure-dir router was used, #2928.
    • Type parameters on JS classes defined with @ typedef now correctly handle the constraint, #2929.
    • API: toString on types containing index signatures now behave correctly, #2917.
    • Added @ inlineType to the list of tags excluded by default.
  • 0.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!

  • 0.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.
    • Removed DeclarationReflection.relevanceBoost attribute which was added for plugins, but never used.
    • i18n proxy is no longer passed to many functions, instead, reference i18n exported from the module directly.
    • ReflectionKind.singularString and ReflectionKind.pluralString now returns translated strings.
      The methods on Internationalization to do this previously have been removed.
    • The HTML output structure for the search box has changed to support the new modal.
    • DefaultThemeRenderContext's typeDeclaration and typeDetailsIfUseful
      methods now require both a reflection and a type in order to support
      @ expandType

    Features

    • Add support for TypeScript 5.8.x
    • The search modal in the HTML output has been rewritten to provide better mobile support
    • Added a --router option which can be used to modify TypeDoc's output folder
      structure. This can be extended with plugins, #2111.
    • Introduced the @ primaryExport modifier tag to provide more fine grained
      control over export conversion order, #2856
    • Introduced packagesRequiringDocumentation option for validation.notDocumented, TypeDoc will expect comments to be present for symbols in the specified packages.
    • TypeDoc now exports a typedoc/browser entrypoint for parsing and using serialized JSON files, #2528.
    • Type packageOptions as Partial<TypeDocOptions>, #2878.
    • TypeDoc will now warn if an option which should only be set at the root level is set in packageOptions, #2878.
    • Introduced @ function tag to force TypeDoc to convert variable declarations with a type annotation as functions, #2881.
    • Exposed a TypeDoc global object in the HTML theme which can be used to prevent TypeDoc from using localStorage, #2872.
    • Introduced @ preventInline and @ inlineType tags for further control extending the @ inline tag, #2862.
    • Introduced @ preventExpand and @ expandType tags for further control extending the @ expand tag, #2862.
    • API: Introduced DefaultThemeRenderContext.reflectionIcon for more granular control over displayed reflection icons.

    Bug Fixes

    • TypeDoc will now only create references for symbols re-exported from modules.
    • Variable-functions will now prefer placing the comment on the signature if there is only one signature present, #2824.
    • User filter settings will no longer sometimes cause the search to have fewer visible results than expected.
    • Fixed handling of expando functions which were also merged with a namespace, #2876.
    • Fixed rendering of function types within arrays and union types, #2892.
    • Fixed an issue where if the theme JS didn't load, the page wouldn't be shown, #2894.

    Thanks!

  • 0.28.0-beta.2 - 2025-03-10

    See #2868 (comment) for discussion of changes

  • 0.28.0-beta.1 - 2025-03-01

    See #2868 (comment) for discussion of changes

  • 0.28.0-beta.0 - 2025-02-23

    See #2868 for discussion of changes

  • 0.27.9 - 2025-02-25

    This will be the last v0.27.x release, see #2868 for discussion on the 0.28 beta.

    Features

    • Added support for TypeScript 5.8
  • 0.27.8 - 2025-02-21

    Features

    • The visibilityFilter option now supports individual signatures, #2846.
    • The favicon option may now be given a link starting with https?:// instead of a path, #2851.
    • TypeDoc now supports specifying # as the link in externalSymbolLinkMappings to indicate the type should not be linked to, #2853.

    Bug Fixes

    • Fixed an issue where unrecognized languages would incorrectly be listed in the list of languages with translations, #2852.
    • Unresolved external type references will no longer incorrectly linked to undefined, #2854.

    Thanks!

  • 0.27.7 - 2025-02-09

    Features

    • @ includeCode and @ inline can now inject parts of files using region
      names or line numbers, #2816.
    • Introduced ja translation options, deprecated jp in favor of ja, #2843.
    • Improved TypeDoc's --watch option to support watching files not caught by
      TypeScript's watch mode, #2675.
    • The @ inline tag now works in more places for generic types.
    • Visibility filters now consider individual signatures, #2846.

    Bug Fixes

    • Fixed an issue where TypeDoc would incorrectly ignore type arguments in references, #2823.
    • Improved narrator support for labeling icons, #2832.
    • Fixed an issue with @ class incorrectly handling mapped types, #2842.
    • TypeDoc will now consider symbols to be external only if all of their declarations are external
      so that declaration merged members with global symbols can be documented, #2844.
    • Fixed an issue where TypeDoc would constantly rebuild, #2844.
    • Fixed an issue where the dropdown arrow in the index group would not respect the state of the dropdown, #2845.

    Thanks!

  • 0.27.6 - 2024-12-26

    Features

    • Added ignoredHighlightLanguages option to specify languages which will be
      allowed in code blocks but not highlighted, #2819.

    Bug Fixes

    • @ include and @ includeCode now work in the readme file, #2814.
    • TypeDoc will now avoid making references to references, #2811.
    • Fixed output specific option specification, #2818.
    • Improved type reference conversion to avoid including defaulted type arguments, #2820.
    • Fixed parsing of declaration references which include a module and a local reference, #2810.
    • Improved link resolution logic to prioritize type alias properties with the
      same symbol over type literal properties within function parameters.
  • 0.27.5 - 2024-12-14
  • 0.27.4 - 2024-12-09
  • 0.27.3 - 2024-12-04
  • 0.27.2 - 2024-11-29
  • 0.27.1 - 2024-11-28
  • 0.27.0 - 2024-11-27
  • 0.27.0-beta.2 - 2024-11-25
  • 0.27.0-beta.1 - 2024-11-23
  • 0.27.0-beta.0 - 2024-11-04
  • 0.26.11 - 2024-11-01
  • 0.26.10 - 2024-10-16
  • 0.26.9 - 2024-10-11
  • 0.26.8 - 2024-10-04
  • 0.26.7 - 2024-09-09
  • 0.26.6 - 2024-08-18
  • 0.26.5 - 2024-07-21
  • 0.26.4 - 2024-07-10
  • 0.26.3 - 2024-06-28
  • 0.26.2 - 2024-06-24
  • 0.26.1 - 2024-06-22
  • 0.26.0 - 2024-06-22
  • 0.26.0-beta.5 - 2024-06-16
  • 0.26.0-beta.4 - 2024-06-16
  • 0.26.0-beta.3 - 2024-06-09
  • 0.26.0-beta.2 - 2024-06-01
  • 0.26.0-beta.1 - 2024-05-06
  • 0.26.0-beta.0 - 2024-05-04
  • 0.25.13 - 2024-04-07
  • 0.25.12 - 2024-03-10
  • 0.25.11 - 2024-03-06
  • 0.25.10 - 2024-03-03
  • 0.25.9 - 2024-02-26
  • 0.25.8 - 2024-02-09
  • 0.25.7 - 2024-01-08
  • 0.25.6 - 2024-01-01
  • 0.25.5 - 2024-01-01
  • 0.25.4 - 2023-11-26
  • 0.25.3 - 2023-10-29
  • 0.25.2 - 2023-10-08
  • 0.25.1 - 2023-09-04
  • 0.25.0 - 2023-08-25
  • 0.24.8 - 2023-06-04
  • 0.24.7 - 2023-05-08
  • 0.24.6 - 2023-04-24
  • 0.24.5 - 2023-04-22
  • 0.24.4 - 2023-04-16
  • 0.24.3 - 2023-04-16
  • 0.24.2 - 2023-04-15
  • 0.24.1 - 2023-04-09
  • 0.24.0 - 2023-04-08
  • 0.24.0-beta.8 - 2023-04-03
  • 0.24.0-beta.7 - 2023-03-26
  • 0.24.0-beta.6 - 2023-03-25
  • 0.24.0-beta.5 - 2023-03-25
  • 0.24.0-beta.4 - 2023-03-25
  • 0.24.0-beta.3 - 2023-03-12
  • 0.24.0-beta.2 - 2023-03-06
  • 0.24.0-beta.1 - 2023-03-05
  • 0.23.28 - 2023-03-19
from typedoc GitHub release notes

Important

  • Check the changes in this PR to ensure they won't cause issues with your project.
  • This PR was automatically created by Snyk using the credentials of a real user.

Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.

For more information:

@codeclimate CodeClimate
Copy link

codeclimate bot commented May 6, 2025

Code Climate has analyzed commit 2162355 and detected 0 issues on this pull request.

View more on Code Climate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@patinthehat @snyk-bot