@travetto/image 3.4.3 → 4.0.0-rc.1

package/README.md

@@ -15,11 +15,11 @@ yarn add @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 Compilation Support](https://github.com/travetto/travetto/tree/main/module/email-compiler#readme "Email compiling 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 [CommandOperation](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 [CommandOperation](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 [ImageConverter](https://github.com/travetto/travetto/tree/main/module/image/src/convert.ts#L35) 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 [CommandOperation](https://github.com/travetto/travetto/tree/main/module/command/src/command.ts#L12) from the [Command](https://github.com/travetto/travetto/tree/main/module/command#readme "Support for executing complex commands at runtime.") module.  The [CommandOperation](https://github.com/travetto/travetto/tree/main/module/command/src/command.ts#L12)  allows for declaration of a local executable, and a fall-back docker container (mainly meant for development).  The [ImageConverter](https://github.com/travetto/travetto/tree/main/module/image/src/convert.ts#L37) 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 { createReadStream } from 'fs';
+import { createReadStream } from 'node:fs';
 
 import { StreamUtil } from '@travetto/base';
 import { ImageConverter } from '@travetto/image';

package/__index__.ts

@@ -1 +1,2 @@
+/// <reference path="./src/trv.d.ts" />
 export * from './src/convert';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/image",
-  "version": "3.4.3",
+  "version": "4.0.0-rc.1",
   "description": "Image support, resizing, and optimization",
   "keywords": [
     "images",
@@ -23,8 +23,8 @@
     "directory": "module/image"
   },
   "dependencies": {
-    "@travetto/base": "^3.4.2",
-    "@travetto/command": "^3.4.3"
+    "@travetto/base": "^4.0.0-rc.1",
+    "@travetto/command": "^4.0.0-rc.1"
   },
   "travetto": {
     "displayName": "Image"

package/src/convert.ts

@@ -1,8 +1,10 @@
-import { Readable } from 'stream';
-import { createReadStream } from 'fs';
+import { Readable } from 'node:stream';
+import { createReadStream } from 'node:fs';
+import { ChildProcess } from 'node:child_process';
+import { pipeline } from 'node:stream/promises';
 
 import { CommandOperation } from '@travetto/command';
-import { StreamUtil } from '@travetto/base';
+import { MemoryWritable, StreamUtil } from '@travetto/base';
 
 /**
  * Image output options
@@ -58,37 +60,53 @@ export class ImageConverter {
     localCheck: ['jpegoptim', ['-h']]
   });
 
+  static async #stream<T extends ImageType>(proc: ChildProcess, input: T): Promise<T> {
+    if (Buffer.isBuffer(input)) {
+      const buffer = new MemoryWritable();
+      await Promise.all([
+        pipeline(await StreamUtil.toStream(input), proc.stdin!),
+        pipeline(proc.stdout!, buffer)
+      ]);
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+      return buffer.toBuffer() as T;
+    } else {
+      input.pipe(proc.stdin!); // Start the process
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+      return proc.stdout! as T;
+    }
+  }
+
   /**
    * Resize image using imagemagick
    */
   static async resize<T extends ImageType>(image: T, options: ImageOptions): Promise<T> {
     const dims = [options.w, options.h].map(d => (d && options.strictResolution !== false) ? `${d}!` : d).join('x');
 
-    const state = await this.CONVERTER.exec(
+    const proc = await this.CONVERTER.exec(
       'gm', 'convert', '-resize', dims, '-auto-orient',
       ...(options.optimize ? ['-strip', '-quality', '86'] : []),
       '-', '-');
 
-    return await StreamUtil.execPipe(state, image);
+    return this.#stream(proc, image);
   }
 
   /**
    * Optimize png using pngquant
    */
   static async optimize<T extends ImageType>(format: 'png' | 'jpeg', image: T): Promise<T> {
-    let stream;
+    let proc: ChildProcess;
     switch (format) {
       case 'png': {
-        stream = await this.PNG_COMPRESSOR.exec(
+        proc = await this.PNG_COMPRESSOR.exec(
           'pngquant', '--quality', '40-80', '--speed', '1', '--force', '-');
         break;
       }
       case 'jpeg': {
-        stream = await this.JPEG_COMPRESSOR.exec('jpegoptim', '-m70', '-s', '--stdin', '--stdout');
+        proc = await this.JPEG_COMPRESSOR.exec('jpegoptim', '-m70', '-s', '--stdin', '--stdout');
         break;
       }
     }
-    return await StreamUtil.execPipe(stream, image);
+    return this.#stream(proc, image);
   }
 
   /**
@@ -96,7 +114,7 @@ export class ImageConverter {
    * @param image
    */
   static async getDimensions(image: Readable | Buffer | string): Promise<{ width: number, height: number }> {
-    const state = await this.CONVERTER.exec(
+    const proc = await this.CONVERTER.exec(
       'gm', 'identify', '-format', '%wX%h', '-',
     );
 
@@ -104,10 +122,13 @@ export class ImageConverter {
       image = createReadStream(image);
     }
 
-    await StreamUtil.execPipe(state, await StreamUtil.toStream(image));
+    const buffer = new MemoryWritable();
+    await Promise.all([
+      pipeline(image, proc.stdin!),
+      pipeline(proc.stdout!, buffer)
+    ]);
 
-    const buf = await StreamUtil.toBuffer(state.process.stdout!);
-    const text = buf.toString('utf8');
+    const text = buffer.toBuffer('utf8');
     const [w, h] = text.split('X').map(x => parseFloat(x));
 
     return { width: w, height: h };

package/src/resource.ts

@@ -1,8 +1,9 @@
-import fs from 'fs/promises';
-import { Readable } from 'stream';
+import fs from 'node:fs/promises';
+import { Readable } from 'node:stream';
+import { pipeline } from 'node:stream/promises';
 
-import { ManifestFileUtil, RootIndex, path } from '@travetto/manifest';
-import { Env, ResourceLoader, StreamUtil } from '@travetto/base';
+import { RuntimeContext, path } from '@travetto/manifest';
+import { Env, ResourceLoader } from '@travetto/base';
 
 import { ImageConverter } from './convert';
 
@@ -16,7 +17,7 @@ export class ImageOptimizingResourceLoader extends ResourceLoader {
   constructor(paths: string[] = [], cacheRoot?: string) {
     super(paths);
 
-    this.#cacheRoot = cacheRoot ?? path.resolve(Env.get('TRV_IMAGE_CACHE', ManifestFileUtil.toolPath(RootIndex, 'image_cache')));
+    this.#cacheRoot = cacheRoot ?? path.resolve(Env.TRV_IMAGE_CACHE.val || RuntimeContext.toolPath('image_cache'));
   }
 
   async #openFile(pth: string): Promise<fs.FileHandle> {
@@ -40,7 +41,7 @@ export class ImageOptimizingResourceLoader extends ResourceLoader {
       } else if (/[.]jpe?g$/i.test(rel)) {
         stream = await ImageConverter.optimize('jpeg', stream);
       }
-      await StreamUtil.pipe(stream, handle.createWriteStream());
+      await pipeline(stream, handle.createWriteStream());
     }
 
     const buffer = await handle.readFile();

package/src/trv.d.ts

@@ -0,0 +1,11 @@
+import '@travetto/base';
+
+declare global {
+  interface TravettoEnv {
+    /** 
+     * Where should optimized images be stored by default
+     * @default undefined
+     */
+    TRV_IMAGE_CACHE: string;
+  }
+}