@travetto/image 3.0.0-rc.1 → 3.0.0-rc.10

package/README.md

@@ -1,5 +1,5 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
-<!-- Please modify https://github.com/travetto/travetto/tree/main/module/image/doc.ts and execute "npx trv doc" to rebuild -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/image/DOC.ts and execute "npx trv doc" to rebuild -->
 # Image
 ## Image support, resizing, and optimization
 
@@ -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#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#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 { createReadStream } from 'fs';
 
-import { StreamUtil } from '@travetto/boot';
-import { ImageUtil } from '@travetto/image';
+import { StreamUtil } from '@travetto/base';
+import { ImageConverter } from '@travetto/image';
 
 export class ResizeService {
   async resizeImage(imgPath: string, width: number, height: number): Promise<string> {
-    const stream = await ImageUtil.resize(createReadStream(imgPath), { w: width, h: height });
+    const stream = await ImageConverter.resize(createReadStream(imgPath), { w: width, h: height });
     const out = imgPath.replace(/[.][^.]+$/, (ext) => `.resized${ext}`);
     await StreamUtil.writeToFile(stream, out);
     return out;

package/__index__.ts

@@ -0,0 +1 @@
+export * from './src/convert';

package/package.json

@@ -1,7 +1,6 @@
 {
   "name": "@travetto/image",
-  "displayName": "Image",
-  "version": "3.0.0-rc.1",
+  "version": "3.0.0-rc.10",
   "description": "Image support, resizing, and optimization",
   "keywords": [
     "images",
@@ -15,16 +14,20 @@
     "name": "Travetto Framework"
   },
   "files": [
-    "index.ts",
+    "__index__.ts",
     "src"
   ],
-  "main": "index.ts",
+  "main": "__index__.ts",
   "repository": {
     "url": "https://github.com/travetto/travetto.git",
     "directory": "module/image"
   },
   "dependencies": {
-    "@travetto/command": "^3.0.0-rc.1"
+    "@travetto/base": "^3.0.0-rc.10",
+    "@travetto/command": "^3.0.0-rc.10"
+  },
+  "travetto": {
+    "displayName": "Image"
   },
   "publishConfig": {
     "access": "public"

package/src/convert.ts

@@ -0,0 +1,88 @@
+import { Readable } from 'stream';
+
+
+import { CommandOperation } from '@travetto/command';
+import { StreamUtil } from '@travetto/base';
+
+/**
+ * Image output options
+ */
+export interface ImageOptions {
+  /**
+   * New height
+   */
+  h?: number;
+  /**
+   * New width
+   */
+  w?: number;
+  /**
+   * Should the image be optimized?
+   */
+  optimize?: boolean;
+}
+
+type ImageType = Readable | Buffer;
+
+/**
+ * Simple support for image manipulation.  Built upon @travetto/command, it can
+ * run imagemagick and pngquant locally or via docker as needed.
+ */
+export class ImageConverter {
+
+  /**
+   * Resize/conversion util
+   */
+  static CONVERTER = new CommandOperation({
+    containerImage: ' jameskyburz/graphicsmagick-alpine:v1.0.0',
+    localCheck: ['gm', ['-version']]
+  });
+
+  /**
+   * Compressor
+   */
+  static PNG_COMPRESSOR = new CommandOperation({
+    containerImage: 'agregad/pngquant',
+    localCheck: ['pngquant', ['-h']]
+  });
+
+  /**
+   * Compressor
+   */
+  static JPEG_COMPRESSOR = new CommandOperation({
+    containerImage: 'shomatan/jpegoptim:1.4.4',
+    localCheck: ['jpegoptim', ['-h']]
+  });
+
+  /**
+   * Resize image using imagemagick
+   */
+  static async resize<T extends ImageType>(image: T, options: ImageOptions): Promise<T> {
+    const state = await this.CONVERTER.exec(
+      'gm', 'convert', '-resize', `${options.w ?? ''}x${options.h ?? ''}`,
+      '-auto-orient',
+      ...(options.optimize ? ['-strip', '-quality', '86'] : []),
+      '-', '-');
+
+    return await StreamUtil.execPipe(state, image);
+  }
+
+  /**
+   * Optimize png using pngquant
+   */
+  static async optimize<T extends ImageType>(format: 'png' | 'jpeg', image: T): Promise<T> {
+    let stream;
+    switch (format) {
+      case 'png': {
+        stream = 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');
+        break;
+      }
+    }
+    return await StreamUtil.execPipe(stream, image);
+  }
+}

package/src/resource.ts

@@ -0,0 +1,51 @@
+import fs from 'fs/promises';
+import { Readable } from 'stream';
+
+import { path } from '@travetto/manifest';
+import { Env, FileResourceProvider, StreamUtil } from '@travetto/base';
+
+import { ImageConverter } from './convert';
+
+/**
+ * Resource provider for images that allows for real-time optimization
+ */
+export class ImageOptimizingResourceProvider extends FileResourceProvider {
+
+  #cacheRoot: string;
+
+  constructor(paths?: string[], cacheRoot?: string) {
+    super({ paths, includeCommon: true });
+
+    this.#cacheRoot = cacheRoot ?? path.resolve(Env.get('TRV_IMAGE_CACHE', '.trv_images'));
+  }
+
+  async #openFile(pth: string): Promise<fs.FileHandle> {
+    return fs.open(path.join(this.#cacheRoot, pth.replace(/[\\/]/g, '__')));
+  }
+
+  /**
+   * Fetch image, compress and return as buffer
+   */
+  async readOptimized(rel: string): Promise<Buffer> {
+    const { path: pth } = await this.describe(rel);
+    const cachedOutput = path.resolve(this.#cacheRoot, rel);
+    await fs.mkdir(path.dirname(cachedOutput), { recursive: true });
+
+    const handle = await this.#openFile(cachedOutput);
+    const exists = !!(await handle.stat().catch(() => false));
+
+    if (!exists) {
+      let stream: Buffer | Readable = await this.readStream(rel);
+      if (/[.]png$/.test(pth)) {
+        stream = await ImageConverter.optimize('png', stream);
+      } else if (/[.]jpe?g$/i.test(pth)) {
+        stream = await ImageConverter.optimize('jpeg', stream);
+      }
+      await StreamUtil.pipe(stream, handle.createWriteStream());
+    }
+
+    const buffer = await handle.readFile();
+    await handle.close();
+    return buffer;
+  }
+}

package/index.ts

@@ -1 +0,0 @@
-export * from './src/util';

package/src/util.ts

@@ -1,116 +0,0 @@
-import * as fs from 'fs/promises';
-import { Readable } from 'stream';
-
-import { CommandService } from '@travetto/command';
-import { ExecUtil, StreamUtil, AppCache, FsUtil } from '@travetto/boot';
-
-/**
- * Image output options
- */
-export interface ImageOptions {
-  /**
-   * New height
-   */
-  h?: number;
-  /**
-   * New width
-   */
-  w?: number;
-  /**
-   * Should the image be optimized?
-   */
-  optimize?: boolean;
-}
-
-type ImageType = Readable | Buffer;
-
-/**
- * Simple support for image manipulation.  Built upon @travetto/command, it can
- * run imagemagick and pngquant locally or via docker as needed.
- */
-export class ImageUtil {
-
-  /**
-   * Resize/conversion util
-   */
-  static CONVERTER = new CommandService({
-    containerImage: ' jameskyburz/graphicsmagick-alpine:v1.0.0',
-    localCheck: ['gm', ['-version']]
-  });
-
-  /**
-   * Compressor
-   */
-  static PNG_COMPRESSOR = new CommandService({
-    containerImage: 'agregad/pngquant',
-    localCheck: ['pngquant', ['-h']]
-  });
-
-  /**
-   * Compressor
-   */
-  static JPEG_COMPRESSOR = new CommandService({
-    containerImage: 'shomatan/jpegoptim:1.4.4',
-    localCheck: ['jpegoptim', ['-h']]
-  });
-
-  /**
-   * Resize image using imagemagick
-   */
-  static resize(image: Readable, options: ImageOptions): Promise<Readable>;
-  static resize(image: Buffer, options: ImageOptions): Promise<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 using pngquant
-   */
-  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<Readable | Buffer> {
-    let stream;
-    switch (format) {
-      case 'png': {
-        stream = 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');
-        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): 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 | Readable = await ResourceManager.readStream(rel);
-      if (/[.]png$/.test(pth)) {
-        stream = await this.optimize('png', stream);
-      } else if (/[.]jpe?g$/i.test(pth)) {
-        stream = await this.optimize('jpeg', stream);
-      }
-      await StreamUtil.writeToFile(stream, out);
-    }
-
-    return fs.readFile(out);
-  }
-}