@travetto/image 2.1.1 → 2.2.0

package/README.md

@@ -10,18 +10,18 @@ npm install @travetto/image
 
 This module provides functionality for image resizing, and png optimization. This is primarily meant to be used in conjunction with other modules, like the [Asset](https://github.com/travetto/travetto/tree/main/module/asset#readme "Modular library for storing and retrieving binary assets") module or the [Email Templating](https://github.com/travetto/travetto/tree/main/module/email-template#readme "Email templating module") module. It can also be invoked directly as needed (as it can be very handy for batch processing images on the command line).
 
-The utility's primary structure revolves around the [CommandService](https://github.com/travetto/travetto/tree/main/module/command/src/command.ts#L11) from the [Command](https://github.com/travetto/travetto/tree/main/module/command#readme "Support for executing complex commands at runtime.") module.  The [CommandService](https://github.com/travetto/travetto/tree/main/module/command/src/command.ts#L11)  allows for declaration of a local executable, and a fall-back docker container (mainly meant for development).  The [ImageUtil](https://github.com/travetto/travetto/tree/main/module/image/src/util.ts#L30) utilizes [ImageMagick](https://imagemagick.org/index.php), [pngquant](https://pngquant.org/), and  [Jpegoptim](https://github.com/tjko/jpegoptim) as the backing for image resizing and png compression, respectively.
+The utility's primary structure revolves around the [CommandService](https://github.com/travetto/travetto/tree/main/module/command/src/command.ts#L11) from the [Command](https://github.com/travetto/travetto/tree/main/module/command#readme "Support for executing complex commands at runtime.") module.  The [CommandService](https://github.com/travetto/travetto/tree/main/module/command/src/command.ts#L11)  allows for declaration of a local executable, and a fall-back docker container (mainly meant for development).  The [ImageUtil](https://github.com/travetto/travetto/tree/main/module/image/src/util.ts#L31) utilizes [ImageMagick](https://imagemagick.org/index.php), [pngquant](https://pngquant.org/), and  [Jpegoptim](https://github.com/tjko/jpegoptim) as the backing for image resizing and png compression, respectively.
 
 **Code: Simple Image Resize**
 ```typescript
-import * as fs from 'fs';
+import { createReadStream } from 'fs';
 
 import { StreamUtil } from '@travetto/boot';
 import { ImageUtil } from '@travetto/image';
 
 export class ResizeService {
   async resizeImage(imgPath: string, width: number, height: number): Promise<string> {
-    const stream = await ImageUtil.resize(fs.createReadStream(imgPath), { w: width, h: height });
+    const stream = await ImageUtil.resize(createReadStream(imgPath), { w: width, h: height });
     const out = imgPath.replace(/[.][^.]+$/, (ext) => `.resized${ext}`);
     await StreamUtil.writeToFile(stream, out);
     return out;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@travetto/image",
   "displayName": "Image",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "description": "Image support, resizing, and optimization",
   "keywords": [
     "images",
@@ -24,7 +24,7 @@
     "directory": "module/image"
   },
   "dependencies": {
-    "@travetto/command": "^2.1.1"
+    "@travetto/command": "^2.2.0"
   },
   "publishConfig": {
     "access": "public"

package/src/util.ts

@@ -1,4 +1,5 @@
 import * as fs from 'fs/promises';
+import { Readable } from 'stream';
 
 import { CommandService } from '@travetto/command';
 import { ExecUtil, StreamUtil, AppCache, FsUtil } from '@travetto/boot';
@@ -21,7 +22,7 @@ export interface ImageOptions {
   optimize?: boolean;
 }
 
-type ImageType = NodeJS.ReadableStream | Buffer;
+type ImageType = Readable | Buffer;
 
 /**
  * Simple support for image manipulation.  Built upon @travetto/command, it can
@@ -50,30 +51,31 @@ export class ImageUtil {
    */
   static JPEG_COMPRESSOR = new CommandService({
     containerImage: 'shomatan/jpegoptim:1.4.4',
-    localCheck: ['jpegotim', ['-h']]
+    localCheck: ['jpegoptim', ['-h']]
   });
 
   /**
-   * Resize image using image magick
+   * Resize image using imagemagick
    */
-  static resize(image: NodeJS.ReadableStream, options: ImageOptions): Promise<NodeJS.ReadableStream>;
+  static resize(image: Readable, options: ImageOptions): Promise<Readable>;
   static resize(image: Buffer, options: ImageOptions): Promise<Buffer>;
-  static async resize(image: ImageType, options: ImageOptions): Promise<NodeJS.ReadableStream | Buffer> {
+  static async resize(image: ImageType, options: ImageOptions): Promise<Readable | Buffer> {
     const state = await this.CONVERTER.exec(
       'gm', 'convert', '-resize', `${options.w ?? ''}x${options.h ?? ''}`,
       '-auto-orient',
       ...(options.optimize ? ['-strip', '-quality', '86'] : []),
       '-', '-');
 
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     return await ExecUtil.pipe(state, image as Buffer);
   }
 
   /**
-   * Optimize png usng pngquant
+   * Optimize png using pngquant
    */
-  static optimize(format: 'png' | 'jpeg', image: NodeJS.ReadableStream): Promise<NodeJS.ReadableStream>;
+  static optimize(format: 'png' | 'jpeg', image: Readable): Promise<Readable>;
   static optimize(format: 'png' | 'jpeg', image: Buffer): Promise<Buffer>;
-  static async optimize(format: 'png' | 'jpeg', image: ImageType): Promise<NodeJS.ReadableStream | Buffer> {
+  static async optimize(format: 'png' | 'jpeg', image: ImageType): Promise<Readable | Buffer> {
     let stream;
     switch (format) {
       case 'png': {
@@ -86,20 +88,21 @@ export class ImageUtil {
         break;
       }
     }
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
     return await ExecUtil.pipe(stream, image as Buffer);
   }
 
   /**
    * Fetch image, compress and return as buffer
    */
-  static async optimizeResource(rel: string) {
+  static async optimizeResource(rel: string): Promise<Buffer> {
     const { ResourceManager } = await import('@travetto/base');
 
     const pth = await ResourceManager.find(rel);
     const out = AppCache.toEntryName(pth);
 
     if (!(await FsUtil.exists(out))) {
-      let stream: Buffer | NodeJS.ReadableStream = await ResourceManager.readStream(rel);
+      let stream: Buffer | Readable = await ResourceManager.readStream(rel);
       if (/[.]png$/.test(pth)) {
         stream = await this.optimize('png', stream);
       } else if (/[.]jpe?g$/i.test(pth)) {