@napi-rs/canvas 0.1.22 → 0.1.25

package/README.md

@@ -1,7 +1,7 @@
 # `skr canvas`
 
 ![CI](https://github.com/Brooooooklyn/canvas/workflows/CI/badge.svg)
-![Skia Version](https://img.shields.io/badge/Skia-chrome%2Fm103-hotpink)
+![Skia Version](https://img.shields.io/badge/Skia-chrome%2Fm104-hotpink)
 [![install size](https://packagephobia.com/badge?p=@napi-rs/canvas)](https://packagephobia.com/result?p=@napi-rs/canvas)
 [![Downloads](https://img.shields.io/npm/dm/@napi-rs/canvas.svg?sanitize=true)](https://npmcharts.com/compare/@napi-rs/canvas?minimal=true)
 

package/index.d.ts

@@ -388,3 +388,14 @@ export const enum SvgExportFlag {
 }
 
 export function convertSVGTextToPath(svg: Buffer | string): Buffer
+
+export interface LoadImageOptions {
+  alt?: string,
+  maxRedirects?: number,
+  requestOptions?: import('http').RequestOptions,
+}
+
+export function loadImage(
+  source: string | URL | Buffer | ArrayBufferLike | Uint8Array | Image | import('stream').Readable,
+  options?: LoadImageOptions,
+): Promise<Image>

package/index.js

@@ -16,6 +16,8 @@ const {
 
 const { DOMPoint, DOMMatrix, DOMRect } = require('./geometry')
 
+const loadImage = require('./load-image')
+
 const StrokeJoin = {
   Miter: 0,
   Round: 1,
@@ -344,4 +346,5 @@ module.exports = {
   DOMPoint,
   DOMMatrix,
   DOMRect,
+  loadImage,
 }

package/load-image.js

@@ -0,0 +1,94 @@
+const fs = require('fs')
+const { Image } = require('./js-binding')
+const { Readable } = require('stream')
+
+let http, https
+
+const MAX_REDIRECTS = 20,
+  REDIRECT_STATUSES = new Set([301, 302]),
+  DATA_URI = /^\s*data:/
+
+/**
+ * Loads the given source into canvas Image
+ * @param {string|URL|Image|Buffer} source The image source to be loaded
+ * @param {object} options Options passed to the loader
+ */
+module.exports = async function loadImage(source, options = {}) {
+  // load readable stream as image
+  if (source instanceof Readable) return createImage(await consumeStream(source), options.alt)
+  // use the same buffer without copying if the source is a buffer
+  if (Buffer.isBuffer(source)) return createImage(source, options.alt)
+  // construct a buffer if the source is buffer-like
+  if (isBufferLike(source)) return createImage(Buffer.from(source), options.alt)
+  // if the source is Image instance, copy the image src to new image
+  if (source instanceof Image) return createImage(source.src, options.alt)
+  // if source is string and in data uri format, construct image using data uri
+  if (typeof source === 'string' && DATA_URI.test(source)) {
+    const commaIdx = source.indexOf(',')
+    const encoding = source.lastIndexOf('base64', commaIdx) < 0 ? 'utf-8' : 'base64'
+    const data = Buffer.from(source.slice(commaIdx + 1), encoding)
+    return createImage(data, options.alt)
+  }
+  // if source is a string or URL instance
+  if (typeof source === 'string' || source instanceof URL) {
+    // if the source exists as a file, construct image from that file
+    if (fs.existsSync(source)) {
+      return createImage(await fs.promises.readFile(source), options.alt)
+    } else {
+      // the source is a remote url here
+      source = !(source instanceof URL) ? new URL(source) : source
+      // attempt to download the remote source and construct image
+      const data = await new Promise((resolve, reject) =>
+        makeRequest(source, resolve, reject, options.maxRedirects ?? MAX_REDIRECTS, options.requestOptions),
+      )
+      return createImage(data, options.alt)
+    }
+  }
+
+  // throw error as dont support that source
+  throw new TypeError('unsupported image source')
+}
+
+function makeRequest(url, resolve, reject, redirectCount, requestOptions) {
+  const isHttps = url.protocol === 'https:'
+  // lazy load the lib
+  const lib = isHttps ? (!https ? (https = require('https')) : https) : !http ? (http = require('http')) : http
+
+  lib.get(url, requestOptions ?? {}, (res) => {
+    const shouldRedirect = REDIRECT_STATUSES.has(res.statusCode) && typeof res.headers.location === 'string'
+    if (shouldRedirect && redirectCount > 0)
+      return makeRequest(res.headers.location, resolve, reject, redirectCount - 1, requestOptions)
+    if (typeof res.statusCode === 'number' && (res.statusCode < 200 || res.statusCode >= 300)) {
+      return reject(new Error(`remote source rejected with status code ${res.statusCode}`))
+    }
+
+    consumeStream(res).then(resolve, reject)
+  })
+}
+
+// use stream/consumers in the future?
+function consumeStream(res) {
+  return new Promise((resolve, reject) => {
+    const chunks = []
+
+    res.on('data', (chunk) => chunks.push(chunk))
+    res.on('end', () => resolve(Buffer.concat(chunks)))
+    res.on('error', reject)
+  })
+}
+
+function createImage(src, alt) {
+  const image = new Image()
+  image.src = src
+  if (typeof alt === 'string') image.alt = alt
+  return image
+}
+
+function isBufferLike(src) {
+  return (
+    Array.isArray(src) ||
+    src instanceof ArrayBuffer ||
+    src instanceof SharedArrayBuffer ||
+    src instanceof Object.getPrototypeOf(Uint8Array)
+  )
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@napi-rs/canvas",
-  "version": "0.1.22",
+  "version": "0.1.25",
   "description": "Canvas for Node.js with skia backend",
   "main": "index.js",
   "repository": "https://github.com/Brooooooklyn/canvas.git",
@@ -22,7 +22,8 @@
     "index.d.ts",
     "index.js",
     "geometry.js",
-    "js-binding.js"
+    "js-binding.js",
+    "load-image.js"
   ],
   "napi": {
     "name": "skia",
@@ -94,7 +95,7 @@
     "typescript": "^4.7.2"
   },
   "lint-staged": {
-    "*.@(js|ts|tsx|yml|yaml|md|json)": [
+    "*.@(js|ts|tsx|yml|yaml|md|json|html)": [
       "prettier --write"
     ],
     "*.@(js|ts|tsx)": [
@@ -125,14 +126,14 @@
   },
   "packageManager": "yarn@3.2.1",
   "optionalDependencies": {
-    "@napi-rs/canvas-win32-x64-msvc": "0.1.22",
-    "@napi-rs/canvas-darwin-x64": "0.1.22",
-    "@napi-rs/canvas-linux-x64-gnu": "0.1.22",
-    "@napi-rs/canvas-linux-arm-gnueabihf": "0.1.22",
-    "@napi-rs/canvas-linux-x64-musl": "0.1.22",
-    "@napi-rs/canvas-linux-arm64-gnu": "0.1.22",
-    "@napi-rs/canvas-linux-arm64-musl": "0.1.22",
-    "@napi-rs/canvas-darwin-arm64": "0.1.22",
-    "@napi-rs/canvas-android-arm64": "0.1.22"
+    "@napi-rs/canvas-win32-x64-msvc": "0.1.25",
+    "@napi-rs/canvas-darwin-x64": "0.1.25",
+    "@napi-rs/canvas-linux-x64-gnu": "0.1.25",
+    "@napi-rs/canvas-linux-arm-gnueabihf": "0.1.25",
+    "@napi-rs/canvas-linux-x64-musl": "0.1.25",
+    "@napi-rs/canvas-linux-arm64-gnu": "0.1.25",
+    "@napi-rs/canvas-linux-arm64-musl": "0.1.25",
+    "@napi-rs/canvas-darwin-arm64": "0.1.25",
+    "@napi-rs/canvas-android-arm64": "0.1.25"
   }
 }