Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

[Snyk] Upgrade typedoc from 0.19.2 to 0.25.13 #2

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

[Snyk] Upgrade typedoc from 0.19.2 to 0.25.13 #2

wants to merge 1 commit into from

Conversation

tjmatosplanet
Copy link
Owner

This PR was automatically created by Snyk using the credentials of a real user.


![snyk-top-banner](https://github.com/andygongea/OWASP-Benchmark/assets/818805/c518c423-16fe-447e-b67f-ad5a49b5d123)

Snyk has created this PR to upgrade typedoc from 0.19.2 to 0.25.13.

ℹ️ 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 183 versions ahead of your current version.

  • The recommended version was released on 2 months ago.

Issues fixed by the recommended upgrade:

Issue Score Exploit Maturity
high severity Improper Verification of Cryptographic Signature
SNYK-JS-NODEFORGE-2430339		 539 No Known Exploit
high severity Improper Privilege Management
SNYK-JS-SHELLJS-2332187		 539 Proof of Concept
medium severity Information Exposure
SNYK-JS-NODEFETCH-2342118		 539 No Known Exploit
medium severity Open Redirect
SNYK-JS-NODEFORGE-2330875		 539 Proof of Concept
medium severity Prototype Pollution
SNYK-JS-NODEFORGE-2331908		 539 No Known Exploit
medium severity Improper Verification of Cryptographic Signature
SNYK-JS-NODEFORGE-2430337		 539 No Known Exploit
medium severity Improper Verification of Cryptographic Signature
SNYK-JS-NODEFORGE-2430341		 539 No Known Exploit
medium severity Regular Expression Denial of Service (ReDoS)
SNYK-JS-MARKED-2342073		 539 Proof of Concept
medium severity Regular Expression Denial of Service (ReDoS)
SNYK-JS-MARKED-2342082		 539 Proof of Concept
medium severity Regular Expression Denial of Service (ReDoS)
SNYK-JS-UGLIFYJS-1727251		 539 No Known Exploit
Release notes
Package name: typedoc
  • 0.25.13 - 2024-04-07

    Features

    • Added gitRevision:short placeholder option to --sourceLinkTemplate option, #2529.
      Links generated by TypeDoc will now default to using the non-short git revision.
    • Moved "Generated by TypeDoc" footer into a <footer> tag, added footer.begin and footer.end
      render hooks for use by custom plugins, #2532.

    Bug Fixes

    • Fixed conversion of NoInfer missing type parameter reference, #2539.
    • Linking to a member on a page no longer incorrectly claims that
      "This member is normally hidden due to your filter settings" for every member.

    Thanks!

  • 0.25.12 - 2024-03-10

    Features

    • Added support for TypeScript 5.4, #2517.

    Bug Fixes

    • Updated page font to work around issues with Mac rendering, #2518.

    Thanks!

  • 0.25.11 - 2024-03-06

    Bug Fixes

    • Fixed an issue introduced with 0.25.10 which causes the page index to initially render empty, #2514.
    • "On This Page" section is now smarter when handling page headings which do not follow the normal h1>h2>h3 process, #2515.
  • 0.25.10 - 2024-03-03

    Bug Fixes

    • Constructed references to enum types will be properly linked with @ interface, #2508.
    • Comments on property-methods will no longer be duplicated in generated documentation, #2509.
    • Reduced rendered docs size by writing icons to a referenced SVG asset, #2505.
      For TypeDoc's docs, this reduced the rendered documentation size by ~30%.
    • The HTML docs now attempt to reduce repaints caused by dynamically loading the navigation, #2491.
    • When navigating to a link that contains an anchor, the page will now be properly highlighted in the page navigation.
  • 0.25.9 - 2024-02-26

    Features

    • Literal numeric unions will now be sorted during conversion, #2502.

    Bug Fixes

    • Module readmes will now be included in JSON output, #2500.
    • Fixed crash when --excludeNotDocumented was used and the project contained a reference to a removed signature, #2496.
    • Fixed crash when converting an infinitely recursive type via a new --maxTypeConversionDepth option, #2507.
    • Type links in "Parameters" and "Type Parameters" sections of the page will now be correctly colored.

    Thanks!

  • 0.25.8 - 2024-02-09

    Features

    • Added a new --sitemapBaseUrl option. When specified, TypeDoc will generate a sitemap.xml in your output folder that describes the site, #2480.
    • Added support for the @ class tag. When added to a comment on a variable or function, TypeDoc will convert the member as a class, #2479.
      Note: This should only be used on symbols which actually represent a class, but are not declared as a class for some reason.
    • Added support for @ groupDescription and @ categoryDescription to provide a description of groups and categories, #2494.
    • API: Exposed Context.getNodeComment for plugin use, #2498.

    Bug Fixes

    • Fixed an issue where a namespace would not be created for merged function-namespaces which are declared as variables, #2478.
    • A class which implements itself will no longer cause a crash when rendering HTML, #2495.
    • Variable functions which have construct signatures will no longer be converted as functions, ignoring the construct signatures.
    • The class hierarchy page will now include classes whose base class is not included in the documentation, #2486.
    • Fixed an issue where, if the index section was collapsed when loading the page, all content within it would be hidden until expanded, and a member visibility checkbox was changed.
    • API: Context.programs will no longer contain duplicates, #2498.
  • 0.25.7 - 2024-01-08

    Bug Fixes

    • Fixed an issue where a namespace would not be created for merged function-namespaces only containing types, #2476.
    • Fixed an infinite loop when converting a union type which directly contained another union type which refers to itself, #2469.
  • 0.25.6 - 2024-01-01

    Bug Fixes

    • Fixed infinite loop caused by a fix for some complicated union/intersection types, #2468.
    • Improved infinite loop detection in type converter to reduce false positives.
  • 0.25.5 - 2024-01-01

    Features

    • Added a new hierarchy.html page to HTML output which displays the full inheritance hierarchy for classes included in the documentation, #182.
    • Added a --navigation.includeFolders (default: true) option to create nested navigation for projects which include many entry points, #2388.
    • Type parameters on functions/classes can will now link to the "Type Parameters" section, #2322.
      Type parameters have also been changed to have a distinct color from type aliases when rendering, which can be changed with custom CSS.
    • TypeDoc now provides warnings if a signature comment is directly specified on a signature and contains @ param tags which do not apply, #2368.
    • Extended reflection preview view for interfaces to include type parameters, #2455.
    • Added special cases for converting methods which are documented as returning this or accepting this as a parameter, #2458.
      Note: This will only happen if a method is declared as method(): this, it will not happen if the method implicitly returns this
      as the compiler strips that information when creating types for a class instance.
    • Improved handling of functions with properties. Previous TypeDoc versions would always create a separate
      namespace for properties, now, TypeDoc will create a separate namespace if the function is declaration merged
      with a namespace. If the properties are added via Object.assign or via property assignment on the function
      TypeDoc will now instead add the properties to the function's page, #2461.

    Bug Fixes

    • If both an interface and a variable share a name/symbol, TypeDoc will no longer link to the variable when referenced in a type position, #2106.
    • notDocumented validation will no longer require documentation for data within parameters that cannot be documented via @ param, #2291.
    • "defined in" locations for signatures will now always be contained within the function declaration's location. This prevents defined in sometimes pointing to node_modules, #2307.
    • Type parameters will now be resolved for arrow-methods on classes like regular class methods, #2320.
    • TypeDoc now inherits typedocOptions fields from extended tsconfig files, #2334.
    • Methods which return function types no longer have duplicated comments, #2336.
    • Comments on function-like type aliases will now show up under the type alias, rather than nested within the type declaration, #2372.
    • Improved detection of default values for parameters with destructured values, #2430.
    • Fix crash when converting some complicated union/intersection types, #2451.
    • Navigation triangle markers should no longer display on a separate line with some font settings, #2457.
    • @ group and @ category organization is now applied later to allow inherited comments to create groups/categories, #2459.
    • Conversion order should no longer affect link resolution for classes with properties whose type does not rely on this, #2466.
    • Keyword syntax highlighting introduced in 0.25.4 was not always applied to keywords.
    • Module reflections now have a custom M icon rather than sharing with the namespace icon.
      Note: The default CSS still colors both modules and namespaces the same, as it is generally uncommon to have both in a generated site.
    • If all members in a group are hidden from the page, the group will be hidden in the page index on page load.
  • 0.25.4 - 2023-11-26

    Features

    • Added support for TypeScript 5.3, #2446.
    • TypeDoc will now render interfaces as code at the top of the page describing interfaces, #2449.
      This can be controlled through the new DefaultThemeRenderContext.reflectionPreview helper.
    • Improved type rendering to highlight keywords differently than symbols.

    Bug Fixes

    • Fixed automatic declaration file resolution on Windows, #2416.
    • Fixed default option values on options declared by plugins in packages mode, #2433.
    • gitRevision will now be replaced in sourceLinkTemplate, #2434.
    • Improved handling of function-modules created with Object.assign, #2436.
    • TypeDoc will no longer warn about duplicate comments with warnings which point to a single comment, #2437
    • Fixed an infinite loop when skipLibCheck is used to ignore some compiler errors, #2438.
    • @ example tag titles will now be rendered in the example heading, #2440.
    • Correctly handle transient symbols in @ namespace-created namespaces, #2444.
    • TypeDoc no longer displays the "Hierarchy" section if there is no inheritance hierarchy to display.
    • Direct links to individual signatures no longer results in the signature being partially scrolled off the screen.

    Thanks!

  • 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
  • 0.23.27 - 2023-03-16
  • 0.23.26 - 2023-02-26
  • 0.23.25 - 2023-02-11
  • 0.23.24 - 2023-01-07
  • 0.23.23 - 2022-12-18
  • 0.23.22 - 2022-12-11
  • 0.23.21 - 2022-11-14
  • 0.23.20 - 2022-11-03
  • 0.23.19 - 2022-10-28
  • 0.23.18 - 2022-10-23
  • 0.23.17 - 2022-10-18
  • 0.23.16 - 2022-10-10
  • 0.23.15 - 2022-09-18
  • 0.23.14 - 2022-09-03
  • 0.23.13 - 2022-09-01
  • 0.23.12 - 2022-08-31
  • 0.23.11 - 2022-08-26
  • 0.23.10 - 2022-07-31
  • 0.23.9 - 2022-07-24
  • 0.23.8 - 2022-07-17
  • 0.23.7 - 2022-07-09
  • 0.23.6 - 2022-07-08
  • 0.23.5 - 2022-07-02
  • 0.23.4 - 2022-07-02
  • 0.23.3 - 2022-07-01
  • 0.23.2 - 2022-06-28
  • 0.23.1 - 2022-06-26
  • 0.23.0 - 2022-06-26
  • 0.23.0-beta.7 - 2022-06-25
  • 0.23.0-beta.6 - 2022-06-25
  • 0.23.0-beta.5 - 2022-06-20
  • 0.23.0-beta.4 - 2022-06-04
  • 0.23.0-beta.3 - 2022-06-03
  • 0.23.0-beta.2 - 2022-05-30
  • 0.23.0-beta.1 - 2022-04-19
  • 0.23.0-beta.0 - 2022-04-17
  • 0.22.18 - 2022-06-25
  • 0.22.17 - 2022-06-01
  • 0.22.16 - 2022-05-30
  • 0.22.15 - 2022-04-10
  • 0.22.14 - 2022-04-07
  • 0.22.13 - 2022-03-06
  • 0.22.12 - 2022-02-20
  • 0.22.11 - 2022-01-18
  • 0.22.10 - 2021-11-25
  • 0.22.9 - 2021-11-14
  • 0.22.8 - 2021-11-07
  • 0.22.7 - 2021-10-25
  • 0.22.6 - 2021-10-17
  • 0.22.5 - 2021-10-02
  • 0.22.4 - 2021-09-18
  • 0.22.3 - 2021-09-12
  • 0.22.2 - 2021-09-11
  • 0.22.1 - 2021-09-10
  • 0.22.0 - 2021-09-10
  • 0.22.0-beta.10 - 2021-09-05
  • 0.22.0-beta.9 - 2021-09-05
  • 0.22.0-beta.8 - 2021-09-04
  • 0.22.0-beta.7 - 2021-09-04
  • 0.22.0-beta.6 - 2021-08-30
  • 0.22.0-beta.5 - 2021-08-29
  • 0.22.0-beta.4 - 2021-08-19
  • 0.22.0-beta.2 - 2021-08-17
  • 0.22.0-beta.1 - 2021-08-13
  • 0.22.0-beta.0 - 2021-08-01
  • 0.21.10 - 2022-02-07
  • 0.21.9 - 2021-08-29
  • 0.21.8 - 2021-08-28
  • 0.21.7 - 2021-08-27
  • 0.21.6 - 2021-08-19
  • 0.21.5 - 2021-07-31
  • 0.21.4 - 2021-07-12
  • 0.21.3 - 2021-07-10
  • 0.21.2 - 2021-06-27
  • 0.21.1 - 2021-06-25
  • 0.21.0 - 2021-06-18
  • 0.21.0-beta.4 - 2021-06-16
  • 0.21.0-beta.3 - 2021-06-15
  • 0.21.0-beta.2 - 2021-06-06
  • 0.21.0-beta.1 - 2021-06-05
  • 0.20.37 - 2021-06-16
  • 0.20.36 - 2021-04-23
  • 0.20.35 - 2021-04-03
  • 0.20.34 - 2021-03-25
  • 0.20.33 - 2021-03-22
  • 0.20.32 - 2021-03-14
  • 0.20.31 - 2021-03-14
  • 0.20.30 - 2021-03-06
  • 0.20.29 - 2021-03-04
  • 0.20.28 - 2021-02-23
  • 0.20.27 - 2021-02-20
  • 0.20.26 - 2021-02-20
  • 0.20.25 - 2021-02-15
  • 0.20.24 - 2021-02-11
  • 0.20.23 - 2021-02-06
  • 0.20.22 - 2021-02-06
  • 0.20.21 - 2021-02-05
  • 0.20.20 - 2021-01-31
  • 0.20.19 - 2021-01-25
  • 0.20.18 - 2021-01-24
  • 0.20.17 - 2021-01-23
  • 0.20.16 - 2021-01-17
  • 0.20.15 - 2021-01-16
  • 0.20.14 - 2021-01-09
  • 0.20.13 - 2021-01-06
  • 0.20.12 - 2021-01-05
  • 0.20.11 - 2021-01-04
  • 0.20.10 - 2021-01-03
  • 0.20.9 - 2021-01-02
  • 0.20.8 - 2021-01-01
  • 0.20.7 - 2021-01-01
  • 0.20.6 - 2021-01-01
  • 0.20.5 - 2020-12-30
  • 0.20.4 - 2020-12-30
  • 0.20.3 - 2020-12-29
  • 0.20.2 - 2020-12-29
  • 0.20.1 - 2020-12-29
  • 0.20.0 - 2020-12-28
  • 0.20.0-beta.33 - 2020-12-28
  • 0.20.0-beta.32 - 2020-12-27
  • 0.20.0-beta.31 - 2020-12-27
  • 0.20.0-beta.30 - 2020-12-27
  • 0.20.0-beta.29 - 2020-12-26
  • 0.20.0-beta.28 - 2020-12-26
  • 0.20.0-beta.27 - 2020-12-09
  • 0.20.0-beta.26 - 2020-12-07
  • 0.20.0-beta.25 - 2020-12-05
  • 0.20.0-beta.24 - 2020-11-28
  • 0.20.0-beta.23 - 2020-11-28
  • 0.20.0-beta.22 - 2020-11-28
  • 0.20.0-beta.21 - 2020-11-28
  • 0.20.0-beta.20 - 2020-11-28
  • 0.20.0-beta.19 - 2020-11-27
  • 0.20.0-beta.18 - 2020-11-27
  • 0.20.0-beta.17 - 2020-11-27
  • 0.20.0-beta.16 - 2020-11-26
  • 0.20.0-beta.15 - 2020-11-26
  • 0.20.0-beta.14 - 2020-11-26
  • 0.20.0-beta.13 - 2020-11-26
  • 0.20.0-beta.12 - 2020-11-25
  • 0.20.0-beta.11 - 2020-11-25
  • 0.20.0-beta.10 - 2020-11-25
  • 0.20.0-beta.9 - 2020-11-25
  • 0.20.0-beta.8 - 2020-11-02
  • 0.20.0-beta.7 - 2020-11-01
  • 0.20.0-beta.6 - 2020-11-01
  • 0.20.0-beta.5 - 2020-11-01
  • 0.20.0-beta.4 - 2020-10-25
  • 0.20.0-beta.3 - 2020-10-25
  • 0.20.0-beta.2 - 2020-10-25
  • 0.20.0-beta.1 - 2020-10-23
  • 0.19.2 - 2020-09-21
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.
  • Max score is 1000. Note that the real score may have changed since the PR was raised.

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-bot
fix: upgrade typedoc from 0.19.2 to 0.25.13
a3b66a6 
Snyk has created this PR to upgrade typedoc from 0.19.2 to 0.25.13.

See this package in npm:
typedoc

See this project in Snyk:
https://app.snyk.io/org/tjmatosplanet/project/513eeeb4-dca3-4964-90ad-b3978890b738?utm_source=github&utm_medium=referral&page=upgrade-pr
# for free to join this conversation on GitHub. Already have an account? # 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
@tjmatosplanet @snyk-bot