@node-minify/sqwish 10.1.0 → 10.2.0

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/sqwish"><img src="https://img.shields.io/npm/v/@node-minify/sqwish.svg"></a>
-  <a href="https://npmjs.org/package/@node-minify/sqwish"><img src="https://img.shields.io/npm/dm/@node-minify/sqwish.svg"></a>
+  <a href="https://npmjs.org/package/@node-minify/sqwish"><img src="https://img.shields.io/npm/v/@node-minify/sqwish.svg" alt="npm version"></a>
+  <a href="https://npmjs.org/package/@node-minify/sqwish"><img src="https://img.shields.io/npm/dm/@node-minify/sqwish.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>
 
 # sqwish

package/dist/index.d.ts

@@ -1,11 +1,47 @@
 //#region ../types/src/types.d.ts
 
+/**
+ * Output result for multi-format image compression.
+ */
+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.
  */
 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[];
 };
 /**
  * Base options that all compressors can accept.
@@ -53,8 +89,10 @@ 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.
@@ -136,8 +174,11 @@ type MinifierOptions<TOptions extends CompressorOptions = CompressorOptions> = {
 
   /**
    * 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.
@@ -147,11 +188,12 @@ type MinifierOptions<TOptions extends CompressorOptions = CompressorOptions> = {
 //#endregion
 //#region src/index.d.ts
 /**
- * Run sqwish.
+ * Minify CSS content with the Sqwish minifier and emit a deprecation warning.
+ *
  * @deprecated sqwish is no longer maintained. Use @node-minify/cssnano or @node-minify/clean-css instead.
- * @param settings - Sqwish options
- * @param content - Content to minify
- * @returns Minified content
+ * @param settings - Minifier options; `settings.options.strict` (if present) controls Sqwish strict mode
+ * @param content - Content to minify; will be converted to a string if necessary
+ * @returns An object containing the minified code in the `code` property
  */
 declare function sqwish({
   settings,

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":["CompressorReturnType","CompressorResult","CompressorOptions","Record","Compressor","TOptions","MinifierOptions","Promise","FileType","Settings","Result","MinifyOptions"],"sources":["../../types/src/types.d.ts","../src/index.ts"],"sourcesContent":["/*!\n * node-minify\n * Copyright(c) 2011-2025 Rodolphe Stoclin\n * MIT Licensed\n */\n\n/**\n * The return type of a compressor function.\n * @deprecated Use `CompressorResult` instead. Will be removed in v11.\n */\nexport type CompressorReturnType = string;\n\n/**\n * Result returned by a compressor function.\n */\nexport type CompressorResult = {\n    code: string;\n    map?: string;\n};\n\n/**\n * Base options that all compressors can accept.\n * Specific compressors may extend this with their own options.\n */\nexport type CompressorOptions = Record<string, unknown>;\n\n/**\n * A compressor function that minifies content.\n * @param args - The minifier options including settings and content\n * @returns A promise resolving to the compression result\n */\nexport type Compressor<TOptions extends CompressorOptions = CompressorOptions> =\n    (args: MinifierOptions<TOptions>) => Promise<CompressorResult>;\n\n/**\n * File type for compressors that support multiple types (e.g., YUI).\n */\nexport type FileType = \"js\" | \"css\";\n\n/**\n * User-facing settings for the minify function.\n * This is what users pass when calling minify().\n *\n * @example\n * ```ts\n * import { minify } from '@node-minify/core';\n * import { terser } from '@node-minify/terser';\n *\n * await minify({\n *   compressor: terser,\n *   input: 'src/*.js',\n *   output: 'dist/bundle.min.js',\n *   options: { mangle: true }\n * });\n * ```\n */\nexport type Settings<TOptions extends CompressorOptions = CompressorOptions> = {\n    /**\n     * The compressor function to use for minification.\n     */\n    compressor: Compressor<TOptions>;\n\n    /**\n     * Optional label for the compressor (used in logging).\n     */\n    compressorLabel?: string;\n\n    /**\n     * Content to minify (for in-memory minification).\n     * If provided, input/output are not required.\n     */\n    content?: string;\n\n    /**\n     * Input file path(s) or glob pattern.\n     * Can be a single file, array of files, or wildcard pattern.\n     *\n     * @example\n     * - 'src/app.js'\n     * - ['src/a.js', 'src/b.js']\n     * - 'src/**\\/*.js'\n     */\n    input?: string | string[];\n\n    /**\n     * Output file path.\n     * Use $1 as placeholder for input filename in multi-file scenarios.\n     * Can be a single file, array of files, or pattern with $1.\n     *\n     * @example\n     * - 'dist/bundle.min.js'\n     * - ['file1.min.js', 'file2.min.js']\n     * - '$1.min.js' (creates app.min.js from app.js)\n     */\n    output?: string | string[];\n\n    /**\n     * Compressor-specific options.\n     * See individual compressor documentation for available options.\n     */\n    options?: TOptions;\n\n    /**\n     * CLI option string (used by CLI only).\n     * @internal\n     */\n    option?: string;\n\n    /**\n     * Buffer size for file operations (in bytes).\n     * @default 1024000 (1MB)\n     */\n    buffer?: number;\n\n    /**\n     * File type for compressors that support multiple types.\n     * Required for YUI compressor.\n     */\n    type?: FileType;\n\n    /**\n     * Suppress console output.\n     * @default false\n     */\n    silence?: boolean;\n\n    /**\n     * Public folder to prepend to input paths.\n     *\n     * @example\n     * With publicFolder: 'public/js/' and input: 'app.js',\n     * the actual path becomes 'public/js/app.js'\n     */\n    publicFolder?: string;\n\n    /**\n     * Replace files in place instead of creating new output files.\n     * @default false\n     */\n    replaceInPlace?: boolean;\n};\n\n/**\n * Options passed to compressor functions internally.\n * This is what compressors receive, not what users pass.\n */\nexport type MinifierOptions<\n    TOptions extends CompressorOptions = CompressorOptions,\n> = {\n    /**\n     * The full settings object.\n     */\n    settings: Settings<TOptions>;\n\n    /**\n     * The content to minify.\n     */\n    content?: string;\n\n    /**\n     * Index of current file when processing multiple files.\n     */\n    index?: number;\n};\n\n/**\n * Result returned after compression (used by CLI).\n */\nexport type Result = {\n    /**\n     * Label of the compressor used.\n     */\n    compressorLabel: string;\n\n    /**\n     * Size of minified content (formatted string, e.g., \"1.5 KB\").\n     */\n    size: string;\n\n    /**\n     * Gzipped size of minified content (formatted string).\n     */\n    sizeGzip: string;\n};\n\n/**\n * Type alias for user convenience.\n * @deprecated Use `Settings` instead. Will be removed in v11.\n */\nexport type MinifyOptions<\n    TOptions extends CompressorOptions = CompressorOptions,\n> = Settings<TOptions>;\n"],"mappings":";;AAwDA;;;AAI2BK,KA7CfJ,gBAAAA,GA6CeI;EAAXD,IAAAA,EAAAA,MAAAA;EAwCFC,GAAAA,CAAAA,EAAAA,MAAAA;CAkBHG;AA4BX;;;;AAMcC,KAhIFP,iBAAAA,GAAoBC,MAgIlBM,CAAAA,MAAAA,EAAAA,OAAAA,CAAAA;;;;ACvId;;AAEI,KDYQL,UCZR,CAAA,iBDYoCF,iBCZpC,GDYwDA,iBCZxD,CAAA,GACD,CAAA,IAAA,EDYQI,eCZR,CDYwBD,QCZxB,CAAA,EAAA,GDYsCE,OCZtC,CDY8CN,gBCZ9C,CAAA;;;;KDiBSO,QAAAA;;;;;;;;;;;;;;;;;;KAmBAC,0BAA0BP,oBAAoBA;;;;cAI1CE,WAAWC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAwCbA;;;;;;;;;;;;;;;;;;SAkBHG;;;;;;;;;;;;;;;;;;;;;;;;;;;KA4BCF,iCACSJ,oBAAoBA;;;;YAK3BO,SAASJ;;;;;;;;;;;;;;;;;;;AAnHvB;AAmBA;AAAsCH,iBCvChB,MAAA,CDuCgBA;EAAAA,QAAAA;EAAAA;AAAAA,CAAAA,ECpCnC,eDoCmCA,CAAAA,ECpCjB,ODoCiBA,CCpCT,gBDoCSA,CAAAA"}
+{"version":3,"file":"index.d.ts","names":["CompressorReturnType","ImageFormat","CompressorOutput","Buffer","CompressorResult","CompressorOptions","Record","Compressor","TOptions","MinifierOptions","Promise","FileType","Settings","Result","MinifyOptions"],"sources":["../../types/src/types.d.ts","../src/index.ts"],"sourcesContent":["/*!\n * node-minify\n * Copyright(c) 2011-2025 Rodolphe Stoclin\n * MIT Licensed\n */\n\n/**\n * The return type of a compressor function.\n * @deprecated Use `CompressorResult` instead. Will be removed in v11.\n */\nexport type CompressorReturnType = string;\n\n/**\n * Supported image formats for image compression.\n */\nexport type ImageFormat =\n    | \"webp\"\n    | \"avif\"\n    | \"png\"\n    | \"jpeg\"\n    | \"jpg\"\n    | \"gif\"\n    | \"tiff\"\n    | \"heif\"\n    | \"heic\";\n\n/**\n * Output result for multi-format image compression.\n */\nexport type CompressorOutput = {\n    /**\n     * Format of the output (e.g., 'webp', 'avif').\n     */\n    format?: string;\n\n    /**\n     * Output content as string or Buffer.\n     */\n    content: string | Buffer;\n};\n\n/**\n * Result returned by a compressor function.\n */\nexport type CompressorResult = {\n    /**\n     * Minified content as string (for text-based formats like JS, CSS, HTML, SVG).\n     */\n    code: string;\n\n    /**\n     * Source map (for JS/CSS compressors).\n     */\n    map?: string;\n\n    /**\n     * Minified content as Buffer (for binary formats like images).\n     * @example\n     * When using sharp for PNG/WebP compression\n     */\n    buffer?: Buffer;\n\n    /**\n     * Multiple outputs for multi-format image compression.\n     * Used when converting to multiple formats simultaneously.\n     * @example\n     * [{ format: 'webp', content: <Buffer> }, { format: 'avif', content: <Buffer> }]\n     */\n    outputs?: CompressorOutput[];\n};\n\n/**\n * Base options that all compressors can accept.\n * Specific compressors may extend this with their own options.\n */\nexport type CompressorOptions = Record<string, unknown>;\n\n/**\n * A compressor function that minifies content.\n * @param args - The minifier options including settings and content\n * @returns A promise resolving to the compression result\n */\nexport type Compressor<TOptions extends CompressorOptions = CompressorOptions> =\n    (args: MinifierOptions<TOptions>) => Promise<CompressorResult>;\n\n/**\n * File type for compressors that support multiple types (e.g., YUI).\n */\nexport type FileType = \"js\" | \"css\";\n\n/**\n * User-facing settings for the minify function.\n * This is what users pass when calling minify().\n *\n * @example\n * ```ts\n * import { minify } from '@node-minify/core';\n * import { terser } from '@node-minify/terser';\n *\n * await minify({\n *   compressor: terser,\n *   input: 'src/*.js',\n *   output: 'dist/bundle.min.js',\n *   options: { mangle: true }\n * });\n * ```\n */\nexport type Settings<TOptions extends CompressorOptions = CompressorOptions> = {\n    /**\n     * The compressor function to use for minification.\n     */\n    compressor: Compressor<TOptions>;\n\n    /**\n     * Optional label for the compressor (used in logging).\n     */\n    compressorLabel?: string;\n\n    /**\n     * Content to minify (for in-memory minification).\n     * If provided, input/output are not required.\n     * For text-based formats (JS, CSS, HTML, SVG): string\n     * For binary formats (images): Buffer (handled internally by image compressors)\n     */\n    content?: string | Buffer;\n\n    /**\n     * Input file path(s) or glob pattern.\n     * Can be a single file, array of files, or wildcard pattern.\n     *\n     * @example\n     * - 'src/app.js'\n     * - ['src/a.js', 'src/b.js']\n     * - 'src/**\\/*.js'\n     */\n    input?: string | string[];\n\n    /**\n     * Output file path.\n     * Use $1 as placeholder for input filename in multi-file scenarios.\n     * Can be a single file, array of files, or pattern with $1.\n     *\n     * @example\n     * - 'dist/bundle.min.js'\n     * - ['file1.min.js', 'file2.min.js']\n     * - '$1.min.js' (creates app.min.js from app.js)\n     */\n    output?: string | string[];\n\n    /**\n     * Compressor-specific options.\n     * See individual compressor documentation for available options.\n     */\n    options?: TOptions;\n\n    /**\n     * CLI option string (used by CLI only).\n     * @internal\n     */\n    option?: string;\n\n    /**\n     * Buffer size for file operations (in bytes).\n     * @default 1024000 (1MB)\n     */\n    buffer?: number;\n\n    /**\n     * File type for compressors that support multiple types.\n     * Required for YUI compressor.\n     */\n    type?: FileType;\n\n    /**\n     * Suppress console output.\n     * @default false\n     */\n    silence?: boolean;\n\n    /**\n     * Public folder to prepend to input paths.\n     *\n     * @example\n     * With publicFolder: 'public/js/' and input: 'app.js',\n     * the actual path becomes 'public/js/app.js'\n     */\n    publicFolder?: string;\n\n    /**\n     * Replace files in place instead of creating new output files.\n     * @default false\n     */\n    replaceInPlace?: boolean;\n};\n\n/**\n * Options passed to compressor functions internally.\n * This is what compressors receive, not what users pass.\n */\nexport type MinifierOptions<\n    TOptions extends CompressorOptions = CompressorOptions,\n> = {\n    /**\n     * The full settings object.\n     */\n    settings: Settings<TOptions>;\n\n    /**\n     * The content to minify.\n     * For text-based formats (JS, CSS, HTML, SVG): string\n     * For binary formats (images): Buffer\n     * For multiple binary files: Buffer[]\n     */\n    content?: string | Buffer | Buffer[];\n\n    /**\n     * Index of current file when processing multiple files.\n     */\n    index?: number;\n};\n\n/**\n * Result returned after compression (used by CLI).\n */\nexport type Result = {\n    /**\n     * Label of the compressor used.\n     */\n    compressorLabel: string;\n\n    /**\n     * Size of minified content (formatted string, e.g., \"1.5 KB\").\n     */\n    size: string;\n\n    /**\n     * Gzipped size of minified content (formatted string).\n     */\n    sizeGzip: string;\n};\n\n/**\n * Type alias for user convenience.\n * @deprecated Use `Settings` instead. Will be removed in v11.\n */\nexport type MinifyOptions<\n    TOptions extends CompressorOptions = CompressorOptions,\n> = Settings<TOptions>;\n"],"mappings":";;;;;AAqNsC,KAxL1BE,gBAAAA,GAwL0B;;;;ECnMhB,MAAA,CAAA,EAAM,MAAA;;EAExB;;;EACiB,OAAA,EAAA,MAAA,GDiBCC,MCjBD;CAAO;;;;KDuBhBC,gBAAAA;;;;;;;;;;;;;;;;WAgBCD;;;;;;;;YAQCD;;;;;;KAOFG,iBAAAA,GAAoBC;;;;;;KAOpBC,4BAA4BF,oBAAoBA,4BACjDI,gBAAgBD,cAAcE,QAAQN;;;;KAKrCO,QAAAA;;;;;;;;;;;;;;;;;;KAmBAC,0BAA0BP,oBAAoBA;;;;cAI1CE,WAAWC;;;;;;;;;;;;;qBAaJL;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YA6BTK;;;;;;;;;;;;;;;;;;SAkBHG;;;;;;;;;;;;;;;;;;;;;;;;;;;KA4BCF,iCACSJ,oBAAoBA;;;;YAK3BO,SAASJ;;;;;;;;qBAQAL,SAASA;;;;;;;;;;;;;;;AA7HhC;AAmBA;AAAsCE,iBCzFhB,MAAA,CDyFgBA;EAAAA,QAAAA;EAAAA;AAAAA,CAAAA,ECtFnC,eDsFmCA,CAAAA,ECtFjB,ODsFiBA,CCtFT,gBDsFSA,CAAAA"}

package/dist/index.js

@@ -1,18 +1,20 @@
-import { warnDeprecation } from "@node-minify/utils";
+import { ensureStringContent, warnDeprecation } from "@node-minify/utils";
 import minify from "sqwish";
 
 //#region src/index.ts
 /**
-* Run sqwish.
+* Minify CSS content with the Sqwish minifier and emit a deprecation warning.
+*
 * @deprecated sqwish is no longer maintained. Use @node-minify/cssnano or @node-minify/clean-css instead.
-* @param settings - Sqwish options
-* @param content - Content to minify
-* @returns Minified content
+* @param settings - Minifier options; `settings.options.strict` (if present) controls Sqwish strict mode
+* @param content - Content to minify; will be converted to a string if necessary
+* @returns An object containing the minified code in the `code` property
 */
 async function sqwish({ settings, content }) {
+	const contentStr = ensureStringContent(content, "sqwish");
 	warnDeprecation("sqwish", "sqwish is no longer maintained. Please migrate to @node-minify/cssnano or @node-minify/clean-css.");
 	const strict = settings?.options?.strict;
-	return { code: minify.minify(content, strict) };
+	return { code: minify.minify(contentStr, strict) };
 }
 
 //#endregion

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["/*!\n * node-minify\n * Copyright(c) 2011-2025 Rodolphe Stoclin\n * MIT Licensed\n */\n\nimport type { CompressorResult, MinifierOptions } from \"@node-minify/types\";\nimport { warnDeprecation } from \"@node-minify/utils\";\nimport minify from \"sqwish\";\n\n/**\n * Run sqwish.\n * @deprecated sqwish is no longer maintained. Use @node-minify/cssnano or @node-minify/clean-css instead.\n * @param settings - Sqwish options\n * @param content - Content to minify\n * @returns Minified content\n */\nexport async function sqwish({\n    settings,\n    content,\n}: MinifierOptions): Promise<CompressorResult> {\n    warnDeprecation(\n        \"sqwish\",\n        \"sqwish is no longer maintained. \" +\n            \"Please migrate to @node-minify/cssnano or @node-minify/clean-css.\"\n    );\n\n    const strict = settings?.options?.strict as boolean | undefined;\n    const code = minify.minify(content, strict);\n\n    return { code };\n}\n"],"mappings":";;;;;;;;;;;AAiBA,eAAsB,OAAO,EACzB,UACA,WAC2C;AAC3C,iBACI,UACA,oGAEH;CAED,MAAM,SAAS,UAAU,SAAS;AAGlC,QAAO,EAAE,MAFI,OAAO,OAAO,SAAS,OAAO,EAE5B"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["/*!\n * node-minify\n * Copyright(c) 2011-2025 Rodolphe Stoclin\n * MIT Licensed\n */\n\nimport type { CompressorResult, MinifierOptions } from \"@node-minify/types\";\nimport { ensureStringContent, warnDeprecation } from \"@node-minify/utils\";\nimport minify from \"sqwish\";\n\n/**\n * Minify CSS content with the Sqwish minifier and emit a deprecation warning.\n *\n * @deprecated sqwish is no longer maintained. Use @node-minify/cssnano or @node-minify/clean-css instead.\n * @param settings - Minifier options; `settings.options.strict` (if present) controls Sqwish strict mode\n * @param content - Content to minify; will be converted to a string if necessary\n * @returns An object containing the minified code in the `code` property\n */\nexport async function sqwish({\n    settings,\n    content,\n}: MinifierOptions): Promise<CompressorResult> {\n    const contentStr = ensureStringContent(content, \"sqwish\");\n\n    warnDeprecation(\n        \"sqwish\",\n        \"sqwish is no longer maintained. \" +\n            \"Please migrate to @node-minify/cssnano or @node-minify/clean-css.\"\n    );\n\n    const strict = settings?.options?.strict as boolean | undefined;\n\n    const code = minify.minify(contentStr, strict);\n\n    return { code };\n}\n"],"mappings":";;;;;;;;;;;;AAkBA,eAAsB,OAAO,EACzB,UACA,WAC2C;CAC3C,MAAM,aAAa,oBAAoB,SAAS,SAAS;AAEzD,iBACI,UACA,oGAEH;CAED,MAAM,SAAS,UAAU,SAAS;AAIlC,QAAO,EAAE,MAFI,OAAO,OAAO,YAAY,OAAO,EAE/B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@node-minify/sqwish",
-  "version": "10.1.0",
+  "version": "10.2.0",
   "deprecated": "sqwish is no longer maintained. Please use @node-minify/cssnano or @node-minify/clean-css instead.",
   "description": "sqwish plugin for @node-minify (DEPRECATED - use @node-minify/cssnano)",
   "keywords": [
@@ -47,16 +47,16 @@
     "lint": "biome lint .",
     "prepublishOnly": "bun run build",
     "test": "vitest run",
-    "test:ci": "vitest run --coverage",
+    "test:coverage": "vitest run --coverage",
     "test:watch": "vitest",
     "typecheck": "tsc --noEmit",
     "dev": "tsdown src/index.ts --watch"
   },
   "dependencies": {
-    "@node-minify/utils": "workspace:*",
+    "@node-minify/utils": "10.2.0",
     "sqwish": "0.2.2"
   },
   "devDependencies": {
-    "@node-minify/types": "workspace:*"
+    "@node-minify/types": "10.2.0"
   }
 }