resvg-napi 0.2.0 → 0.3.1

package/index.d.ts

@@ -1,5 +1,6 @@
 /* auto-generated by NAPI-RS */
 /* eslint-disable */
+
 /** Read-only handle on a `usvg::ClipPath`. */
 export declare class ClipPath {
   /**
@@ -44,6 +45,11 @@ export declare class Font {
   get stretch(): FontStretch
   get weight(): number
   get variations(): Array<FontVariation>
+  /**
+   * Families this span asked for, in order. Never empty: usvg appends
+   * `RenderOptions.fontFamily` as the last resort.
+   */
+  get families(): Array<string>
 }
 
 /** Opaque wrapper over `fontdb::Database` (memory-mapped faces, no JSON form). */
@@ -360,6 +366,23 @@ export declare class Resvg {
    * `FontDatabase` and re-parse to fix the output.
    */
   pendingFonts(): Array<string>
+  /**
+   * The face that actually drew a glyph, from the database this
+   * document was parsed with.
+   *
+   * `pendingFonts()` names the families that were missing; this names
+   * what was used instead, glyph by glyph, which is the half a
+   * document-wide list cannot answer. A fallback that renders is the
+   * failure nobody sees.
+   *
+   * The lookup lives here rather than on `FontDatabase` because
+   * `PositionedGlyph.font` is a `fontdb::ID` -- a slotmap key with no
+   * public numeric form, and meaningless against any other database.
+   * The glyph carries it the way `FontFace` carries one for
+   * `FontDatabase.face`, and `null` means exactly that: a glyph from
+   * another document.
+   */
+  faceOf(glyph: PositionedGlyph): FontFace | null
   /**
    * Supplies one image and re-parses the document.
    *
@@ -690,18 +713,7 @@ export declare class TextSpan {
 }
 
 /** An alignment baseline property. */
-export type AlignmentBaseline =  'auto'|
-'baseline'|
-'beforeEdge'|
-'textBeforeEdge'|
-'middle'|
-'central'|
-'afterEdge'|
-'textAfterEdge'|
-'ideographic'|
-'alphabetic'|
-'hanging'|
-'mathematical';
+export type AlignmentBaseline = 'auto' | 'baseline' | 'beforeEdge' | 'textBeforeEdge' | 'middle' | 'central' | 'afterEdge' | 'textAfterEdge' | 'ideographic' | 'alphabetic' | 'hanging' | 'mathematical'
 
 /** `BaselineShift::Number`. */
 export interface BaselineShiftNumber {
@@ -736,22 +748,7 @@ export interface Blend {
  *
  * `mix-blend-mode` attribute in the SVG.
  */
-export type BlendMode =  'normal'|
-'multiply'|
-'screen'|
-'overlay'|
-'darken'|
-'lighten'|
-'colorDodge'|
-'colorBurn'|
-'hardLight'|
-'softLight'|
-'difference'|
-'exclusion'|
-'hue'|
-'saturation'|
-'color'|
-'luminosity';
+export type BlendMode = 'normal' | 'multiply' | 'screen' | 'overlay' | 'darken' | 'lighten' | 'colorDodge' | 'colorBurn' | 'hardLight' | 'softLight' | 'difference' | 'exclusion' | 'hue' | 'saturation' | 'color' | 'luminosity'
 
 /** Plain view of a `Color`. */
 export interface Color {
@@ -761,18 +758,14 @@ export interface Color {
 }
 
 /** A color channel. */
-export type ColorChannel =  'r'|
-'g'|
-'b'|
-'a';
+export type ColorChannel = 'r' | 'g' | 'b' | 'a'
 
 /**
  * A color interpolation mode.
  *
  * The default is `ColorInterpolation::LinearRGB`.
  */
-export type ColorInterpolation =  'srgb'|
-'linearRgb';
+export type ColorInterpolation = 'srgb' | 'linearRgb'
 
 /** Plain view of a `ColorMatrix`. */
 export interface ColorMatrix {
@@ -889,18 +882,7 @@ export interface DistantLight {
 }
 
 /** A dominant baseline property. */
-export type DominantBaseline =  'auto'|
-'useScript'|
-'noChange'|
-'resetSize'|
-'ideographic'|
-'alphabetic'|
-'hanging'|
-'mathematical'|
-'central'|
-'middle'|
-'textAfterEdge'|
-'textBeforeEdge';
+export type DominantBaseline = 'auto' | 'useScript' | 'noChange' | 'resetSize' | 'ideographic' | 'alphabetic' | 'hanging' | 'mathematical' | 'central' | 'middle' | 'textAfterEdge' | 'textBeforeEdge'
 
 /** Plain view of a `DropShadow`. */
 export interface DropShadow {
@@ -914,9 +896,7 @@ export interface DropShadow {
 }
 
 /** An edges processing mode. */
-export type EdgeMode =  'none'|
-'duplicate'|
-'wrap';
+export type EdgeMode = 'none' | 'duplicate' | 'wrap'
 
 /** Plain view of a `Fill`. */
 export interface Fill {
@@ -930,8 +910,7 @@ export interface Fill {
  *
  * `fill-rule` attribute in the SVG.
  */
-export type FillRule =  'nonZero'|
-'evenOdd';
+export type FillRule = 'nonZero' | 'evenOdd'
 
 /** Plain view of a `Flood`. */
 export interface Flood {
@@ -940,9 +919,7 @@ export interface Flood {
 }
 
 /** Allows italic or oblique faces to be selected. */
-export type FontFaceStyle =  'normal'|
-'italic'|
-'oblique';
+export type FontFaceStyle = 'normal' | 'italic' | 'oblique'
 
 /**
  * A font optical sizing property.
@@ -950,24 +927,13 @@ export type FontFaceStyle =  'normal'|
  * Controls automatic adjustment of the `opsz` axis in variable fonts
  * based on font size. Matches CSS `font-optical-sizing`.
  */
-export type FontOpticalSizing =  'auto'|
-'none';
+export type FontOpticalSizing = 'auto' | 'none'
 
 /** A font stretch property. */
-export type FontStretch =  'ultraCondensed'|
-'extraCondensed'|
-'condensed'|
-'semiCondensed'|
-'normal'|
-'semiExpanded'|
-'expanded'|
-'extraExpanded'|
-'ultraExpanded';
+export type FontStretch = 'ultraCondensed' | 'extraCondensed' | 'condensed' | 'semiCondensed' | 'normal' | 'semiExpanded' | 'expanded' | 'extraExpanded' | 'ultraExpanded'
 
 /** A font style property. */
-export type FontStyle =  'normal'|
-'italic'|
-'oblique';
+export type FontStyle = 'normal' | 'italic' | 'oblique'
 
 /** Plain view of a `FontVariation`. */
 export interface FontVariation {
@@ -993,12 +959,7 @@ export interface ImageKindSvg {
  *
  * `image-rendering` attribute in the SVG.
  */
-export type ImageRendering =  'optimizeQuality'|
-'optimizeSpeed'|
-'smooth'|
-'highQuality'|
-'crispEdges'|
-'pixelated';
+export type ImageRendering = 'optimizeQuality' | 'optimizeSpeed' | 'smooth' | 'highQuality' | 'crispEdges' | 'pixelated'
 
 /** The payload-free variants of `Input`. */
 export interface InputPlain {
@@ -1132,8 +1093,7 @@ export interface KindTurbulence {
 }
 
 /** A length adjust property. */
-export type LengthAdjust =  'spacing'|
-'spacingAndGlyphs';
+export type LengthAdjust = 'spacing' | 'spacingAndGlyphs'
 
 /** `LightSource::DistantLight`. */
 export interface LightSourceDistantLight {
@@ -1161,23 +1121,17 @@ export interface LightSourceSpotLight {
  *
  * `stroke-linecap` attribute in the SVG.
  */
-export type LineCap =  'butt'|
-'round'|
-'square';
+export type LineCap = 'butt' | 'round' | 'square'
 
 /**
  * A line join.
  *
  * `stroke-linejoin` attribute in the SVG.
  */
-export type LineJoin =  'miter'|
-'miterClip'|
-'round'|
-'bevel';
+export type LineJoin = 'miter' | 'miterClip' | 'round' | 'bevel'
 
 /** A mask type. */
-export type MaskType =  'luminance'|
-'alpha';
+export type MaskType = 'luminance' | 'alpha'
 
 /**
  * An affine transform. Field names and order are tiny-skia's.
@@ -1212,14 +1166,10 @@ export interface Morphology {
 }
 
 /** A morphology operation. */
-export type MorphologyOperator =  'erode'|
-'dilate';
+export type MorphologyOperator = 'erode' | 'dilate'
 
 /** Which flavour of node this is. */
-export type NodeKind =  'group'|
-'path'|
-'image'|
-'text';
+export type NodeKind = 'group' | 'path' | 'image' | 'text'
 
 /** Plain view of a `Offset`. */
 export interface Offset {
@@ -1250,8 +1200,7 @@ export interface PaintLinearGradient {
  *
  * [`paint-order`]: https://www.w3.org/TR/SVG2/painting.html#PaintOrder
  */
-export type PaintOrder =  'fillAndStroke'|
-'strokeAndFill';
+export type PaintOrder = 'fillAndStroke' | 'strokeAndFill'
 
 /** `Paint::Pattern`. */
 export interface PaintPattern {
@@ -1457,9 +1406,7 @@ export declare function setLogLevel(level: 'off' | 'error' | 'warn' | 'info' | '
  *
  * `shape-rendering` attribute in the SVG.
  */
-export type ShapeRendering =  'optimizeSpeed'|
-'crispEdges'|
-'geometricPrecision';
+export type ShapeRendering = 'optimizeSpeed' | 'crispEdges' | 'geometricPrecision'
 
 /** Plain view of a `SpecularLighting`. */
 export interface SpecularLighting {
@@ -1488,9 +1435,7 @@ export interface SpotLight {
  *
  * `spreadMethod` attribute in the SVG.
  */
-export type SpreadMethod =  'pad'|
-'reflect'|
-'repeat';
+export type SpreadMethod = 'pad' | 'reflect' | 'repeat'
 
 /** Plain view of a `Stop`. */
 export interface Stop {
@@ -1515,9 +1460,7 @@ export interface Stroke {
 export declare function takeLogs(): Array<string>
 
 /** A text chunk anchor property. */
-export type TextAnchor =  'start'|
-'middle'|
-'end';
+export type TextAnchor = 'start' | 'middle' | 'end'
 
 /** Plain view of a `TextDecoration`. */
 export interface TextDecoration {
@@ -1550,9 +1493,7 @@ export interface TextFlowPlain {
  *
  * `text-rendering` attribute in the SVG.
  */
-export type TextRendering =  'optimizeSpeed'|
-'optimizeLegibility'|
-'geometricPrecision';
+export type TextRendering = 'optimizeSpeed' | 'optimizeLegibility' | 'geometricPrecision'
 
 /** Plain view of a `Tile`. */
 export interface Tile {
@@ -1607,8 +1548,7 @@ export interface Turbulence {
 }
 
 /** A turbulence kind for the `feTurbulence` filter. */
-export type TurbulenceKind =  'fractalNoise'|
-'turbulence';
+export type TurbulenceKind = 'fractalNoise' | 'turbulence'
 
 /**
  * Mirror of `usvg::WriteOptions`, for `Resvg.toString()`. Every field is
@@ -1662,5 +1602,4 @@ export interface WriteOptions {
 }
 
 /** A writing mode. */
-export type WritingMode =  'leftToRight'|
-'topToBottom';
+export type WritingMode = 'leftToRight' | 'topToBottom'