resvg-js

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

• fix: enable static link for windows-msvc #308 Thanks to @Zagrios
• fix: test bindings on x86_64-unknown-linux-musl #306 Thanks to @Brooooooklyn

New Contributors

• @Zagrios made their first contribution in https://github.com/yisibl/resvg-js/pull/308

Full Changelog: https://github.com/yisibl/resvg-js/compare/v2.6.0...v2.6.1

What's Changed

• chore(deps): update dependency eslint-plugin-sonarjs to ^0.23.0 by @renovate in https://github.com/yisibl/resvg-js/pull/278
• chore(deps): update yarn to v3.7.0 by @renovate in https://github.com/yisibl/resvg-js/pull/279
• fix(deps): update rust crate svgtypes to 0.13.0 by @renovate in https://github.com/yisibl/resvg-js/pull/280
• chore(ci): adding Node.js v20 to the CI by @yisibl in https://github.com/yisibl/resvg-js/pull/270
• chore(deps): update dependency lint-staged to v15 by @renovate in https://github.com/yisibl/resvg-js/pull/275
• test: add a bbox test with stroke by @yisibl in https://github.com/yisibl/resvg-js/pull/294
• chore(deps): update dependency esbuild to ^0.20.0 by @renovate in https://github.com/yisibl/resvg-js/pull/296
• chore(deps): update yarn to v3.8.0 by @renovate in https://github.com/yisibl/resvg-js/pull/299
• chore(deps): update dependency eslint-plugin-sonarjs to ^0.24.0 by @renovate in https://github.com/yisibl/resvg-js/pull/298
• fix(deps): update rust crate env_logger to 0.11.0 by @renovate in https://github.com/yisibl/resvg-js/pull/301
• chore(deps): bump ip from 1.1.8 to 1.1.9 by @dependabot in https://github.com/yisibl/resvg-js/pull/303
• test: skip load url test by @yisibl in https://github.com/yisibl/resvg-js/pull/309
• fix: enable static link for windows-msvc by @Zagrios in https://github.com/yisibl/resvg-js/pull/308
• fix: test bindings on x86_64-unknown-linux-musl by @yisibl in https://github.com/yisibl/resvg-js/pull/306
• chore(deps): update dependency dts-bundle-generator to v9 by @renovate in https://github.com/yisibl/resvg-js/pull/285
• chore(deps): update dependency @swc-node/register to v1.9.0 by @renovate in https://github.com/yisibl/resvg-js/pull/265
• fix(deps): update rust crate svgtypes to 0.14.0 by @renovate in https://github.com/yisibl/resvg-js/pull/302

New Contributors

• @Zagrios made their first contribution in https://github.com/yisibl/resvg-js/pull/308

Full Changelog: https://github.com/yisibl/resvg-js/compare/v2.6.0...v2.6.1-beta.0

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: https://github.com/yisibl/resvg-js/compare/v2.5.0...v2.6.0

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

• @antmelnyk made their first contribution in https://github.com/yisibl/resvg-js/pull/217

Full Changelog: https://github.com/yisibl/resvg-js/compare/v2.4.1...v2.5.0

What's Changed

• fix: the defaultFontFamily not working by @yisibl in https://github.com/yisibl/resvg-js/pull/208
• Update README.md by @Nkay in https://github.com/yisibl/resvg-js/pull/206

New Contributors

• @Nkay made their first contribution in https://github.com/yisibl/resvg-js/pull/206

Full Changelog: https://github.com/yisibl/resvg-js/compare/v2.4.0...v2.4.1

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: https://github.com/yisibl/resvg-js/compare/v2.3.1...v2.4.0

What's Changed

• feat: upgrade wasm-bindgen to 0.2.84 by @yisibl in https://github.com/yisibl/resvg-js/pull/196

Full Changelog: https://github.com/yisibl/resvg-js/compare/v2.3.0...v2.3.1

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

• @hadeeb made their first contribution in https://github.com/yisibl/resvg-js/pull/186

Full Changelog: https://github.com/yisibl/resvg-js/compare/v2.2.0...v2.3.0

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/[email protected]/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

• @CGQAQ made their first contribution in https://github.com/yisibl/resvg-js/pull/161

Full Changelog: https://github.com/yisibl/resvg-js/compare/v2.1.0...v2.2.0

Added

• Add imagesToResolve() and resolveImage() APIs to load image URL. By @zimond in #102

  • Supports PNG, JPEG and GIF formats.
  • This only works for xlink:href starting with http:// or https://.
  • See example and playground for more details.

  In order to support loading image URL, we forked the rust side of resvg and made some improvements.

  Now please witness the magic moment:

  

• Add innerBBox() API. By @yisibl in #105

  Calculate a maximum bounding box of all visible elements in this SVG. (Note: path bounding box are approx values).

• Add getBBox() API. By @yisibl in #108

  We designed it to correspond to the SVGGraphicsElement.getBBox() method in the browser.

  This is different from the innerBBox() API, by default it does apply transform calculations and gets the BBox with curves exactly. This works well in most use cases, the only drawback is that it does not calculate BBoxes with stroke correctly.

• Add cropByBBox() API. By @yisibl in #108

  With this API, we can crop the generated bitmap based on the BBox(bounding box).

  const fs = require('fs')
  const { Resvg } = require('@resvg/resvg-js')
  const svg = '' // some SVG string or file.
  const resvg = new Resvg(svg)
  const innerBBox = resvg.innerBBox()
  const bbox = resvg.getBBox()
  
  // Crop the bitmap according to bbox,
  // The argument to the `.cropByBBox()` method accepts `bbox` or `innerBBox`.
  if (bbox) resvg.cropByBBox(bbox)
  const pngData = resvg.render()
  const pngBuffer = pngData.asPng()
  
  console.info('SVG BBox: ', `${bbox.width} x ${bbox.height}`)
  fs.writeFileSync('out.png', pngBuffer)
  

• feat: upgrade svgtypes to 0.8.1 to support 4 digits and 8 digits hex colors. By @yisibl in #127

All Changed

• fix: rebuild Wasm to solve the problem of not working in the browser by @yisibl in https://github.com/yisibl/resvg-js/pull/106
• chore(deps): upgrade napi-rs to 2.4.0 by @yisibl in https://github.com/yisibl/resvg-js/pull/107
• feat: add napi-rs and wasm_bindgen bindings to bbox by @yisibl in https://github.com/yisibl/resvg-js/pull/105
• feat: add cropByBBox and getBBox API by @yisibl in https://github.com/yisibl/resvg-js/pull/108
• build: re-enable the vercel app for playground by @yisibl in https://github.com/yisibl/resvg-js/pull/109
• feat: return undefined if bbox is invalid by @zimond in https://github.com/yisibl/resvg-js/pull/110
• Add image resolver API by @zimond in https://github.com/yisibl/resvg-js/pull/102
• style: rust indent changed from 2 to 4 spaces by @yisibl in https://github.com/yisibl/resvg-js/pull/114
• chore(deps): update dependency sharp to v0.30.5 [security] by @renovate in https://github.com/yisibl/resvg-js/pull/116
• chore: export AR in android pipeline by @yisibl in https://github.com/yisibl/resvg-js/pull/121
• fix(deps): update rust crate mimalloc-rust to 0.2 by @renovate in https://github.com/yisibl/resvg-js/pull/119
• fix(deps): update rust crate napi to 2.5.0 by @renovate in https://github.com/yisibl/resvg-js/pull/120
• chore: upgrade dependencies by @yisibl in https://github.com/yisibl/resvg-js/pull/126
• feat: upgrade svgtypes to 0.8.1 to support HEXA color format by @yisibl in https://github.com/yisibl/resvg-js/pull/127
• build: update the wasm file by @yisibl in https://github.com/yisibl/resvg-js/pull/128
• doc: v2.1.0 changelog by @yisibl in https://github.com/yisibl/resvg-js/pull/129

Full Changelog: https://github.com/yisibl/resvg-js/compare/v2.0.0...v2.1.0

What's Changed

• feat: add bbox related API by @zimond in https://github.com/yisibl/resvg-js/pull/90
  This version does not yet implement Node.js or Wasm bindings, so it is not available for now.

• fix: rebuild Wasm to solve the problem of not working in the browser by @yisibl in https://github.com/yisibl/resvg-js/pull/106

Full Changelog: https://github.com/yisibl/resvg-js/compare/v2.0.0...v2.0.1

What's Changed

The resvg-js API is now largely stable.

render() now no longer returns the Buffer directly, you need to get the buffer via the new render().asPng(), also added render().width and render().height to return the size of the PNG.

• feat: render result as a new class by @zimond in https://github.com/yisibl/resvg-js/pull/94
• test: add render().width/height test by @yisibl in https://github.com/yisibl/resvg-js/pull/96
• chore(deps): update dependency eslint-plugin-sonarjs to ^0.13.0 by @renovate in https://github.com/yisibl/resvg-js/pull/92
• chore(deps): bump minimist from 1.2.5 to 1.2.6 by @dependabot in https://github.com/yisibl/resvg-js/pull/93

Full Changelog: https://github.com/yisibl/resvg-js/compare/v2.0.0-alpha.6...v2.0.0-beta.0

What's Changed

• chore: add libc fields on linux platform packages by @yisibl in https://github.com/yisibl/resvg-js/pull/89

  On Linux, it is not possible to tell exactly what kind of C library a native modules depends on just by os/cpu, so yarn 3.2 and cnpm added libc fields to further distinguish this case. This avoids downloading both gnu and musl packages at the same time.

  Currently only yarn 3.2+ and cnpm are supported, the npm implementation is still under discussion.

Full Changelog: https://github.com/yisibl/resvg-js/compare/v2.0.0-alpha.5...v2.0.0-alpha.6

What's Changed

• feat: rounding width / height by @yisibl in https://github.com/yisibl/resvg-js/pull/85
• chore(deps): update dependency @types/sharp to ^0.30.0 by @renovate in https://github.com/yisibl/resvg-js/pull/86
• chore(deps): update actions/upload-artifact action to v3 by @renovate in https://github.com/yisibl/resvg-js/pull/87
• chore(deps): update actions/download-artifact action to v3 by @renovate in https://github.com/yisibl/resvg-js/pull/81
• chore(deps): update actions/checkout action to v3 by @renovate in https://github.com/yisibl/resvg-js/pull/80

Full Changelog: https://github.com/yisibl/resvg-js/compare/v2.0.0-alpha.4...v2.0.0-alpha.5

What's Changed

Added

• feat: strip text features and reduce the size of the generated wasm file.
  • before: 1949570 bytes
  • after: 1266413 bytes
• feat: upgrade to napi-rs 2.2.0.

Full Changelog: https://github.com/yisibl/resvg-js/compare/v1.4.0...v2.0.0-alpha.4

What's Changed

Added

• feat: add .width and .height to get the original size of the SVG.
• feat: add toString() to convert SVG shapes or text to path.

Changed

• refactor: change to Class API, now instead use new Resvg() to create the constructor.
  With the new Class API, we can avoid rendering the SVG again when getting the SVG size. It also makes it easier to extend new APIs.

Before

const { render } = require('@resvg/resvg-js')
const svg = '' // svg buffer or string
const pngData = render(svg, opts)

After

const { Resvg } = require('@resvg/resvg-js')
const svg = '' // svg buffer or string
const resvg = new Resvg(svg, opts)
const pngData = resvg.render()

// New!
console.info('Simplified svg string \n', resvg.toString())
console.info('SVG original size:', `${resvg.width} x ${resvg.height}px`)

New Contributors

• @JoKalliauer made their first contribution in https://github.com/yisibl/resvg-js/pull/69

Full Changelog: https://github.com/yisibl/resvg-js/compare/v1.4.0...v2.0.0-alpha.3

What's Changed

Added

• feat: upgrade resvg to 0.22.0

  Support svg referenced by <use>, this is often used in svg sprite.

  <svg viewBox="0 0 200 200" xmlns="http://www.w3.org/2000/svg" 
    xmlns:xlink="http://www.w3.org/1999/xlink">
    <svg id="svg1" xmlns="http://www.w3.org/2000/svg">
      <rect width="50%" height="50%" fill="green" />
    </svg>
    <use id="use1" x="50%" y="50%" xlink:href="#svg1" />
  </svg>
  

• feat: upgrade fontdb to 0.9.0, loading system fonts will become faster.

  There are many CJK fonts installed in my local OS, the test result is 2.5 times faster:

  • Before: Loaded 1085 font faces in 860.447ms.
  • After: Loaded 1085 font faces in 339.665ms.

What's Changed

• feat: playground uses unpkg.com's online resources

  <script src="https://unpkg.com/@resvg/[email protected]/index.min.js"></script>
  

• feat: preload wasm in the playground

  <link rel="preload" as="fetch" type="application/wasm" href="https://unpkg.com/@resvg/resvg-wasm/index_bg.wasm" />
  

• chore: upload wasm file to artifacts
  Switching from local to building in CI (Linux-x64-gnu) for .wasm files can reduce the file size a bit.

  • Local, Mac-x64-darwin: 1969225 bytes
  • CI, Linux-x64-gnu: 1949570 bytes

  After gzip compression, the .wasm file is only about 700kB.

Full Changelog: https://github.com/yisibl/resvg-js/compare/v2.0.0-alpha.0...v2.0.0-alpha.1