vite-plugin-singlefile-compression 2.1.2 → 2.2.1

package/README.md

@@ -11,7 +11,7 @@ Preview: https://bddjr.github.io/vite-plugin-singlefile-compression/
 ## Setup
 
 ```
-npm i vite-plugin-singlefile-compression@latest -D
+npm i -D vite-plugin-singlefile-compression@latest
 ```
 
 Then modify `vite.config.ts`, like [test/vite.config.ts](test/vite.config.ts)
@@ -45,103 +45,128 @@ singleFileCompression({
 }),
 ```
 
-More options see [src/options.ts](src/options.ts)
+### rename
+
+Rename index.html
+
+type: `string`
+
+### enableCompress
+
+Enable compress.
+
+default: `true`
+
+type: `boolean`
+
+### useBase128
+
+Use Base128 to encode compressed script.  
+If false, use Base64.  
+https://www.npmjs.com/package/base128-ascii
+
+default: `true`
+
+type: `boolean`
+
+### compressFormat
+
+Compress format.
+
+https://developer.mozilla.org/en-US/docs/Web/API/DecompressionStream/DecompressionStream
+
+default: `"deflate-raw"`
+
+type:
+ - `"deflate-raw"`
+ - `"deflate"`
+ - `"gzip"`
+ - `"brotli"`
+ - `"zstd"`
+ - `"deflateRaw"`
+ - `"gz"`
+ - `"br"`
+ - `"brotliCompress"`
+ - `"zstandard"`
+ - `"zst"`
+
+### compressor
+
+Custom compressor.
+
+type: `(buf: zlib.InputType) => (Buffer | Uint8Array | Promise<Buffer | Uint8Array>)`
+
+### htmlMinifierTerser
+
+https://github.com/terser/html-minifier-terser?tab=readme-ov-file#options-quick-reference
+
+default: `defaultHtmlMinifierTerserOptions`
+
+type:
+ - `HtmlMinifierOptions`
+ - `boolean`
+
+### tryInlineHtmlAssets
+
+Try inline html used assets, if inlined or not used in JS.
+
+default: `true`
+
+type: `boolean`
+
+### removeInlinedAssetFiles
+
+Remove inlined asset files.
+
+default: `true`
+
+type: `boolean`
+
+### tryInlineHtmlPublicIcon
+
+Try inline html icon, if icon is in public dir.
+
+default: `true`
+
+type: `boolean`
+
+### removeInlinedPublicIconFiles
+
+Remove inlined html icon files.
+
+default: `true`
+
+type: `boolean`
+
+### useImportMetaPolyfill
+
+Use import.meta polyfill.
+
+default: `true`
+
+type: `boolean`
 
-```ts
-export interface Options {
-    /**
-     * Enable compress.
-     * @default true
-     */
-    enableCompress?: boolean
-
-    /**
-     * Use Base128 to encode compressed script.
-     * If false, use Base64.
-     * https://www.npmjs.com/package/base128-ascii
-     * @default true
-     */
-    useBase128?: boolean
-
-    /**
-     * Compress format.
-     * 
-     * https://developer.mozilla.org/en-US/docs/Web/API/DecompressionStream/DecompressionStream
-     * 
-     * @type {"deflate-raw" | "deflate" | "gzip" | "brotli" | "zstd" | "deflateRaw" | "gz" | "br" | "brotliCompress" | "zstandard" | "zst"}
-     * 
-     * @default "deflate-raw"
-     */
-    compressFormat?: CompressFormat | CompressFormatAlias
-
-    /**
-     * Custom compressor.
-     */
-    compressor?: Compressor
-
-    /**
-     * Rename index.html
-     */
-    rename?: string
-
-    /**
-     * https://github.com/terser/html-minifier-terser?tab=readme-ov-file#options-quick-reference
-     * @default defaultHtmlMinifierTerserOptions
-     */
-    htmlMinifierTerser?: HtmlMinifierOptions | boolean
-
-    /**
-     * Try inline html used assets, if inlined or not used in JS.
-     * @default true
-     */
-    tryInlineHtmlAssets?: boolean
-
-    /**
-     * Remove inlined asset files.
-     * @default true
-     */
-    removeInlinedAssetFiles?: boolean
-
-    /**
-     * Try inline html icon, if icon is in public dir.
-     * @default true
-     */
-    tryInlineHtmlPublicIcon?: boolean
-
-    /**
-     * Remove inlined html icon files.
-     * @default true
-     */
-    removeInlinedPublicIconFiles?: boolean
-
-    /**
-     * Use import.meta polyfill.
-     * @default true
-     */
-    useImportMetaPolyfill?: boolean
-}
-```
 
 ## Effect
 
 Preview: https://bddjr.github.io/vite-plugin-singlefile-compression/
 
 ```
-vite v8.0.1 building client environment for production...
+vite v8.0.3 building client environment for production...
 ✓ 42 modules transformed.
 rendering chunks (1)...
 
-vite-plugin-singlefile-compression 2.1.2 deflate-raw base128-ascii
+vite-plugin-singlefile-compression 2.2.1 deflate-raw base128-ascii
 
   file:///D:/code/js/vite-plugin-singlefile-compression/test/dist/index.html
-  123.867 kB -> 50.297 kB
+  122.739 kB -> 50.220 kB
 
 Finish.
 
 computing gzip size...
-dist/index.html  50.29 kB │ gzip: 43.81 kB
+dist/index.html  50.22 kB │ gzip: 43.77 kB
 
-✓ built in 318ms
+✓ built in 461ms
 ```
 
 ## Clone
@@ -153,5 +178,5 @@ npm i
 cd test
 npm i
 cd ..
-node --run build
+npm run build
 ```

package/dist/index.d.ts

@@ -18,12 +18,16 @@ declare const compressFormatAlias: Readonly<{
   zstandard: "zstd";
   zst: "zstd";
 }>;
-type Compressor = ((buf: zlib.InputType) => (Buffer | Uint8Array));
-type CompressFormat = keyof typeof compressors;
+type Compressor = ((buf: zlib.InputType) => (Buffer | Uint8Array | Promise<Buffer | Uint8Array>));
+type CompressFormat = keyof typeof compressors | CompressionFormat;
 type CompressFormatAlias = keyof typeof compressFormatAlias;
 //#endregion
 //#region _dist/options.d.ts
 interface Options {
+  /**
+   * Rename index.html
+   */
+  rename?: string;
   /**
    * Enable compress.
    * @default true
@@ -50,10 +54,6 @@ interface Options {
    * Custom compressor.
    */
   compressor?: Compressor;
-  /**
-   * Rename index.html
-   */
-  rename?: string;
   /**
    * https://github.com/terser/html-minifier-terser?tab=readme-ov-file#options-quick-reference
    * @default defaultHtmlMinifierTerserOptions

package/dist/index.js

@@ -9,7 +9,7 @@ import zlib from "zlib";
 import svgToTinyDataUri from "mini-svg-data-uri";
 import mime from "mime";
 //#region _dist/getVersion.js
-var version = "2.1.2";
+var version = "2.2.1";
 //#endregion
 //#region _dist/compress.js
 const compressors = {
@@ -46,11 +46,18 @@ function switchCompressor(format) {
 			if (typeof f == "function") return f;
 		}
 	}
+	try {
+		const cs = new CompressionStream(format);
+		return (buf) => new Response(new ReadableStream({ start(controller) {
+			controller.enqueue(buf);
+			controller.close();
+		} }).pipeThrough(cs)).bytes();
+	} catch {}
 	throw Error(`Could not get compressor: Unknown compress format '${format}', please set your compressor function.`);
 }
-function compress(format, buf, useBase128, compressor) {
+async function compress(format, buf, useBase128, compressor) {
 	if (typeof compressor != "function") compressor = switchCompressor(format);
-	const outBuf = compressor(buf);
+	const outBuf = await compressor(buf);
 	if (useBase128) return base128.encode(outBuf).toJSTemplateLiterals();
 	if (Buffer.isBuffer(outBuf)) return outBuf.toString("base64");
 	if (typeof outBuf.toBase64 == "function") return outBuf.toBase64();
@@ -82,8 +89,8 @@ const files = {
 	importmeta: split2(raw.importmeta, "\"<path>\"")
 };
 const template = {
-	base(script, format, useBase128, compressor) {
-		script = compress(format, script, useBase128, compressor);
+	async base(script, format, useBase128, compressor) {
+		script = await compress(format, script, useBase128, compressor);
 		if (useBase128) return files.base128.replace("<format>", format).split("\"<script>\"", 2).join(script);
 		return files.base64.replace("<format>", format).split("<script>", 2).join(script);
 	},
@@ -124,16 +131,16 @@ const defaultHtmlMinifierTerserOptions = {
 function getInnerOptions(opt) {
 	opt ||= {};
 	return {
-		enableCompress: opt.enableCompress ?? true,
 		rename: opt.rename == null ? void 0 : String(opt.rename),
+		enableCompress: opt.enableCompress ?? true,
+		useBase128: opt.useBase128 ?? true,
+		compressFormat: opt.compressFormat ? compressFormatAlias.hasOwnProperty(opt.compressFormat) ? compressFormatAlias[opt.compressFormat] : String(opt.compressFormat) : "deflate-raw",
+		compressor: typeof opt.compressor == "function" ? opt.compressor : void 0,
 		htmlMinifierTerser: opt.htmlMinifierTerser == null || opt.htmlMinifierTerser === true ? defaultHtmlMinifierTerserOptions : opt.htmlMinifierTerser,
 		tryInlineHtmlAssets: opt.tryInlineHtmlAssets ?? true,
 		removeInlinedAssetFiles: opt.removeInlinedAssetFiles ?? true,
 		tryInlineHtmlPublicIcon: opt.tryInlineHtmlPublicIcon ?? true,
 		removeInlinedPublicIconFiles: opt.removeInlinedPublicIconFiles ?? true,
-		useBase128: opt.useBase128 ?? true,
-		compressFormat: opt.compressFormat ? compressFormatAlias.hasOwnProperty(opt.compressFormat) ? compressFormatAlias[opt.compressFormat] : String(opt.compressFormat) : "deflate-raw",
-		compressor: typeof opt.compressor == "function" ? opt.compressor : void 0,
 		useImportMetaPolyfill: opt.useImportMetaPolyfill ?? true
 	};
 }
@@ -148,7 +155,7 @@ function singleFileCompression(opt) {
 	let conf;
 	const innerOptions = getInnerOptions(opt);
 	return {
-		name: "singleFileCompression",
+		name: "vite-plugin-singlefile-compression",
 		enforce: "post",
 		config(...args) {
 			return setConfig.call(this, innerOptions, ...args);
@@ -156,8 +163,8 @@ function singleFileCompression(opt) {
 		configResolved(c) {
 			conf = c;
 		},
-		generateBundle(outputOptions, bundle) {
-			return generateBundle(bundle, conf, innerOptions);
+		generateBundle(outputOptions, bundle, isWrite) {
+			return generateBundle.call(this, bundle, conf, innerOptions);
 		}
 	};
 }
@@ -298,7 +305,7 @@ async function generateBundle(bundle, config, options) {
 			newJSCode.push(code);
 		} else inlineHtmlAssets();
 		let outputScript = newJSCode.join(";");
-		if (options.enableCompress) outputScript = template.base(outputScript, options.compressFormat, options.useBase128, options.compressor);
+		if (options.enableCompress) outputScript = await template.base(outputScript, options.compressFormat, options.useBase128, options.compressor);
 		else outputScript = outputScript.replaceAll("<\/script", "<\\/script");
 		htmlChunk.source = htmlChunk.source.split(fakeScript, 2).join(outputScript);
 		console.log("  " + pc.gray(kB(oldSize) + " -> ") + pc.cyanBright(kB(htmlChunk.source.length)) + "\n");
@@ -308,7 +315,7 @@ async function generateBundle(bundle, config, options) {
 		for (const name of globalDelete) if (!globalDoNotDelete.has(name)) delete bundle[name];
 	}
 	if (options.removeInlinedPublicIconFiles) for (const name of globalRemoveDistFileNames) try {
-		fs.unlinkSync(path.join(config.build.outDir, name));
+		fs.rmSync(path.join(config.build.outDir, name), { force: true });
 	} catch (e) {
 		console.error(e);
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-singlefile-compression",
-  "version": "2.1.2",
+  "version": "2.2.1",
   "author": "bddjr",
   "license": "MIT",
   "description": "Compress all assets and embeds them into dist/index.html, making it convenient to share as a single HTML file.",
@@ -31,10 +31,33 @@
     "single",
     "compression",
     "compress",
+    "compressionstream",
+    "decompres",
+    "decompression",
+    "decompressionstream",
+    "compression streams api",
+    "compression streams",
     "gzip",
+    "deflate",
+    "deflate-raw",
+    "deflateraw",
+    "br",
+    "brotli",
+    "zstd",
+    "zlib",
     "inline",
+    "embed",
+    "bundle",
+    "bundler",
     "frontend",
     "front-end",
+    "framework",
+    "hmr",
+    "dev-server",
+    "build-tool",
+    "html",
+    "htm",
+    "htmlmin",
     "js",
     "javascript",
     "css",
@@ -42,12 +65,22 @@
     "rolldown",
     "rolldown-vite",
     "rollup",
+    "min",
+    "minification",
+    "minifier",
+    "minify",
+    "optimize",
+    "optimizer",
+    "pack",
+    "packer",
     "vite-plugin-singlefile",
     "vite-plugin-compression",
-    "vite-plugin-compression2"
+    "vite-plugin-compression2",
+    "html-minifier-terser"
   ],
   "dependencies": {
     "@types/html-minifier-terser": ">=7.0.2",
+    "@types/node": "*",
     "base128-ascii": ">=2.1.11",
     "html-minifier-terser": ">=7.2.0",
     "jsdom": ">=28.1.0",
@@ -57,14 +90,14 @@
     "vite": ">=3.0.0"
   },
   "devDependencies": {
+    "@bddjr/rimraf": "^0.1.0",
     "@types/jsdom": ">=28.0.0",
     "@types/node": "^22.19.15",
     "esbuild": "^0.27.4",
-    "marked": "^17.0.4",
-    "rimraf": ">=6.1.3",
     "rolldown": ">=1.0.0-rc.9",
     "rolldown-plugin-dts": "^0.22.5",
     "rollup": ">=4.59.0",
-    "typescript": ">=5.9.3"
+    "typescript": ">=5.9.3",
+    "vite": ">=8.0.0"
   }
-}
+}