resvg-napi 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,15 +1,17 @@
1
- # resvg-napi
1
+ # Render and inspect SVG
2
2
 
3
3
  [![npm](https://img.shields.io/npm/v/resvg-napi)](https://www.npmjs.com/package/resvg-napi)
4
4
  [![conformance](https://img.shields.io/badge/resvg%20conformance-1715%2F1715-brightgreen)](#conformance)
5
5
  [![licence](https://img.shields.io/npm/l/resvg-napi)](#licence)
6
6
 
7
- Node.js bindings for [resvg](https://github.com/linebender/resvg) 0.48: render
8
- SVG to PNG, and read back what usvg made of the document — the resolved tree,
9
- text metrics, paint, geometry.
7
+ Render an SVG to PNG, and read back what the renderer made of the document — the
8
+ resolved tree, text metrics, paint, geometry. Node.js bindings for
9
+ [resvg](https://github.com/linebender/resvg) 0.48, generated from the upstream
10
+ Rust sources, so the TypeScript surface is usvg's own, names and doc comments
11
+ included.
10
12
 
11
- Generated from the upstream Rust sources, so the TypeScript surface is usvg's
12
- own, names and doc comments included.
13
+ **[Try it in the browser](https://p8nut.github.io/resvg-napi/)** — the same
14
+ bindings compiled to WASI, rendering in the page, nothing to install.
13
15
 
14
16
  ```bash
15
17
  npm install resvg-napi
@@ -24,26 +26,42 @@ doc.renderRaw({ crop: doc.absLayerBoundingBox() }) // RGBA8, trimmed
24
26
  await renderAsync(svg, options, { width: 1200 }) // off the event loop
25
27
  ```
26
28
 
27
- ## What you can read back
29
+ `index.d.ts` is the reference — it is generated, so it cannot drift. What follows
30
+ is the map.
28
31
 
29
- `index.d.ts` is the reference — it is generated, so it cannot drift. This is
30
- the map.
32
+ ## Render SVG to PNG
31
33
 
32
- **Render.** Parse once with `new Resvg(svg, options?, fonts?, images?)`, then
33
- render as often as you like.
34
+ Parse once with `new Resvg(svg, options?, fonts?, images?)`, then render as often
35
+ as you like.
34
36
 
35
37
  | | |
36
38
  |---|---|
37
39
  | `renderPng(params?)` | `Buffer` |
38
40
  | `renderRaw(params?)` | `RawImage`, un-premultiplied RGBA8 |
39
- | `toString(opts?)` | the resolved tree, back as SVG |
41
+ | `toString(opts?)` | the resolved tree, back as SVG — text as paths unless `preserveText` |
40
42
  | `renderPngAsync` · `renderRawAsync` · `toStringAsync` | the same, off the event loop, `AbortSignal`-aware |
41
43
 
42
44
  `params` carries `width` / `height` / `scale`, a `background` colour and a
43
45
  `crop` box. `Resvg.parseAsync` moves the parse off the loop too.
44
46
 
45
- **Walk the tree.** `node(id)` and `children()` hand back `SvgNode`s, and each
46
- one knows what it is:
47
+ ## Text as outlines
48
+
49
+ `toString()` hands back the resolved tree with **the text converted to paths** —
50
+ an SVG that draws the same where the font is not installed, which is what a
51
+ print or PDF pipeline needs from a template:
52
+
53
+ ```js
54
+ const doc = new Resvg(svg, { fontFamily: 'DejaVu Sans' }, fonts)
55
+ doc.toString() // one <path> per glyph, no <text>
56
+ doc.toString({ preserveText: true }) // <text> kept, resolved but not outlined
57
+ ```
58
+
59
+ The outlines come from the same layout `renderPng` draws, so a glyph sits where
60
+ the raster puts it — and `extent()` measured it before either.
61
+
62
+ ## Inspect the usvg tree
63
+
64
+ `node(id)` and `children()` hand back `SvgNode`s, and each one knows what it is:
47
65
 
48
66
  ```js
49
67
  const n = doc.node('surname')
@@ -68,24 +86,75 @@ if (paint?.type === 'color') paint.value // { red, green, blue }
68
86
  else paint?.id // the gradient or pattern it names
69
87
  ```
70
88
 
71
- **Measure.** Every node reports `boundingBox()`, `absBoundingBox()`,
72
- `strokeBoundingBox()`, `absLayerBoundingBox()` and `extent()` — in the
73
- document's own units, which is not the canvas. See *Fitting text* below for why
89
+ ## Measure text and geometry
90
+
91
+ Every node reports `boundingBox()`, `absBoundingBox()`, `strokeBoundingBox()`,
92
+ `absLayerBoundingBox()` and `extent()` — in the document's own units, which is
93
+ not the canvas. See [Fitting text to a width](#fitting-text-to-a-width) for why
74
94
  that distinction bites.
75
95
 
76
- **Fonts.** `FontDatabase` is `fontdb` itself: `loadSystemFonts()`,
77
- `loadFontData(buffer)`, `loadFontFile(path)`, `faces()`, `query()`, and the
78
- generic-family setters. A face reports its `families`, `weight`, `style`
79
- (`'normal' | 'italic' | 'oblique'`) and whether it is `monospaced`. `pendingFonts()` on a parsed document names the
80
- families it wanted and did not get; `pendingImages()` does the same for hrefs.
96
+ ## Fonts
97
+
98
+ `FontDatabase` is `fontdb` itself: `loadSystemFonts()`, `loadFontData(buffer)`,
99
+ `loadFontFile(path)`, `faces()`, `query()`, and the generic-family setters. A
100
+ face reports its `families`, `weight`, `style` (`'normal' | 'italic' |
101
+ 'oblique'`) and whether it is `monospaced`. `pendingFonts()` on a parsed document
102
+ names the families it wanted and did not get; `pendingImages()` does the same for
103
+ hrefs.
104
+
105
+ `pendingFonts()` names the families nobody had. `faceOf(glyph)` names the face
106
+ that drew the text instead — the substitution a document-wide list cannot show,
107
+ and the one that survives to print:
108
+
109
+ ```js
110
+ const text = doc.node('title').text()
111
+ text.chunks[0].spans[0].font.families // ['Brand Sans', 'DejaVu Sans'] — asked for
112
+ for (const glyph of text.layouted[0].positionedGlyphs) {
113
+ doc.faceOf(glyph)?.postScriptName // 'DejaVuSans' — what actually drew it
114
+ }
115
+ ```
116
+
117
+ `faceOf` returns `null` only for a glyph from another document: the id a glyph
118
+ carries is a key into the font database its own document was parsed with.
119
+
120
+ ## Paint servers
121
+
122
+ `linearGradients()`, `radialGradients()`, `patterns()`, `clipPaths()`, `masks()`,
123
+ `filters()` — the paint servers an element's `id` refers to.
124
+
125
+ ## Examples
126
+
127
+ Four templates in [`demo/examples/`](demo/examples), each rendered by
128
+ `node demo/render.mjs <template.svg>`: Liquid fills the template from the JSON
129
+ file next to it, this binding rasterises the result. The images below are that
130
+ command's output.
131
+
132
+ ### Roster — a table from a JSON array
133
+
134
+ ![roster](https://raw.githubusercontent.com/p8nut/resvg-napi/main/demo/assets/roster.png)
81
135
 
82
- **Definitions.** `linearGradients()`, `radialGradients()`, `patterns()`,
83
- `clipPaths()`, `masks()`, `filters()` — the paint servers an element's `id`
84
- refers to.
136
+ A `staff` array becomes rows, with an embedded logo and a QR code generated
137
+ during templating. The fourth name runs straight into the column beside it —
138
+ measuring that overflow, and compressing it away, is what [Fitting text to a
139
+ width](#fitting-text-to-a-width) below is for.
85
140
 
86
- Something missing? The generator keeps a report of every upstream member it
87
- left alone, with the reason. `RESVG_NAPI_CODEGEN_LOG=1 cargo build` prints it,
88
- and [CONTRIBUTING.md](CONTRIBUTING.md) explains what the reasons mean.
141
+ ### Photo card — images and glyphs
142
+
143
+ ![photo card](https://raw.githubusercontent.com/p8nut/resvg-napi/main/demo/assets/photo-card.png)
144
+
145
+ Everything a card does with raster images and type, and nothing it does with
146
+ data.
147
+
148
+ ### Badge sheet — one template, stamped per record
149
+
150
+ ![badge sheet](https://raw.githubusercontent.com/p8nut/resvg-napi/main/demo/assets/badge-sheet.png)
151
+
152
+ Pulls `badge.svg` in as a partial and repeats it. A guided tour, where every zone
153
+ of the page is one Liquid capability.
154
+
155
+ `sheet.svg` covers the data half — pagination, grouping, theming, and
156
+ `--lang fr` driving `<switch systemLanguage>`, which usvg picks nothing from
157
+ without a language.
89
158
 
90
159
  ## Conformance
91
160
 
@@ -139,7 +208,6 @@ generated shims and test run are a different code path. The other eleven build
139
208
  on the merge, on a `v*` tag, on a manual dispatch, or on a pull request labelled
140
209
  `full-matrix` when the proof is wanted before merging rather than after.
141
210
 
142
-
143
211
  ## Fitting text to a width
144
212
 
145
213
  An Illustrator template says how wide a field may be on the element itself
@@ -174,7 +242,7 @@ left untouched, and a constraint that cannot be honoured says why: no `id` to
174
242
  measure by, no visible extent, or an unusable width. It compresses glyphs rather
175
243
  than reducing `font-size` — the choice the templates already made.
176
244
 
177
- ## Diagnostics
245
+ ## Warnings and logs
178
246
 
179
247
  usvg and resvg report every recoverable problem through the `log` crate —
180
248
  unparsable values, skipped shapes, unmatched font families, images that could not
@@ -193,12 +261,50 @@ takeLogs()
193
261
  `takeLogs()` drains the buffer, which is capped at 500 entries so a pathological
194
262
  document cannot grow it without end.
195
263
 
196
- ## Elsewhere
264
+ ## Troubleshooting
265
+
266
+ **A font family did not apply.** `pendingFonts()` on the parsed document names
267
+ the families it asked for and did not get, and `faceOf(glyph)` names the face
268
+ that was used in their place. Supply them with
269
+ `loadFontFile(path)` or `loadFontData(buffer)` before rendering. Under WASI,
270
+ `loadSystemFonts()` finds nothing inside the sandbox, so every face has to be
271
+ loaded by hand.
272
+
273
+ **An image did not appear.** `pendingImages()` names the hrefs that could not be
274
+ resolved.
275
+
276
+ **A measurement disagrees with the numbers in the file.** Bounding boxes are in
277
+ the document's own units and usvg normalises the tree, so they are not canvas
278
+ pixels. See [Fitting text to a width](#fitting-text-to-a-width) for the arithmetic.
279
+
280
+ **Something was dropped and nothing said so.** usvg reports it through the `log`
281
+ crate and nothing consumes that by default — see [Warnings and
282
+ logs](#warnings-and-logs).
283
+
284
+ **A member is missing from the TypeScript surface.** The generator keeps a report
285
+ of every upstream member it left alone, with the reason.
286
+ `RESVG_NAPI_CODEGEN_LOG=1 cargo build` prints it, and
287
+ [CONTRIBUTING.md](CONTRIBUTING.md) explains what the reasons mean.
288
+
289
+ ## Demo
290
+
291
+ A browser proof bench for the same bindings compiled to WASI: Liquid templating,
292
+ an array editor, per-element export, live diagnostics. Deployed from `main` at
293
+ **[p8nut.github.io/resvg-napi](https://p8nut.github.io/resvg-napi/)**, and it
294
+ runs locally too:
295
+
296
+ ```bash
297
+ npm run demo
298
+ ```
299
+
300
+ ![the proof bench](https://raw.githubusercontent.com/p8nut/resvg-napi/main/demo/assets/screenshot.png)
301
+
302
+ [demo/README.md](demo/README.md) describes the page.
303
+
304
+ ## Contributing
197
305
 
198
- - **[demo/](demo/README.md)** — a browser proof bench: Liquid templating, an
199
- array editor, per-element export, live diagnostics. `npm run demo`.
200
- - **[CONTRIBUTING.md](CONTRIBUTING.md)** — how the bindings are generated, and
201
- what to read before touching `build.rs`.
306
+ [CONTRIBUTING.md](CONTRIBUTING.md) — how the bindings are generated, and what to
307
+ read before touching the generator.
202
308
 
203
309
  ## Licence
204
310
 
package/index.d.ts CHANGED
@@ -44,6 +44,11 @@ export declare class Font {
44
44
  get stretch(): FontStretch
45
45
  get weight(): number
46
46
  get variations(): Array<FontVariation>
47
+ /**
48
+ * Families this span asked for, in order. Never empty: usvg appends
49
+ * `RenderOptions.fontFamily` as the last resort.
50
+ */
51
+ get families(): Array<string>
47
52
  }
48
53
 
49
54
  /** Opaque wrapper over `fontdb::Database` (memory-mapped faces, no JSON form). */
@@ -360,6 +365,23 @@ export declare class Resvg {
360
365
  * `FontDatabase` and re-parse to fix the output.
361
366
  */
362
367
  pendingFonts(): Array<string>
368
+ /**
369
+ * The face that actually drew a glyph, from the database this
370
+ * document was parsed with.
371
+ *
372
+ * `pendingFonts()` names the families that were missing; this names
373
+ * what was used instead, glyph by glyph, which is the half a
374
+ * document-wide list cannot answer. A fallback that renders is the
375
+ * failure nobody sees.
376
+ *
377
+ * The lookup lives here rather than on `FontDatabase` because
378
+ * `PositionedGlyph.font` is a `fontdb::ID` -- a slotmap key with no
379
+ * public numeric form, and meaningless against any other database.
380
+ * The glyph carries it the way `FontFace` carries one for
381
+ * `FontDatabase.face`, and `null` means exactly that: a glyph from
382
+ * another document.
383
+ */
384
+ faceOf(glyph: PositionedGlyph): FontFace | null
363
385
  /**
364
386
  * Supplies one image and re-parses the document.
365
387
  *
package/index.js CHANGED
@@ -77,8 +77,8 @@ function requireNative() {
77
77
  try {
78
78
  const binding = require('resvg-napi-android-arm64')
79
79
  const bindingPackageVersion = require('resvg-napi-android-arm64/package.json').version
80
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
81
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
80
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
81
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
82
82
  }
83
83
  return binding
84
84
  } catch (e) {
@@ -93,8 +93,8 @@ function requireNative() {
93
93
  try {
94
94
  const binding = require('resvg-napi-android-arm-eabi')
95
95
  const bindingPackageVersion = require('resvg-napi-android-arm-eabi/package.json').version
96
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
97
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
96
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
97
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
98
98
  }
99
99
  return binding
100
100
  } catch (e) {
@@ -114,8 +114,8 @@ function requireNative() {
114
114
  try {
115
115
  const binding = require('resvg-napi-win32-x64-gnu')
116
116
  const bindingPackageVersion = require('resvg-napi-win32-x64-gnu/package.json').version
117
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
118
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
117
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
118
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
119
119
  }
120
120
  return binding
121
121
  } catch (e) {
@@ -130,8 +130,8 @@ function requireNative() {
130
130
  try {
131
131
  const binding = require('resvg-napi-win32-x64-msvc')
132
132
  const bindingPackageVersion = require('resvg-napi-win32-x64-msvc/package.json').version
133
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
134
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
133
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
134
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
135
135
  }
136
136
  return binding
137
137
  } catch (e) {
@@ -147,8 +147,8 @@ function requireNative() {
147
147
  try {
148
148
  const binding = require('resvg-napi-win32-ia32-msvc')
149
149
  const bindingPackageVersion = require('resvg-napi-win32-ia32-msvc/package.json').version
150
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
151
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
150
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
151
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
152
152
  }
153
153
  return binding
154
154
  } catch (e) {
@@ -163,8 +163,8 @@ function requireNative() {
163
163
  try {
164
164
  const binding = require('resvg-napi-win32-arm64-msvc')
165
165
  const bindingPackageVersion = require('resvg-napi-win32-arm64-msvc/package.json').version
166
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
167
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
166
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
167
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
168
168
  }
169
169
  return binding
170
170
  } catch (e) {
@@ -182,8 +182,8 @@ function requireNative() {
182
182
  try {
183
183
  const binding = require('resvg-napi-darwin-universal')
184
184
  const bindingPackageVersion = require('resvg-napi-darwin-universal/package.json').version
185
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
186
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
185
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
186
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
187
187
  }
188
188
  return binding
189
189
  } catch (e) {
@@ -198,8 +198,8 @@ function requireNative() {
198
198
  try {
199
199
  const binding = require('resvg-napi-darwin-x64')
200
200
  const bindingPackageVersion = require('resvg-napi-darwin-x64/package.json').version
201
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
202
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
201
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
202
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
203
203
  }
204
204
  return binding
205
205
  } catch (e) {
@@ -214,8 +214,8 @@ function requireNative() {
214
214
  try {
215
215
  const binding = require('resvg-napi-darwin-arm64')
216
216
  const bindingPackageVersion = require('resvg-napi-darwin-arm64/package.json').version
217
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
218
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
217
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
218
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
219
219
  }
220
220
  return binding
221
221
  } catch (e) {
@@ -234,8 +234,8 @@ function requireNative() {
234
234
  try {
235
235
  const binding = require('resvg-napi-freebsd-x64')
236
236
  const bindingPackageVersion = require('resvg-napi-freebsd-x64/package.json').version
237
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
238
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
237
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
238
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
239
239
  }
240
240
  return binding
241
241
  } catch (e) {
@@ -250,8 +250,8 @@ function requireNative() {
250
250
  try {
251
251
  const binding = require('resvg-napi-freebsd-arm64')
252
252
  const bindingPackageVersion = require('resvg-napi-freebsd-arm64/package.json').version
253
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
254
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
253
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
254
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
255
255
  }
256
256
  return binding
257
257
  } catch (e) {
@@ -271,8 +271,8 @@ function requireNative() {
271
271
  try {
272
272
  const binding = require('resvg-napi-linux-x64-musl')
273
273
  const bindingPackageVersion = require('resvg-napi-linux-x64-musl/package.json').version
274
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
275
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
274
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
275
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
276
276
  }
277
277
  return binding
278
278
  } catch (e) {
@@ -287,8 +287,8 @@ function requireNative() {
287
287
  try {
288
288
  const binding = require('resvg-napi-linux-x64-gnu')
289
289
  const bindingPackageVersion = require('resvg-napi-linux-x64-gnu/package.json').version
290
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
291
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
290
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
291
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
292
292
  }
293
293
  return binding
294
294
  } catch (e) {
@@ -305,8 +305,8 @@ function requireNative() {
305
305
  try {
306
306
  const binding = require('resvg-napi-linux-arm64-musl')
307
307
  const bindingPackageVersion = require('resvg-napi-linux-arm64-musl/package.json').version
308
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
309
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
308
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
309
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
310
310
  }
311
311
  return binding
312
312
  } catch (e) {
@@ -321,8 +321,8 @@ function requireNative() {
321
321
  try {
322
322
  const binding = require('resvg-napi-linux-arm64-gnu')
323
323
  const bindingPackageVersion = require('resvg-napi-linux-arm64-gnu/package.json').version
324
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
325
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
324
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
325
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
326
326
  }
327
327
  return binding
328
328
  } catch (e) {
@@ -339,8 +339,8 @@ function requireNative() {
339
339
  try {
340
340
  const binding = require('resvg-napi-linux-arm-musleabihf')
341
341
  const bindingPackageVersion = require('resvg-napi-linux-arm-musleabihf/package.json').version
342
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
343
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
342
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
343
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
344
344
  }
345
345
  return binding
346
346
  } catch (e) {
@@ -355,8 +355,8 @@ function requireNative() {
355
355
  try {
356
356
  const binding = require('resvg-napi-linux-arm-gnueabihf')
357
357
  const bindingPackageVersion = require('resvg-napi-linux-arm-gnueabihf/package.json').version
358
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
359
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
358
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
359
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
360
360
  }
361
361
  return binding
362
362
  } catch (e) {
@@ -373,8 +373,8 @@ function requireNative() {
373
373
  try {
374
374
  const binding = require('resvg-napi-linux-loong64-musl')
375
375
  const bindingPackageVersion = require('resvg-napi-linux-loong64-musl/package.json').version
376
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
377
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
376
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
377
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
378
378
  }
379
379
  return binding
380
380
  } catch (e) {
@@ -389,8 +389,8 @@ function requireNative() {
389
389
  try {
390
390
  const binding = require('resvg-napi-linux-loong64-gnu')
391
391
  const bindingPackageVersion = require('resvg-napi-linux-loong64-gnu/package.json').version
392
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
393
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
392
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
393
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
394
394
  }
395
395
  return binding
396
396
  } catch (e) {
@@ -407,8 +407,8 @@ function requireNative() {
407
407
  try {
408
408
  const binding = require('resvg-napi-linux-riscv64-musl')
409
409
  const bindingPackageVersion = require('resvg-napi-linux-riscv64-musl/package.json').version
410
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
411
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
410
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
411
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
412
412
  }
413
413
  return binding
414
414
  } catch (e) {
@@ -423,8 +423,8 @@ function requireNative() {
423
423
  try {
424
424
  const binding = require('resvg-napi-linux-riscv64-gnu')
425
425
  const bindingPackageVersion = require('resvg-napi-linux-riscv64-gnu/package.json').version
426
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
427
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
426
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
427
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
428
428
  }
429
429
  return binding
430
430
  } catch (e) {
@@ -440,8 +440,8 @@ function requireNative() {
440
440
  try {
441
441
  const binding = require('resvg-napi-linux-ppc64-gnu')
442
442
  const bindingPackageVersion = require('resvg-napi-linux-ppc64-gnu/package.json').version
443
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
444
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
443
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
444
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
445
445
  }
446
446
  return binding
447
447
  } catch (e) {
@@ -456,8 +456,8 @@ function requireNative() {
456
456
  try {
457
457
  const binding = require('resvg-napi-linux-s390x-gnu')
458
458
  const bindingPackageVersion = require('resvg-napi-linux-s390x-gnu/package.json').version
459
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
460
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
459
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
460
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
461
461
  }
462
462
  return binding
463
463
  } catch (e) {
@@ -476,8 +476,8 @@ function requireNative() {
476
476
  try {
477
477
  const binding = require('resvg-napi-openharmony-arm64')
478
478
  const bindingPackageVersion = require('resvg-napi-openharmony-arm64/package.json').version
479
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
480
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
479
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
480
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
481
481
  }
482
482
  return binding
483
483
  } catch (e) {
@@ -492,8 +492,8 @@ function requireNative() {
492
492
  try {
493
493
  const binding = require('resvg-napi-openharmony-x64')
494
494
  const bindingPackageVersion = require('resvg-napi-openharmony-x64/package.json').version
495
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
496
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
495
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
496
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
497
497
  }
498
498
  return binding
499
499
  } catch (e) {
@@ -508,8 +508,8 @@ function requireNative() {
508
508
  try {
509
509
  const binding = require('resvg-napi-openharmony-arm')
510
510
  const bindingPackageVersion = require('resvg-napi-openharmony-arm/package.json').version
511
- if (bindingPackageVersion !== '0.2.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
512
- throw new Error(`Native binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
511
+ if (bindingPackageVersion !== '0.3.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
512
+ throw new Error(`Native binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
513
513
  }
514
514
  return binding
515
515
  } catch (e) {
@@ -648,8 +648,8 @@ if (!nativeBinding || forceWasi) {
648
648
  if (!candidateFailed) {
649
649
  if (process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
650
650
  const bindingPackageVersion = require('resvg-napi-wasm32-wasi/package.json').version
651
- if (bindingPackageVersion !== '0.2.0') {
652
- throw new Error(`WASI binding package version mismatch, expected 0.2.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
651
+ if (bindingPackageVersion !== '0.3.0') {
652
+ throw new Error(`WASI binding package version mismatch, expected 0.3.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
653
653
  }
654
654
  }
655
655
  wasiBinding = require('resvg-napi-wasm32-wasi')
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "resvg-napi",
3
- "version": "0.2.0",
4
- "description": "Node bindings for resvg, generated from the upstream Rust sources: SVG to PNG, the usvg tree, fonts and text measurement.",
3
+ "version": "0.3.0",
4
+ "description": "Render SVG to PNG in Node — and read back the resolved tree, text metrics and fonts. Powered by resvg.",
5
5
  "keywords": [
6
6
  "svg",
7
7
  "png",
@@ -27,7 +27,9 @@
27
27
  "artifacts": "napi artifacts",
28
28
  "create-npm-dirs": "napi create-npm-dirs",
29
29
  "version": "napi version",
30
- "demo": "napi build --platform --release --target wasm32-wasip1-threads && cp resvg-napi.wasm32-wasi.wasm demo/ && esbuild resvg-napi.wasi-browser.js --bundle --format=esm --outfile=demo/resvg.js && esbuild wasi-worker-browser.mjs --bundle --format=esm --outfile=demo/wasi-worker-browser.mjs && esbuild demo/liquid-entry.mjs --bundle --format=esm --outfile=demo/liquid.js && node demo/serve.mjs",
30
+ "demo": "npm run demo:build && node demo/serve.mjs",
31
+ "demo:build": "npm run demo:wasm && node demo/build.mjs",
32
+ "demo:wasm": "napi build --platform --release --target wasm32-wasip1-threads",
31
33
  "check:pins": "node scripts/check-pins.mjs",
32
34
  "check:pins:selftest": "node scripts/check-pins.mjs --selftest",
33
35
  "check:package": "node scripts/check-package.mjs",
@@ -49,7 +51,7 @@
49
51
  "@napi-rs/cli": "^3.8.6",
50
52
  "@types/node": "^26.2.0",
51
53
  "emnapi": "1.11.2",
52
- "esbuild": "^0.25.12",
54
+ "esbuild": "^0.28.2",
53
55
  "liquidjs": "^10.29.0",
54
56
  "pngjs": "^7.0.0",
55
57
  "qrcode-generator": "^2.0.4",
@@ -103,18 +105,18 @@
103
105
  "url": "git+https://github.com/p8nut/resvg-napi.git"
104
106
  },
105
107
  "optionalDependencies": {
106
- "resvg-napi-linux-x64-gnu": "0.2.0",
107
- "resvg-napi-linux-arm64-gnu": "0.2.0",
108
- "resvg-napi-linux-arm-gnueabihf": "0.2.0",
109
- "resvg-napi-linux-x64-musl": "0.2.0",
110
- "resvg-napi-linux-arm64-musl": "0.2.0",
111
- "resvg-napi-darwin-arm64": "0.2.0",
112
- "resvg-napi-darwin-x64": "0.2.0",
113
- "resvg-napi-win32-x64-msvc": "0.2.0",
114
- "resvg-napi-win32-ia32-msvc": "0.2.0",
115
- "resvg-napi-win32-arm64-msvc": "0.2.0",
116
- "resvg-napi-android-arm64": "0.2.0",
117
- "resvg-napi-android-arm-eabi": "0.2.0"
108
+ "resvg-napi-linux-x64-gnu": "0.3.0",
109
+ "resvg-napi-linux-arm64-gnu": "0.3.0",
110
+ "resvg-napi-linux-arm-gnueabihf": "0.3.0",
111
+ "resvg-napi-linux-x64-musl": "0.3.0",
112
+ "resvg-napi-linux-arm64-musl": "0.3.0",
113
+ "resvg-napi-darwin-arm64": "0.3.0",
114
+ "resvg-napi-darwin-x64": "0.3.0",
115
+ "resvg-napi-win32-x64-msvc": "0.3.0",
116
+ "resvg-napi-win32-ia32-msvc": "0.3.0",
117
+ "resvg-napi-win32-arm64-msvc": "0.3.0",
118
+ "resvg-napi-android-arm64": "0.3.0",
119
+ "resvg-napi-android-arm-eabi": "0.3.0"
118
120
  },
119
121
  "dependencies": {
120
122
  "@emnapi/runtime": "1.11.2",
@@ -44,6 +44,11 @@ export declare class Font {
44
44
  get stretch(): FontStretch
45
45
  get weight(): number
46
46
  get variations(): Array<FontVariation>
47
+ /**
48
+ * Families this span asked for, in order. Never empty: usvg appends
49
+ * `RenderOptions.fontFamily` as the last resort.
50
+ */
51
+ get families(): Array<string>
47
52
  }
48
53
 
49
54
  /** Opaque wrapper over `fontdb::Database` (memory-mapped faces, no JSON form). */
@@ -360,6 +365,23 @@ export declare class Resvg {
360
365
  * `FontDatabase` and re-parse to fix the output.
361
366
  */
362
367
  pendingFonts(): Array<string>
368
+ /**
369
+ * The face that actually drew a glyph, from the database this
370
+ * document was parsed with.
371
+ *
372
+ * `pendingFonts()` names the families that were missing; this names
373
+ * what was used instead, glyph by glyph, which is the half a
374
+ * document-wide list cannot answer. A fallback that renders is the
375
+ * failure nobody sees.
376
+ *
377
+ * The lookup lives here rather than on `FontDatabase` because
378
+ * `PositionedGlyph.font` is a `fontdb::ID` -- a slotmap key with no
379
+ * public numeric form, and meaningless against any other database.
380
+ * The glyph carries it the way `FontFace` carries one for
381
+ * `FontDatabase.face`, and `null` means exactly that: a glyph from
382
+ * another document.
383
+ */
384
+ faceOf(glyph: PositionedGlyph): FontFace | null
363
385
  /**
364
386
  * Supplies one image and re-parses the document.
365
387
  *