image-js 1.4.0 → 1.5.0

package/lib/utils/cross_platform.d.ts

@@ -11,6 +11,7 @@ export declare function getNodeApiOrThrow(methodName: string): {
 };
 /**
  * Returns a 2D canvas context for rendering on the browser or Node.js.
+ * On Node.js this requires the optional `skia-canvas` package to be installed.
  * @param width - Width of the canvas.
  * @param height - Height of the canvas.
  * @returns The initialised canvas context.

package/lib/utils/cross_platform.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cross_platform.d.ts","sourceRoot":"","sources":["../../src/utils/cross_platform.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,wBAAwB,IAAI,4BAA4B,EACzD,MAAM,aAAa,CAAC;AAErB;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM;;;;EASnD;AAKD;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACb,iCAAiC,GAAG,4BAA4B,CAYlE"}
+{"version":3,"file":"cross_platform.d.ts","sourceRoot":"","sources":["../../src/utils/cross_platform.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,wBAAwB,IAAI,4BAA4B,EACzD,MAAM,aAAa,CAAC;AAErB;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM;;;;EASnD;AAKD;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACb,iCAAiC,GAAG,4BAA4B,CAqBlE"}

package/lib/utils/cross_platform.js

@@ -17,13 +17,21 @@ let CanvasCtorBrowser;
 let CanvasCtorNode;
 /**
  * Returns a 2D canvas context for rendering on the browser or Node.js.
+ * On Node.js this requires the optional `skia-canvas` package to be installed.
  * @param width - Width of the canvas.
  * @param height - Height of the canvas.
  * @returns The initialised canvas context.
  */
 export function getCanvasContext(width, height) {
     if (isNode()) {
-        CanvasCtorNode ??= getRequireFn()('skia-canvas').Canvas;
+        if (!CanvasCtorNode) {
+            try {
+                CanvasCtorNode = getRequireFn()('skia-canvas').Canvas;
+            }
+            catch (error) {
+                throw new Error('drawText on Node.js requires the optional "skia-canvas" package. Install it with: npm install skia-canvas', { cause: error });
+            }
+        }
         return new CanvasCtorNode(width, height).getContext('2d');
     }
     else {

package/lib/utils/cross_platform.js.map

@@ -1 +1 @@
-{"version":3,"file":"cross_platform.js","sourceRoot":"","sources":["../../src/utils/cross_platform.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,UAAkB;IAClD,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,GAAG,UAAU,kCAAkC,CAAC,CAAC;IACnE,CAAC;IACD,OAAO;QACL,EAAE,EAAE,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC;QACvC,IAAI,EAAE,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC;QAC3C,GAAG,EAAE,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC;KAC1C,CAAC;AACJ,CAAC;AAED,IAAI,iBAAyC,CAAC;AAC9C,IAAI,cAAiC,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAC9B,KAAa,EACb,MAAc;IAEd,IAAI,MAAM,EAAE,EAAE,CAAC;QACb,cAAc,KAAK,YAAY,EAAE,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC;QACxD,OAAO,IAAI,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC5D,CAAC;SAAM,CAAC;QACN,iBAAiB,KAAK,UAAU,CAAC,eAAe,CAAC;QACjD,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACtE,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;AACH,CAAC;AAED,SAAS,MAAM;IACb,OAAO,CACL,OAAO,OAAO,KAAK,WAAW;QAC9B,OAAO,OAAO,CAAC,gBAAgB,KAAK,UAAU,CAC/C,CAAC;AACJ,CAAC;AAED,IAAI,SAAyB,CAAC;AAC9B,SAAS,YAAY;IACnB,SAAS,KAAK,OAAO;SAClB,gBAAgB,CAAC,aAAa,CAAC;SAC/B,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClC,OAAO,SAAS,CAAC;AACnB,CAAC"}
+{"version":3,"file":"cross_platform.js","sourceRoot":"","sources":["../../src/utils/cross_platform.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,UAAkB;IAClD,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,GAAG,UAAU,kCAAkC,CAAC,CAAC;IACnE,CAAC;IACD,OAAO;QACL,EAAE,EAAE,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC;QACvC,IAAI,EAAE,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC;QAC3C,GAAG,EAAE,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC;KAC1C,CAAC;AACJ,CAAC;AAED,IAAI,iBAAyC,CAAC;AAC9C,IAAI,cAAiC,CAAC;AAEtC;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAC9B,KAAa,EACb,MAAc;IAEd,IAAI,MAAM,EAAE,EAAE,CAAC;QACb,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,IAAI,CAAC;gBACH,cAAc,GAAG,YAAY,EAAE,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC;YACxD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,IAAI,KAAK,CACb,2GAA2G,EAC3G,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;YACJ,CAAC;QACH,CAAC;QACD,OAAO,IAAI,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC5D,CAAC;SAAM,CAAC;QACN,iBAAiB,KAAK,UAAU,CAAC,eAAe,CAAC;QACjD,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACtE,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;AACH,CAAC;AAED,SAAS,MAAM;IACb,OAAO,CACL,OAAO,OAAO,KAAK,WAAW;QAC9B,OAAO,OAAO,CAAC,gBAAgB,KAAK,UAAU,CAC/C,CAAC;AACJ,CAAC;AAED,IAAI,SAAyB,CAAC;AAC9B,SAAS,YAAY;IACnB,SAAS,KAAK,OAAO;SAClB,gBAAgB,CAAC,aAAa,CAAC;SAC/B,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAClC,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "image-js",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "license": "MIT",
   "description": "Image processing and manipulation in JavaScript",
   "author": "Michaël Zasso",
@@ -55,12 +55,14 @@
     "ml-regression-polynomial-2d": "^1.0.0",
     "ml-spectra-processing": "^14.18.2",
     "robust-point-in-polygon": "^1.0.3",
-    "skia-canvas": "^3.0.8",
     "ssim.js": "^3.5.0",
     "tiff": "^7.1.3",
     "ts-pattern": "^5.9.0",
     "uint8-base64": "^1.0.0"
   },
+  "optionalDependencies": {
+    "skia-canvas": "^3.0.8"
+  },
   "lavamoat": {
     "allowScripts": {
       "@lavamoat/preinstall-always-fail": false,

package/src/utils/cross_platform.ts

@@ -24,6 +24,7 @@ let CanvasCtorNode: typeof SkiaCanvas;
 
 /**
  * Returns a 2D canvas context for rendering on the browser or Node.js.
+ * On Node.js this requires the optional `skia-canvas` package to be installed.
  * @param width - Width of the canvas.
  * @param height - Height of the canvas.
  * @returns The initialised canvas context.
@@ -33,7 +34,16 @@ export function getCanvasContext(
   height: number,
 ): OffscreenCanvasRenderingContext2D | SkiaCanvasRenderingContext2D {
   if (isNode()) {
-    CanvasCtorNode ??= getRequireFn()('skia-canvas').Canvas;
+    if (!CanvasCtorNode) {
+      try {
+        CanvasCtorNode = getRequireFn()('skia-canvas').Canvas;
+      } catch (error) {
+        throw new Error(
+          'drawText on Node.js requires the optional "skia-canvas" package. Install it with: npm install skia-canvas',
+          { cause: error },
+        );
+      }
+    }
     return new CanvasCtorNode(width, height).getContext('2d');
   } else {
     CanvasCtorBrowser ??= globalThis.OffscreenCanvas;