@node-minify/types 10.1.1 → 10.3.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @node-minify/types
 
+## 10.3.0
+
+## 10.2.0
+
+### Patch Changes
+
+- 3c98739: feat: Add image compression support
+
+  New packages:
+
+  - `@node-minify/sharp`: Convert and compress images to WebP, AVIF, PNG, JPEG using sharp
+  - `@node-minify/svgo`: Optimize SVG files using SVGO
+  - `@node-minify/imagemin`: Compress PNG, JPEG, GIF images using imagemin
+
+  Core changes:
+
+  - Support for binary (Buffer) content in compressors
+  - Multi-format output support (e.g., convert PNG to both WebP and AVIF)
+  - New `buffer` and `outputs` fields in CompressorResult type
+
 ## 10.1.1
 
 ### Patch Changes

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Rodolphe Stoclin
+Copyright (c) 2011-2026 Rodolphe Stoclin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,13 +1,13 @@
-<p align="center"><img src="/static/node-minify.svg" width="348" alt="node-minify"></p>
+<p align="center"><img src="https://raw.githubusercontent.com/srod/node-minify/main/static/node-minify.svg" width="348" alt="node-minify"></p>
 
 <p align="center">A very light minifier Node.js module.</p>
 
 <p align="center">
   <br>
-  <a href="https://npmjs.org/package/@node-minify/types"><img src="https://img.shields.io/npm/v/@node-minify/types.svg"></a>
-  <a href="https://npmjs.org/package/@node-minify/types"><img src="https://img.shields.io/npm/dm/@node-minify/types.svg"></a>
+  <a href="https://npmjs.org/package/@node-minify/types"><img src="https://img.shields.io/npm/v/@node-minify/types.svg" alt="npm version"></a>
+  <a href="https://npmjs.org/package/@node-minify/types"><img src="https://img.shields.io/npm/dm/@node-minify/types.svg" alt="npm downloads"></a>
   <a href="https://github.com/srod/node-minify/actions"><img alt="Build Status" src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fsrod%2Fnode-minify%2Fbadge%3Fref%3Dmain&style=flat" /></a>
-  <a href="https://codecov.io/gh/srod/node-minify"><img src="https://codecov.io/gh/srod/node-minify/branch/main/graph/badge.svg"></a>
+  <a href="https://codecov.io/gh/srod/node-minify"><img src="https://codecov.io/gh/srod/node-minify/branch/main/graph/badge.svg" alt="code coverage"></a>
 </p>
 
 # Types for node-minify

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@node-minify/types",
-  "version": "10.1.1",
+  "version": "10.3.0",
   "description": "types for @node-minify",
   "keywords": [
     "compressor",

package/src/types.d.ts

@@ -1,6 +1,6 @@
 /*!
  * node-minify
- * Copyright(c) 2011-2025 Rodolphe Stoclin
+ * Copyright (c) 2011-2026 Rodolphe Stoclin
  * MIT Licensed
  */
 
@@ -10,12 +10,63 @@
  */
 export type CompressorReturnType = string;
 
+/**
+ * Supported image formats for image compression.
+ */
+export type ImageFormat =
+    | "webp"
+    | "avif"
+    | "png"
+    | "jpeg"
+    | "jpg"
+    | "gif"
+    | "tiff"
+    | "heif"
+    | "heic";
+
+/**
+ * Output result for multi-format image compression.
+ */
+export type CompressorOutput = {
+    /**
+     * Format of the output (e.g., 'webp', 'avif').
+     */
+    format?: string;
+
+    /**
+     * Output content as string or Buffer.
+     */
+    content: string | Buffer;
+};
+
 /**
  * Result returned by a compressor function.
  */
 export type CompressorResult = {
+    /**
+     * Minified content as string (for text-based formats like JS, CSS, HTML, SVG).
+     */
     code: string;
+
+    /**
+     * Source map (for JS/CSS compressors).
+     */
     map?: string;
+
+    /**
+     * Minified content as Buffer (for binary formats like images).
+     * @example
+     * When using sharp for PNG/WebP compression
+     */
+    buffer?: Buffer;
+
+    /**
+     * Multiple outputs for multi-format image compression.
+     * Used when converting to multiple formats simultaneously.
+     * @example
+     * [{ format: 'webp', content: <Buffer> }, { format: 'avif', content: <Buffer> }]
+     */
+    outputs?: CompressorOutput[];
 };
 
 /**
@@ -68,8 +119,10 @@ export type Settings<TOptions extends CompressorOptions = CompressorOptions> = {
     /**
      * Content to minify (for in-memory minification).
      * If provided, input/output are not required.
+     * For text-based formats (JS, CSS, HTML, SVG): string
+     * For binary formats (images): Buffer (handled internally by image compressors)
      */
-    content?: string;
+    content?: string | Buffer;
 
     /**
      * Input file path(s) or glob pattern.
@@ -112,6 +165,12 @@ export type Settings<TOptions extends CompressorOptions = CompressorOptions> = {
      */
     buffer?: number;
 
+    /**
+     * Timeout for the compressor process (in milliseconds).
+     * If execution exceeds this limit, the process will be killed.
+     */
+    timeout?: number;
+
     /**
      * File type for compressors that support multiple types.
      * Required for YUI compressor.
@@ -154,8 +213,11 @@ export type MinifierOptions<
 
     /**
      * The content to minify.
+     * For text-based formats (JS, CSS, HTML, SVG): string
+     * For binary formats (images): Buffer
+     * For multiple binary files: Buffer[]
      */
-    content?: string;
+    content?: string | Buffer | Buffer[];
 
     /**
      * Index of current file when processing multiple files.