@napi-rs/canvas 0.1.81 → 0.1.82

package/index.d.ts

@@ -18,7 +18,8 @@ interface CanvasRenderingContext2D
     CanvasState,
     CanvasText,
     CanvasTextDrawingStyles,
-    CanvasTransform {}
+    CanvasTransform,
+    CanvasPDFAnnotations {}
 
 interface CanvasState {
   isContextLost(): boolean
@@ -120,6 +121,40 @@ interface CanvasTransform {
   transform(a: number, b: number, c: number, d: number, e: number, f: number): void
   translate(x: number, y: number): void
 }
+
+interface CanvasPDFAnnotations {
+  /**
+   * Create a clickable URL link annotation in a PDF document.
+   * This is only effective when used with PDF documents.
+   * @param left - Left coordinate of the link rectangle
+   * @param top - Top coordinate of the link rectangle
+   * @param right - Right coordinate of the link rectangle
+   * @param bottom - Bottom coordinate of the link rectangle
+   * @param url - The URL to link to
+   */
+  annotateLinkUrl(left: number, top: number, right: number, bottom: number, url: string): void
+
+  /**
+   * Create a named destination at a specific point in a PDF document.
+   * This destination can be used as a target for internal links.
+   * @param x - X coordinate of the destination point
+   * @param y - Y coordinate of the destination point
+   * @param name - Name identifier for the destination
+   */
+  annotateNamedDestination(x: number, y: number, name: string): void
+
+  /**
+   * Create a link to a named destination within the PDF document.
+   * This is only effective when used with PDF documents.
+   * @param left - Left coordinate of the link rectangle
+   * @param top - Top coordinate of the link rectangle
+   * @param right - Right coordinate of the link rectangle
+   * @param bottom - Bottom coordinate of the link rectangle
+   * @param name - Name of the destination to link to
+   */
+  annotateLinkToDestination(left: number, top: number, right: number, bottom: number, name: string): void
+}
+
 type PredefinedColorSpace = 'display-p3' | 'srgb'
 
 interface ImageDataSettings {
@@ -455,7 +490,7 @@ export class ImageData {
 
   constructor(sw: number, sh: number, attr?: { colorSpace?: ColorSpace })
   constructor(imageData: ImageData, attr?: { colorSpace?: ColorSpace })
-  constructor(data: Uint8ClampedArray, sw: number, sh?: number)
+  constructor(data: Uint8ClampedArray | Uint16Array | Float16Array | Float32Array, sw: number, sh?: number)
 }
 
 export class Image {
@@ -731,3 +766,40 @@ export function loadImage(
   source: string | URL | Buffer | ArrayBufferLike | Uint8Array | Image | import('stream').Readable,
   options?: LoadImageOptions,
 ): Promise<Image>
+
+export interface PDFMetadata {
+  /// The document's title
+  title?: string
+  /// The name of the person who created the document
+  author?: string
+  /// The subject of the document
+  subject?: string
+  /// Keywords associated with the document
+  keywords?: string
+  /// The product that created the original document
+  creator?: string
+  /// The product that is converting this document to PDF (defaults to "Skia/PDF")
+  producer?: string
+  /// The DPI for rasterization (default: 72.0)
+  rasterDPI?: number
+  /// Encoding quality: 0-100 for lossy JPEG, 101 for lossless (default: 101)
+  encodingQuality?: number
+  /// Whether to conform to PDF/A-2b standard (default: false)
+  pdfa?: boolean
+  /// Compression level: -1 (default), 0 (none), 1 (low/fast), 6 (average), 9 (high/slow)
+  compressionLevel?: number
+}
+
+export interface Rect {
+  left: number
+  top: number
+  right: number
+  bottom: number
+}
+
+export declare class PDFDocument {
+  constructor(metadata?: PDFMetadata | undefined | null)
+  beginPage(width: number, height: number, rect?: Rect | undefined | null): CanvasRenderingContext2D
+  endPage(): void
+  close(): Buffer
+}

package/index.js

@@ -16,6 +16,7 @@ const {
   StrokeJoin,
   StrokeCap,
   convertSVGTextToPath,
+  PdfDocument,
 } = require('./js-binding')
 
 const { DOMPoint, DOMMatrix, DOMRect } = require('./geometry')
@@ -176,4 +177,5 @@ module.exports = {
   // Export these for better webpack compatibility
   CanvasElement,
   SVGCanvas,
+  PDFDocument: PdfDocument,
 }

package/js-binding.js

@@ -32,7 +32,11 @@ const isMuslFromFilesystem = () => {
 }
 
 const isMuslFromReport = () => {
-  const report = typeof process.report.getReport === 'function' ? process.report.getReport() : null
+  let report = null
+  if (typeof process.report?.getReport === 'function') {
+    process.report.excludeNetwork = true
+    report = process.report.getReport()
+  }
   if (!report) {
     return null
   }
@@ -59,7 +63,7 @@ const isMuslFromChildProcess = () => {
 function requireNative() {
   if (process.env.NAPI_RS_NATIVE_LIBRARY_PATH) {
     try {
-      nativeBinding = require(process.env.NAPI_RS_NATIVE_LIBRARY_PATH)
+      return require(process.env.NAPI_RS_NATIVE_LIBRARY_PATH)
     } catch (err) {
       loadErrors.push(err)
     }
@@ -91,15 +95,31 @@ function requireNative() {
     }
   } else if (process.platform === 'win32') {
     if (process.arch === 'x64') {
-      try {
-        return require('./skia.win32-x64-msvc.node')
-      } catch (e) {
-        loadErrors.push(e)
-      }
-      try {
-        return require('@napi-rs/canvas-win32-x64-msvc')
-      } catch (e) {
-        loadErrors.push(e)
+      if (
+        process.config?.variables?.shlib_suffix === 'dll.a' ||
+        process.config?.variables?.node_target_type === 'shared_library'
+      ) {
+        try {
+          return require('./skia.win32-x64-gnu.node')
+        } catch (e) {
+          loadErrors.push(e)
+        }
+        try {
+          return require('@napi-rs/canvas-win32-x64-gnu')
+        } catch (e) {
+          loadErrors.push(e)
+        }
+      } else {
+        try {
+          return require('./skia.win32-x64-msvc.node')
+        } catch (e) {
+          loadErrors.push(e)
+        }
+        try {
+          return require('@napi-rs/canvas-win32-x64-msvc')
+        } catch (e) {
+          loadErrors.push(e)
+        }
       }
     } else if (process.arch === 'ia32') {
       try {
@@ -137,7 +157,6 @@ function requireNative() {
     } catch (e) {
       loadErrors.push(e)
     }
-
     if (process.arch === 'x64') {
       try {
         return require('./skia.darwin-x64.node')
@@ -262,6 +281,30 @@ function requireNative() {
           loadErrors.push(e)
         }
       }
+    } else if (process.arch === 'loong64') {
+      if (isMusl()) {
+        try {
+          return require('./skia.linux-loong64-musl.node')
+        } catch (e) {
+          loadErrors.push(e)
+        }
+        try {
+          return require('@napi-rs/canvas-linux-loong64-musl')
+        } catch (e) {
+          loadErrors.push(e)
+        }
+      } else {
+        try {
+          return require('./skia.linux-loong64-gnu.node')
+        } catch (e) {
+          loadErrors.push(e)
+        }
+        try {
+          return require('@napi-rs/canvas-linux-loong64-gnu')
+        } catch (e) {
+          loadErrors.push(e)
+        }
+      }
     } else if (process.arch === 'riscv64') {
       if (isMusl()) {
         try {
@@ -311,6 +354,44 @@ function requireNative() {
     } else {
       loadErrors.push(new Error(`Unsupported architecture on Linux: ${process.arch}`))
     }
+  } else if (process.platform === 'openharmony') {
+    if (process.arch === 'arm64') {
+      try {
+        return require('./skia.openharmony-arm64.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@napi-rs/canvas-openharmony-arm64')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+    } else if (process.arch === 'x64') {
+      try {
+        return require('./skia.openharmony-x64.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@napi-rs/canvas-openharmony-x64')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+    } else if (process.arch === 'arm') {
+      try {
+        return require('./skia.openharmony-arm.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        const binding = require('@napi-rs/canvas-openharmony-arm')
+        return binding
+      } catch (e) {
+        loadErrors.push(e)
+      }
+    } else {
+      loadErrors.push(new Error(`Unsupported architecture on OpenHarmony: ${process.arch}`))
+    }
   } else {
     loadErrors.push(new Error(`Unsupported OS: ${process.platform}, architecture: ${process.arch}`))
   }
@@ -319,18 +400,23 @@ function requireNative() {
 nativeBinding = requireNative()
 
 if (!nativeBinding || process.env.NAPI_RS_FORCE_WASI) {
+  let wasiBinding = null
+  let wasiBindingError = null
   try {
-    nativeBinding = require('./skia.wasi.cjs')
+    wasiBinding = require('./skia.wasi.cjs')
+    nativeBinding = wasiBinding
   } catch (err) {
     if (process.env.NAPI_RS_FORCE_WASI) {
-      loadErrors.push(err)
+      wasiBindingError = err
     }
   }
   if (!nativeBinding) {
     try {
-      nativeBinding = require('@napi-rs/canvas-wasm32-wasi')
+      wasiBinding = require('@napi-rs/canvas-wasm32-wasi')
+      nativeBinding = wasiBinding
     } catch (err) {
       if (process.env.NAPI_RS_FORCE_WASI) {
+        wasiBindingError.cause = err
         loadErrors.push(err)
       }
     }
@@ -339,15 +425,22 @@ if (!nativeBinding || process.env.NAPI_RS_FORCE_WASI) {
 
 if (!nativeBinding) {
   if (loadErrors.length > 0) {
-    // TODO Link to documentation with potential fixes
-    //  - The package owner could build/publish bindings for this arch
-    //  - The user may need to bundle the correct files
-    //  - The user may need to re-install node_modules to get new packages
-    throw new Error('Failed to load native binding', { cause: loadErrors })
+    throw new Error(
+      `Cannot find native binding. ` +
+        `npm has a bug related to optional dependencies (https://github.com/npm/cli/issues/4828). ` +
+        'Please try `npm i` again after removing both package-lock.json and node_modules directory.',
+      {
+        cause: loadErrors.reduce((err, cur) => {
+          cur.cause = err
+          return cur
+        }),
+      },
+    )
   }
   throw new Error(`Failed to load native binding`)
 }
 
+module.exports = nativeBinding
 module.exports.GlobalFonts = nativeBinding.GlobalFonts
 module.exports.CanvasElement = nativeBinding.CanvasElement
 module.exports.CanvasGradient = nativeBinding.CanvasGradient
@@ -357,6 +450,7 @@ module.exports.FontKey = nativeBinding.FontKey
 module.exports.Image = nativeBinding.Image
 module.exports.ImageData = nativeBinding.ImageData
 module.exports.Path = nativeBinding.Path
+module.exports.PdfDocument = nativeBinding.PdfDocument
 module.exports.SVGCanvas = nativeBinding.SVGCanvas
 module.exports.ChromaSubsampling = nativeBinding.ChromaSubsampling
 module.exports.clearAllCache = nativeBinding.clearAllCache

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@napi-rs/canvas",
-  "version": "0.1.81",
+  "version": "0.1.82",
   "description": "Canvas for Node.js with skia backend",
   "main": "index.js",
   "repository": {
@@ -77,10 +77,10 @@
     "@jimp/png": "^0.22.12",
     "@napi-rs/cli": "^3.1.1",
     "@octokit/rest": "^22.0.0",
-    "@oxc-node/core": "^0.0.32",
+    "@oxc-node/core": "^0.0.34",
     "@taplo/cli": "^0.7.0",
     "@types/lodash": "^4.17.17",
-    "@types/node": "^22.15.30",
+    "@types/node": "^24.0.0",
     "@types/semver": "^7",
     "ava": "^6.3.0",
     "canvas": "^3.1.0",
@@ -89,7 +89,7 @@
     "conventional-changelog-cli": "^5.0.0",
     "core-js": "^3.42.0",
     "echarts": "^6.0.0",
-    "electron": "^38.0.0",
+    "electron": "^39.0.0",
     "husky": "^9.1.7",
     "lint-staged": "^16.1.0",
     "lodash": "^4.17.21",
@@ -140,17 +140,17 @@
     "singleQuote": true,
     "arrowParens": "always"
   },
-  "packageManager": "yarn@4.10.3",
+  "packageManager": "yarn@4.11.0",
   "optionalDependencies": {
-    "@napi-rs/canvas-linux-x64-gnu": "0.1.81",
-    "@napi-rs/canvas-darwin-x64": "0.1.81",
-    "@napi-rs/canvas-win32-x64-msvc": "0.1.81",
-    "@napi-rs/canvas-linux-arm-gnueabihf": "0.1.81",
-    "@napi-rs/canvas-linux-x64-musl": "0.1.81",
-    "@napi-rs/canvas-linux-arm64-gnu": "0.1.81",
-    "@napi-rs/canvas-linux-arm64-musl": "0.1.81",
-    "@napi-rs/canvas-darwin-arm64": "0.1.81",
-    "@napi-rs/canvas-android-arm64": "0.1.81",
-    "@napi-rs/canvas-linux-riscv64-gnu": "0.1.81"
+    "@napi-rs/canvas-linux-x64-gnu": "0.1.82",
+    "@napi-rs/canvas-darwin-x64": "0.1.82",
+    "@napi-rs/canvas-win32-x64-msvc": "0.1.82",
+    "@napi-rs/canvas-linux-arm-gnueabihf": "0.1.82",
+    "@napi-rs/canvas-linux-x64-musl": "0.1.82",
+    "@napi-rs/canvas-linux-arm64-gnu": "0.1.82",
+    "@napi-rs/canvas-linux-arm64-musl": "0.1.82",
+    "@napi-rs/canvas-darwin-arm64": "0.1.82",
+    "@napi-rs/canvas-android-arm64": "0.1.82",
+    "@napi-rs/canvas-linux-riscv64-gnu": "0.1.82"
   }
 }