@travetto/image 5.0.14 → 5.0.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/image",
-  "version": "5.0.14",
+  "version": "5.0.16",
   "description": "Image support, resizing, and optimization",
   "keywords": [
     "images",
@@ -23,11 +23,16 @@
     "directory": "module/image"
   },
   "dependencies": {
-    "@travetto/runtime": "^5.0.11",
+    "@travetto/runtime": "^5.0.12",
     "sharp": "^0.33.5"
   },
   "travetto": {
-    "displayName": "Image"
+    "displayName": "Image",
+    "build": {
+      "binaryDependencies": [
+        "sharp"
+      ]
+    }
   },
   "publishConfig": {
     "access": "public"

package/src/util.ts

@@ -1,10 +1,13 @@
+import { createReadStream } from 'node:fs';
 import { Readable } from 'node:stream';
 import { ReadableStream } from 'node:stream/web';
 import { pipeline } from 'node:stream/promises';
+import type { Metadata } from 'sharp';
 
-import { AppError, castTo } from '@travetto/runtime';
+import { castTo } from '@travetto/runtime';
 
-type ImageFormat = 'jpeg' | 'png' | 'avif' | 'webp';
+type ImageFormat = 'jpeg' | 'png' | 'avif' | 'webp' | 'gif' | 'jxl';
+type Input = Buffer | string | ReadableStream | Readable;
 
 /**
  * Image convert options
@@ -28,29 +31,20 @@ export interface ConvertOptions {
   format?: ImageFormat;
 }
 
-type ImageType = Readable | Buffer | ReadableStream;
-
 /**
  * Simple support for image manipulation.
  */
 export class ImageUtil {
 
   /**
-   * Resize image
+   * Convert image
    */
-  static async convert<T extends ImageType>(image: T, options: ConvertOptions): Promise<T> {
-    if (options.optimize && !options.format) {
-      if (Buffer.isBuffer(image)) {
-        options.format = await this.getFileType(image);
-      }
-      throw new AppError('Format is required for optimizing');
-    }
-
+  static async convert<T extends Input>(image: T, { format, optimize, ...opts }: ConvertOptions): Promise<T extends string ? Readable : T> {
     const { default: sharp } = await import('sharp');
 
     let builder = sharp();
-    if (options.w || options.h) {
-      const dims = [options.w, options.h].map(x => x ? Math.trunc(x) : undefined);
+    if (opts.w || opts.h) {
+      const dims = [opts.w, opts.h].map(x => x ? Math.trunc(x) : undefined);
       const fluid = dims.some(x => !x);
       builder = builder.resize({
         width: dims[0],
@@ -59,44 +53,48 @@ export class ImageUtil {
       });
     }
 
-    switch (options.format) {
-      case 'jpeg':
-        builder = builder.jpeg(options.optimize ? { quality: 80, progressive: true } : {});
-        break;
-      case 'png':
-        builder = builder.png(options.optimize ? { compressionLevel: 9, quality: 80, adaptiveFiltering: true } : {});
-        break;
-      case 'avif':
-        builder = builder.avif(options.optimize ? { quality: 70 } : {});
-        break;
-      case 'webp':
-        builder = builder.webp(options.optimize ? { quality: 80 } : {});
-        break;
-    }
+    builder = builder
+      .avif({ force: format === 'avif', ...optimize ? { quality: 70 } : {} })
+      .webp({ force: format === 'webp', ...optimize ? { quality: 80 } : {} })
+      .png({ force: format === 'png', ...optimize ? { compressionLevel: 9, quality: 80, adaptiveFiltering: true } : {} })
+      .jpeg({ force: format === 'jpeg', ...optimize ? { quality: 80, progressive: true } : {} })
+      .jxl({ force: format === 'jxl', ...optimize ? { lossless: false, quality: 80 } : {} })
+      .gif({ force: format === 'gif', ...optimize ? { effort: 10 } : {} });
 
-    const stream = Buffer.isBuffer(image) ? Readable.from(image) : image;
-    pipeline(stream, builder);
-    return castTo('pipeThrough' in image ?
-      ReadableStream.from(builder) :
-      Buffer.isBuffer(image) ? builder.toBuffer() : builder);
-  }
+    const stream = Buffer.isBuffer(image) ?
+      Readable.from(image) :
+      (typeof image === 'string' ? createReadStream(image) : image);
 
-  /**
-   * Get Image Dimensions
-   */
-  static async getDimensions(image: Buffer | string): Promise<{ width: number, height: number, aspect: number }> {
-    const { default: sharp } = await import('sharp');
-    return sharp(image).metadata().then(v => ({ width: v.width!, height: v.height!, aspect: v.width! / v.height! }));
+    pipeline(stream, builder);
+    return castTo(
+      typeof image === 'string' ?
+        builder : Buffer.isBuffer(image) ?
+          builder.toBuffer() :
+          (image instanceof ReadableStream) ?
+            ReadableStream.from(builder) : builder
+    );
   }
 
   /**
-   * Get image type
+   * Get Image metadata
    */
-  static async getFileType(image: Buffer | string): Promise<ImageFormat> {
+  static async getMetadata(image: Input): Promise<{
+    width: number;
+    height: number;
+    aspect: number;
+    format: ImageFormat;
+  }> {
     const { default: sharp } = await import('sharp');
-    return sharp(image).metadata().then(v =>
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      v.format?.replace('heif', 'avif')! as ImageFormat
-    );
+    const out = await ((Buffer.isBuffer(image) || typeof image === 'string') ?
+      sharp(image).metadata() :
+      new Promise<Metadata>((resolve, reject) =>
+        pipeline(image, sharp().metadata((err, metadata) => err ? reject(err) : resolve(metadata)))
+      ));
+    return {
+      width: out.width!,
+      height: out.height!,
+      format: castTo(out.format?.replace('heif', 'avif')!),
+      aspect: out.width! / out.height!
+    };
   }
 }