@travetto/image 7.1.3 → 8.0.0-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/image",
-  "version": "7.1.3",
+  "version": "8.0.0-alpha.0",
   "type": "module",
   "description": "Image support, resizing, and optimization",
   "keywords": [
@@ -24,7 +24,7 @@
     "directory": "module/image"
   },
   "dependencies": {
-    "@travetto/runtime": "^7.1.3",
+    "@travetto/runtime": "^8.0.0-alpha.0",
     "sharp": "^0.34.5"
   },
   "travetto": {

package/src/util.ts

@@ -1,13 +1,16 @@
-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 type { Metadata, Sharp } from 'sharp';
 
-import { castTo } from '@travetto/runtime';
+import { BinaryUtil, castTo, type BinaryStream, type BinaryType } from '@travetto/runtime';
 
-type ImageFormat = 'jpeg' | 'png' | 'avif' | 'webp' | 'gif' | 'jxl';
-type Input = Buffer | string | ReadableStream | Readable;
+const VALID_EXTENSIONS = ['jpeg', 'jpg', 'png', 'avif', 'webp', 'gif', 'jxl'] as const;
+
+type ImageFormat = typeof VALID_EXTENSIONS[number];
+type ImageMetadata = {
+  width: number;
+  height: number;
+  aspect: number;
+  format: ImageFormat;
+};
 
 /**
  * Image convert options
@@ -36,10 +39,11 @@ export interface ConvertOptions {
  */
 export class ImageUtil {
 
-  /**
-   * Convert image
-   */
-  static async convert<T extends Input>(image: T, { format, optimize, ...options }: ConvertOptions): Promise<T extends string ? Readable : T> {
+  static isKnownExtension(ext: string): ext is ImageFormat {
+    return VALID_EXTENSIONS.includes(castTo(ext));
+  }
+
+  static async #getBuilder({ format, optimize, ...options }: ConvertOptions): Promise<Sharp> {
     const { default: sharp } = await import('sharp');
 
     let builder = sharp();
@@ -53,43 +57,33 @@ export class ImageUtil {
       });
     }
 
-    builder = builder
+    return 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 } : {} })
+      .jpeg({ force: format === 'jpeg' || format === 'jpg', ...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) :
-      (typeof image === 'string' ? createReadStream(image) : image);
+  }
 
-    pipeline(stream, builder);
-    return castTo(
-      typeof image === 'string' ?
-        builder : Buffer.isBuffer(image) ?
-          builder.toBuffer() :
-          (image instanceof ReadableStream) ?
-            ReadableStream.from(builder) : builder
-    );
+  /**
+   * Convert image as readable stream
+   */
+  static async convert(image: BinaryType, options: ConvertOptions): Promise<BinaryStream> {
+    const builder = await this.#getBuilder(options);
+    BinaryUtil.pipeline(image, builder);
+    return builder;
   }
 
   /**
    * Get Image metadata
    */
-  static async getMetadata(image: Input): Promise<{
-    width: number;
-    height: number;
-    aspect: number;
-    format: ImageFormat;
-  }> {
+  static async getMetadata(image: BinaryType): Promise<ImageMetadata> {
     const { default: sharp } = await import('sharp');
-    const out = await ((Buffer.isBuffer(image) || typeof image === 'string') ?
-      sharp(image).metadata() :
-      new Promise<Metadata>((resolve, reject) =>
-        pipeline(image, sharp().metadata((error, metadata) => error ? reject(error) : resolve(metadata)))
-      ));
+    const out = await new Promise<Metadata>((resolve, reject) =>
+      BinaryUtil.pipeline(image, sharp().metadata((error, metadata) => error ? reject(error) : resolve(metadata)))
+    );
     return {
       width: out.width!,
       height: out.height!,