@travetto/image 3.3.4 → 3.4.0-rc.1

package/README.md

@@ -15,7 +15,7 @@ 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#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.
+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.
 
 **Code: Simple Image Resize**
 ```typescript

package/package.json

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

package/src/convert.ts

@@ -1,5 +1,5 @@
 import { Readable } from 'stream';
-
+import { createReadStream } from 'fs';
 
 import { CommandOperation } from '@travetto/command';
 import { StreamUtil } from '@travetto/base';
@@ -20,6 +20,10 @@ export interface ImageOptions {
    * Should the image be optimized?
    */
   optimize?: boolean;
+  /**
+   * Strict resolution
+   */
+  strictResolution?: boolean;
 }
 
 type ImageType = Readable | Buffer;
@@ -58,9 +62,10 @@ export class ImageConverter {
    * 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(
-      'gm', 'convert', '-resize', `${options.w ?? ''}x${options.h ?? ''}`,
-      '-auto-orient',
+      'gm', 'convert', '-resize', dims, '-auto-orient',
       ...(options.optimize ? ['-strip', '-quality', '86'] : []),
       '-', '-');
 
@@ -85,4 +90,26 @@ export class ImageConverter {
     }
     return await StreamUtil.execPipe(stream, image);
   }
+
+  /**
+   * Get Image Dimensions
+   * @param image
+   */
+  static async getDimensions(image: Readable | Buffer | string): Promise<{ width: number, height: number }> {
+    const state = await this.CONVERTER.exec(
+      'gm', 'identify', '-format', '%wX%h', '-',
+    );
+
+    if (typeof image === 'string') {
+      image = createReadStream(image);
+    }
+
+    await StreamUtil.execPipe(state, await StreamUtil.toStream(image));
+
+    const buf = await StreamUtil.toBuffer(state.process.stdout!);
+    const text = buf.toString('utf8');
+    const [w, h] = text.split('X').map(x => parseFloat(x));
+
+    return { width: w, height: h };
+  }
 }

package/src/resource.ts

@@ -1,7 +1,7 @@
 import fs from 'fs/promises';
 import { Readable } from 'stream';
 
-import { path } from '@travetto/manifest';
+import { ManifestFileUtil, RootIndex, path } from '@travetto/manifest';
 import { Env, FileResourceProvider, StreamUtil } from '@travetto/base';
 
 import { ImageConverter } from './convert';
@@ -16,7 +16,7 @@ export class ImageOptimizingResourceProvider extends FileResourceProvider {
   constructor(paths?: string[], cacheRoot?: string) {
     super({ paths, includeCommon: true });
 
-    this.#cacheRoot = cacheRoot ?? path.resolve(Env.get('TRV_IMAGE_CACHE', '.trv_images'));
+    this.#cacheRoot = cacheRoot ?? path.resolve(Env.get('TRV_IMAGE_CACHE', ManifestFileUtil.toolPath(RootIndex, 'image_cache')));
   }
 
   async #openFile(pth: string): Promise<fs.FileHandle> {