Skip to content

Releases: yisibl/resvg-js

v2.6.2

26 Mar 13:41
Compare
Choose a tag to compare

v2.6.1

25 Mar 11:37
Compare
Choose a tag to compare

What's Changed

This version solves the problem of missing DLLs caused by not installing Visual C++ Redistributable on Windows.

Added

  • chore(deps): update yarn to v3.8.1
  • chore(deps): update actions/cache action to v4
  • chore(deps): upgrade dependencies such as napi-rs #311
  • chore(ci): adding Node.js v20 to the CI
  • chore(ci): use macOS M1 machines
  • doc: clarify that the default value of the defaultFontFamily is empty
  • doc: improved change log documentation for M/L/C error
  • test: add a bbox test with stroke
  • fix(deps): update rust crate svgtypes to 0.14.0

Fixed

New Contributors

Full Changelog: v2.6.0...v2.6.1

v2.6.1-beta.0

11 Mar 14:21
Compare
Choose a tag to compare
v2.6.1-beta.0 Pre-release
Pre-release

What's Changed

This version solves the problem of missing DLLs caused by not installing Visual C++ Redistributable on Windows.

Added

  • chore(deps): upgrade dependencies such as napi-rs #311
  • chore(ci): adding Node.js v20 to the CI
  • chore(ci): use macOS M1 machines
  • doc: clarify that the default value of the defaultFontFamily is empty
  • doc: improved change log documentation for M/L/C error
  • test: add a bbox test with stroke
  • fix(deps): update rust crate svgtypes to 0.14.0

Fixed

New Contributors

Full Changelog: v2.6.0...v2.6.1-beta.0

v2.6.0

20 Oct 15:13
Compare
Choose a tag to compare

What's Changed

🚀 Up to 115x faster for very large SVG files

Now resvg has been upgraded from v0.29.0 to v0.34.0, bringing with it a host of new SVG features and performance improvements.

  • Support SVG2 mask-type property.

  • Allows quadratic Bézier curves: text might render slightly differently (better?). This is because TrueType fonts contain only quadratic curves and we were converting them to cubic before.

  • Clipping and masking is up to 20% faster.

  • Reduces the peak memory usage for SVGs with large paths (in terms of the number of segments).

  • A new rendering algorithm.

    When rendering isolated groups,
    aka layers, we have to know the layer bounding box beforehand, which is ridiculously hard in SVG.

    Previously, resvg would simply use the canvas size for all the layers.
    This means that to render a 10x10px layer on a 1000x1000px canvas, we would have to allocate and then blend
    a 1000x1000px layer, which is just a waste of CPU cycles.

    The new rendering algorithm is able to calculate layer bounding boxes, which dramatically improves
    performance when rendering a lot of tiny layers on a large canvas.

    Moreover, it makes performance more linear with a canvas size increase.

    The paris-30k.svg
    sample from google/forma is rendered 115 times faster on M1 Pro now.
    From ~33760ms down to ~290ms. 5269x3593px canvas.

    If we restrict the canvas to 1000x1000px, which would contain only the actual paris-30k.svg content,
    then we're 13 times faster. From ~3252ms down to ~253ms.

Added

  • feat: upgrade to usvg/resvg 0.34.0. #268 Thanks to @zimond

Full Changelog: v2.5.0...v2.6.0

v2.5.0

16 Oct 08:31
Compare
Choose a tag to compare

What's Changed

Added

Now we can finally loading custom fonts in Wasm, including the WOFF2 format (see playground), thanks to the high-performance woff2-rs.

In addition, we implemented smarter default font family fallback. the defaultFontFamily option can now be omitted. We'll read the font-family from the incoming fonts and set it to the default.

<script src="https://unpkg.com/@resvg/resvg-wasm"></script>
<script>
  (async function () {
    await resvg.initWasm(fetch('https://unpkg.com/@resvg/resvg-wasm/index_bg.wasm'))

    const font = await fetch('./fonts/Pacifico-Regular.woff2')
    if (!font.ok) return

    const fontData = await font.arrayBuffer()
    const buffer = new Uint8Array(fontData)

    const opts = {
      font: {
        fontBuffers: [buffer], // New in 2.5.0, loading custom fonts.
        // defaultFontFamily: 'Pacifico', // You can omit this.
      },
    }

    const svg = '<svg> ... </svg>' // Input SVG, String or Uint8Array
    const resvgJS = new resvg.Resvg(svg, opts)
    const pngData = resvgJS.render(svg, opts) // Output PNG data, Uint8Array
    const pngBuffer = pngData.asPng()
    const svgURL = URL.createObjectURL(new Blob([pngData], { type: 'image/png' }))
    document.getElementById('output').src = svgURL
  })()
</script>
  • feat: improve custom loaded fonts. Thanks to @yisibl #209
  • feat: support for loading custom fonts in Wasm, via the fontBuffers option. Thanks to @antmelnyk #217
  • feat: support loading WOFF2 font in Wasm. Thanks to @yisibl #220
  • chore: Wasm uses the same logic as Node.js to find the default font family.Thanks to @yisibl #252

We have improved the upstream svgtypes#14, allow parsing of float rgb()/rgba() values from CSS Color 4 draft like rgb(3.14, 110, 201).

  • fix(deps): update rust crate svgtypes to 0.12.0. Thanks to @yisibl #266

Changed

  • test: fix test image timeout. #262

New Contributors

Full Changelog: v2.4.1...v2.5.0

v2.4.1

15 Feb 08:42
Compare
Choose a tag to compare

What's Changed

New Contributors

  • @Nkay made their first contribution in #206

Full Changelog: v2.4.0...v2.4.1

v2.4.0

09 Feb 08:04
Compare
Choose a tag to compare

What's Changed

This is a brand new version with 2-3x faster performance. It also resolves an issue with a specific SVG causing an error, and all users are advised to upgrade to this version.

  resvg-js(Rust):
    39.6 ops/s, ±1.72%   | fastest

  sharp:
    10.9 ops/s, ±31.43%   | 72.47% slower

  svg2img(canvg + node-canvas):
    10.8 ops/s, ±28.52%   | slowest, 72.73% slower

The upgrade will be hard due to the big changes made to upstream resvg. resvg 0.28.0 started with the removal of the ability to output SVG string, and we had to backport that functionality to a new crate: usvg-writer.

Eventually, we upgraded resvg for 2 successive versions, and are now at the latest 0.29.0.

Changed

  • feat: upgrade resvg/usvg to 0.28.0. #194 Thanks to @zimond
  • feat: upgrade resvg/usvg to 0.29.0. #199 Thanks to @zimond
  • chore: upgrade rust-toolchain to nightly-2023-02-01. #199 Thanks to @yisibl
  • chore: remove bench-related dependencies. #200 Thanks to @yisibl

Fixed

  • fix: 'the previous segment must be M/L/C' error. #204 Thanks to @yisibl

    This is a normal error thrown by resvg when parsing Path Command, and has been confirmed as fixed in resvg 0.29.0.

    Add a test to ensure it is now fixed.

    thread '<unnamed>' panicked at 'the previous segment must be M/L/C'
    
    note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
    fatal runtime error: failed to initiate panic, error 5

Full Changelog: v2.3.1...v2.4.0

v2.3.1

02 Feb 15:23
Compare
Choose a tag to compare

What's Changed

  • feat: upgrade wasm-bindgen to 0.2.84 by @yisibl in #196

Full Changelog: v2.3.0...v2.3.1

v2.3.0

02 Feb 12:52
Compare
Choose a tag to compare

What's Changed

  • fix: update napi-rs(2.10.13) to resolve Electron 21+ create Buffer issues. #195

    Electron 21 and later will have the V8 Memory Cage enabled, with implications for some native modules.
    https://www.electronjs.org/blog/v8-memory-cage

    This means that all napi-rs-based native modules will be affected. Usually there is an error like this:

    UnhandledPromiseRejectionWarning: Error: Failed to create napi buffer

    Good thing napi-rs has implemented a compatible approach in the new version, thanks to @Brooooooklyn's work.

  • feat: add wasm file to exports. Thanks to @hadeeb #186

    This solves the problem that direct require.resolve("@resvg/resvg-wasm/index_bg.wasm") in tools like vite or webpack would report an error.

    Module not found: Package path ./index_bg.wasm is not exported from package
    /playground/node_modules/@resvg/resvg-wasm (see exports field in
    /playground/node_modules/@resvg/resvg-wasm/package.json)

    See the Node.js documentation for details about why:

    Existing packages introducing the "exports" field will prevent consumers of the package from using any entry points that are not defined

  • fix(ci): use zig to cross-compile armv7. #176

    This solves the problem of CI errors:

    Error: /lib/arm-linux-gnueabihf/libm.so.6: version `GLIBC_2.35' not found (required by /build/resvgjs.linux-arm-gnueabihf.node)

    Due to the GitHub Actions Ubuntu upgrade from 20.04 to 22.04, the glibc version became 2.35. To maintain our compatibility, zig cross-compilation is now enabled to support older versions of glibc systems.

    Distribution Glibc GCC
    CentOS 7 2.17 4.8.5
    Ubuntu 16.04 2.23 5.4.0
    Ubuntu 18.04 2.27 7.5.0
    Ubuntu 20.04 2.31 9.4.0
    Ubuntu 22.04 2.35 11.2.0
    Debian 10.12 2.28 8.3.0
    Debian 11.4 2.31 10.2.1
  • doc: add Node.js 18 to 'Support matrix'. #155

New Contributors

Full Changelog: v2.2.0...v2.3.0

v2.2.0

17 Nov 16:08
Compare
Choose a tag to compare

What's Changed

Now resvg-js can be run natively (not Wasm) directly in Deno, this allows to get close to the performance of Node.js native addons in Deno.

deno run --unstable --allow-read --allow-write --allow-ffi example/index-deno.js

See Deno Example

import * as path from 'https://deno.land/std@0.159.0/path/mod.ts'
import { Resvg } from 'npm:@resvg/resvg-js'
const __dirname = path.dirname(path.fromFileUrl(import.meta.url))

const svg = await Deno.readFile(path.join(__dirname, './text.svg'))
const resvg = new Resvg(svg, opts)
const pngData = resvg.render()
const pngBuffer = pngData.asPng()

await Deno.writeFile(path.join(__dirname, './text-out-deno.png'), pngBuffer)

In addition, resvg-js can return the raw pixels data of the PNG, which can be very convenient for scenes where only pixels need to be processed.

Added

  • feat: add .pixels() API for returning PNG pixels data (#123).
  • chore: upgrade to resvg v0.25.0 (by @zimond in #156).
    • Partial paint-order attribute support. Markers can only be under or above the shape.
    • CSS3 writing-mode variants vertical-rl and vertical-lr. Thanks to @yisibl.
    • (tiny-skia) AArch64 Neon SIMD support. Up to 3x faster on Apple M1.
    • Path bbox calculation scales stroke width too. Thanks to @growler.
    • (tiny-skia) Round caps roundness. Fixes #155.

Changed

  • build: x86_64-linux-gnu and aarch64-linux-gnu are no longer compiled using Zig. (#125)
  • doc: the dpi option is not the DPI in the PNG file. (#146)
  • chore: add deno example and docs. (#154)
  • feat: upgrade napi-rs to 2.10.0 and Node.js v18. (#157)
  • test: add image resolver API test case. (#164)
  • feat: remove the infer crate, this can reduce the size of Wasm files.
  • feat: remove the infer crate, this reduced the size of the Wasm file by about 4.3%. (#165)
    • Before: 1360609 bytes
    • After: 1302173 bytes
  • feat: error code UnrecognizedBuffer changed to UnsupportedImage. (#165)

Fixed

  • fix: ignore png crate in renovate.json. (by @CGQAQ in #161)

New Contributors

Full Changelog: v2.1.0...v2.2.0