[Snyk] Upgrade typedoc from 0.22.18 to 0.26.7 #5
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Snyk has created this PR to upgrade typedoc from 0.22.18 to 0.26.7.
ℹ️ 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 82 versions ahead of your current version.
The recommended version was released on a month ago.
Issues fixed by the recommended upgrade:
SNYK-JS-BABELTRAVERSE-5962462
SNYK-JS-ES5EXT-6095076
SNYK-JS-PUGCODEGEN-7086056
SNYK-JS-OCTOKITWEBHOOKS-6129527
SNYK-JS-SEMVER-3247795
SNYK-JS-SEMVER-3247795
SNYK-JS-SEMVER-3247795
SNYK-JS-FOLLOWREDIRECTS-6141137
SNYK-JS-SOCKETIO-7278048
SNYK-JS-EJS-6689533
SNYK-JS-FOLLOWREDIRECTS-6444610
SNYK-JS-WORDWRAP-3149973
Release notes
Package name: typedoc
Features
customJs
option to include a script tag in generated HTML output, #2650.markdownLinkExternal
option to treathttp[s]://
links in markdown documents and comments as external to be opened in a new tab, #2679.navigation.excludeReferences
option to prevent re-exports from appearing in the left hand navigation, #2685.@ abstract
tag, #2692.Bug Fixes
@ link
tags to symbols which are not included in the documentation will produce invalid link warnings again, #2681.@ param
tags on comments attached to function callback parameters, #2683.alphabetical
andalphabetical-ignoring-documents
sort options now uselocaleCompare
to sort, #2684.this
parameter, #2698.Thanks!
Features
@ extends
block tag no longer produces warnings, #2659.This tag should only be used in JavaScript projects to specify the type parameters used when extending a parent class. It will not be rendered.
navigation.compactFolders
option to prevent TypeDoc from compacting folders, similar to the VSCode option. #2667.Bug Fixes
suppressCommentWarningsInDeclarationFiles
option now correctly ignores warnings in.d.cts
and.d.mts
files, #2647.Features
OptionDefaults
, #2640.Bug Fixes
@ document
includes an empty file, #2638.Thanks!
Bug Fixes
@ link
tags will now be validated in referenced markdown documents, #2629.@ link
tags are now resolved in project documents, #2629.@ hidden
is now properly applied when placed in a function implementation comment, #2634.Thanks!
Features
Bug Fixes
mailto:
links are no longer incorrectly recognized as relative paths, #2613.@ since
to the default list of recognized tags, #2614.Features
--suppressCommentWarningsInDeclarationFiles
option to disable warnings fromparsing comments in declaration files, #2611.
for members of interfaces/classes, #2084, #2545.
Bug Fixes
text
non-highlighted language no longer causes warnings when rendering, #2610.use an
@ param
tag from the parent, TypeDoc will no longer warn about the@ param
tag.Features
Bug Fixes
@ author
to the default list of recognized tags, #2603..jsonc
configuration files are now properly read as JSONC, rather than being passed torequire
.Thanks!
Breaking Changes
marked
tomarkdown-it
for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code.This means that any projects setting
markedOptions
needs to be updated to usemarkdownItOptions
.Unlike
marked@4
,markdown-it
pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with themarkdownItLoader
option.As Shiki adds additional languages, the time it takes to load the highlighter increases linearly. To avoid rendering taking longer than necessary,
TypeDoc now only loads a few common languages. Additional languages can be loaded by setting the
--highlightLanguages
option.--excludePrivate
totrue
.--sitemapBaseUrl
to--hostedBaseUrl
to reflect that it can be used for more than just the sitemap.navigation.fullTree
option.--media
option, TypeDoc will now detect image links within your comments and markdown documents and automatically copy them to the site.--includes
option, use the@ document
tag instead.--stripYamlFrontmatter
option, TypeDoc will always do this now.--htmlLang
option to--lang
.--gaId
option for Google Analytics integration and correspondinganalytics
theme member, #2600.were always moved down to the signature level. This mostly worked, but caused problems with type aliases, so was partially changed in 0.25.13.
This change was extended to apply not only to type aliases, but also other function-likes declared with variables and callable properties.
As a part of this change, comments on the implementation signature of overloaded functions will now be added to the function reflection, and will
not be inherited by signatures of that function, #2521.
Converter.EVENT_CREATE_DECLARATION
was emitted for
ProjectReflection
in some circumstances.MapOptionDeclaration.mapError
has been removed.BindOption
decorator has been removed.DeclarationReflection.indexSignature
has been renamed toDeclarationReflection.indexSignatures
.Note: This also affects JSON serialization. TypeDoc will support JSON output from 0.25 through at least 0.26.
JSONOutput.SignatureReflection.typeParameter
has been renamed totypeParameters
to match the JS API.DefaultThemeRenderContext.iconsCache
has been removed as it is no longer needed.DefaultThemeRenderContext.hook
must now be passedcontext
if required by the hook.Features
--projectDocuments
option to specify additional Markdown documents to be included in the generated site #247, #1870, #2288, #2565.are currently shipped in the package, but it is now possible to add support for additional languages, #2475.
packageOptions
object which specifies options that should be applied to each entry point when running with--entryPointStrategy packages
, #2523.--hostedBaseUrl
will now be used to generate a<link rel="canonical">
element in the project root page, #2550.Note: This feature is only available on type aliases directly containing unions.
--customFooterHtml
to add custom HTML to the generated page footer, #2559.--cascadedModifierTags
option, #2056.@ alpha
and@ beta
), #2056.@ hideconstructor
tag.This tag should only be used to work around TypeScript#58653, prefer the more general
@ hidden
/@ ignore
tag to hide members normally, #2577.--useHostedBaseUrlForAbsoluteLinks
option to use the--hostedBaseUrl
option to produce absolute links to pages on a site, #940.--blockTags
option.documents-first
,documents-last
, andalphabetical-ignoring-documents
to order markdown documents.--alwaysCreateEntryPointModule
option. When set, TypeDoc will always create aModule
for entry points, even if only one is provided.If
--projectDocuments
is used to add documents, this option defaults totrue
, otherwise, defaults tofalse
.--highlightLanguages
option to control what Shiki language packages are loaded.This results in significantly smaller documentation pages in many cases where that section would just repeat what has already been presented in the rendered type.
comment.beforeTags
andcomment.afterTags
hooks for plugin use.Combined with
CommentTag.skipRendering
this can be used to provide custom tag handling at render time.Bug Fixes
Returns
header are now properly colored, #2546.navigationLinks
option are now moved into the pull out navigation on mobile displays, #2548.@ license
and@ import
comments will be ignored at the top of files, #2552.charset
is now correctly cased in<meta>
tag generated by the default theme, #2568.<head>
element could result in broken icons, #2589.@ default
and@ defaultValue
blocks are now recognized as regular blocks if they include inline tags, #2601.localStorage
.--hideParameterTypesInTitle
option no longer applies when rendering function types.@ link
tags in readme files will now cause a warning when link validation is enabled.externalSymbolLinkMappings
option's support for meanings in declaration references.type=button
attribute set to avoid being treated as submit buttons.--hostedBaseUrl
will now implicitly add a trailing slash to the generated URL.Thanks!
Unreleased
Features
gitRevision:short
placeholder option to--sourceLinkTemplate
option, #2529.Links generated by TypeDoc will now default to using the non-short git revision.
<footer>
tag, addedfooter.begin
andfooter.end
render hooks for use by custom plugins, #2532.
Bug Fixes
NoInfer
missing type parameter reference, #2539."This member is normally hidden due to your filter settings" for every member.
Thanks!
Features
Bug Fixes
Thanks!
Important
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:
[//]: # 'snyk:metadata:{"customTemplate":{"variablesUsed":[],"fieldsUsed":[]},"dependencies":[{"name":"typedoc","from":"0.22.18","to":"0.26.7"}],"env":"prod","hasFixes":true,"isBreakingChange":false,"isMajorUpgrade":false,"issuesToFix":[{"exploit_maturity":"proof-of-concept","id":"SNYK-JS-BABELTRAVERSE-5962462","issue_id":"SNYK-JS-BABELTRAVERSE-5962462","priority_score":786,"priority_score_factors":[{"type":"exploit","label":"Proof of Concept","score":107},{"type":"fixability","label":true,"score":214},{"type":"cvssScore","label":"9.3","score":465},{"type":"scoreVersion","label":"v1","score":1}],"severity":"critical","title":"Incomplete List of Disallowed Inputs"},{"exploit_maturity":"proof-of-concept","id":"SNYK-JS-ES5EXT-6095076","issue_id":"SNYK-JS-ES5EXT-6095076","priority_score":696,"priority_score_factors":[{"type":"exploit","label":"Proof of Concept","score":107},{"type":"fixability","label":true,"score":214},{"type":"cvssScore","label":"7.5","score":375},{"type":"scoreVersion","label":"v1","score":1}],"severity":"high","title":"Regular Expression Denial of Service (ReDoS)"},{"exploit_maturity":"proof-of-concept","id":"SNYK-JS-PUGCODEGEN-7086056","issue_id":"SNYK-JS-PUGCODEGEN-7086056","priority_score":696,"priority_score_factors":[{"type":"exploit","label":"Proof of Concept","score":107},{"type":"fixability","label":true,"score":214},{"type":"cvssScore","label":"7.5","score":375},{"type":"scoreVersion","label":"v1","score":1}],"severity":"high","title":"Improper Control of Generation of Code ('Code Injection')"},{"exploit_maturity":"no-known-exploit","id":"SNYK-JS-OCTOKITWEBHOOKS-6129527","issue_id":"SNYK-JS-OCTOKITWEBHOOKS-6129527","priority_score":624,"priority_score_factors":[{"type":"fixability","label":true,"score":214},{"type":"cvssScore","label":"8.2","score":410},{"type":"scoreVersion","label":"v1","score":1}],"severity":"high","title":"Improper Handling of Exceptional Conditions"},{"exploit_maturity":"proof-of-concept","id":"SNYK-JS-SEMVER-3247795","issue_id":"SNYK-JS-SEMVER-3247795","priority_score":696,"priority_score_factors":[{"type":"exploit","label":"Proof of Concept","score":107},{"type":"fixability","label":true,"score":214},{"type":"cvssScore","label":"7.5","score":375},{"type":"scoreVersion","label":"v1","score":1}],"severity":"high","title":"Regular Expression Denial of Service (ReDoS)"},{"exploit_maturity":"proof-of-concept","id":"SNYK-JS-SEMVER-3247795","issue_id":"SNYK-JS-SEMVER-3247795","priority_score":696,"priority_score_factors":[{"type":"exploit","label":"Proof of Concept","score":107},{"type":"fixability","label":true,"score":214},{"type":"cvssScore","label":"7.5","score":375},{"type":"scoreVersion","label":"v1","score":1}],"severity":"high","title":"Regular Expression Denial of Service (ReDoS)"},{"exploit_maturity":"proof-of-concept","id":"SNYK-JS-SEMVER-3247795","issue_id":"SNYK-JS-SEMVER-3247795","priority_score":696,"priority_score_factors":[{"type":"exploit","label":"Proof of Concept","score":107},{"type":"fixability","label":true,"score":214},{"type":"cvssScore","label":"7.5","score":375},{"type":"scoreVersion","label":"v1","score":1}],"severity":"high","title":"Regular Expression Denial of Service (ReDoS)"},{"exploit_maturity":"proof-of-concept","id":"SNYK-JS-FOLLOWREDIRECTS-6141137","issue_id":"SNYK-JS-FOLLOWREDIRECTS-6141137","priority_score":686,"priority_score_factors":[{"type":"exploit","label":"Proof of Concept","score":107},{"type":"fixability","label":true,"score":214},{"type":"cvssScore","label":"7.3","score":365},{"type":"scoreVersion","label":"v1","score":1}],"severity":"high","title":"Improper Handling of Extra Parameters"},{"exploit_maturity":"no-known-exploit","id":"SNYK-JS-SOCKETIO-7278048","issue_id":"SNYK-JS-SOCKETIO-7278048","priority_score":649,"priority_score_factors":[{"type":"fixability","label":true,"score":214},{"type":"cvssScore","label":"8.7","score":435},{"type":"scoreVersion","label":"v1","score":1}],"severity":"high","title":"Uncaught Exception"},{"exploit_maturity":"no-known-exploit","id":"SNYK-JS-EJS-6689533","issue_id":"SNYK-JS-EJS-6689533","priority_score":479,"priority_score_factors":[{"type":"fixability","label":true,"score":214},{"type":"cvssScore","label":"5.3","score":265},{"type":"scoreVersion","label":"v1","score":1}],"severity":"medium","title":"Improper Control of Dynamically-Managed Code Resources"},{"exploit_maturity":"proof-of-concept","id":"SNYK-JS-FOLLOWREDIRECTS-6444610","issue_id":"SNYK-JS-FOLLOWREDIRECTS-6444610","priority_score":646,"priority_score_factors":[{"type":"exploit","label":"Proof of Concept","score":107},{"type":"fixability","label":true,"score":214},{"type":"cvssScore","label":"6.5","score":325},{"type":"scoreVersion","label":"v1","score":1}],"severity":"medium","title":"Information Exposure"},{"exploit_maturity":"proof-of-concept","id":"SNYK-JS-WORDWRAP-3149973","issue_id":"SNYK-JS-WORDWRAP-3149973","priority_scor...