vite-plugin-singlefile-compression 2.3.3 → 2.4.0

package/README.md

@@ -6,7 +6,7 @@ The recipient can open it directly in the browser without manually unzipping the
 
 Using [DecompressionStream](https://developer.mozilla.org/en-US/docs/Web/API/DecompressionStream) + [base128-ascii](https://www.npmjs.com/package/base128-ascii).
 
-Preview: https://bddjr.github.io/vite-plugin-singlefile-compression/
+Preview: https://bddjr.github.io/vite-plugin-singlefile-compression/#/
 
 ## Setup
 
@@ -65,6 +65,8 @@ Use Base128 to encode compressed script.
 If false, use Base64.  
 https://www.npmjs.com/package/base128-ascii
 
+This option is only valid when the `enableCompress` option is set to true.
+
 default: `true`
 
 type: `boolean`
@@ -75,6 +77,8 @@ Compress format.
 
 https://developer.mozilla.org/en-US/docs/Web/API/DecompressionStream/DecompressionStream
 
+This option is only valid when the `enableCompress` option is set to true.
+
 default: `"deflate-raw"`
 
 type:
@@ -94,6 +98,8 @@ type:
 
 Custom compressor.
 
+This option is only valid when the `enableCompress` option is set to true.
+
 type: `(buf: zlib.InputType) => (Buffer | Uint8Array | Promise<Buffer | Uint8Array>)`
 
 ### htmlMinifierTerser
@@ -124,7 +130,7 @@ type: `boolean`
 
 ### tryInlineHtmlPublicIcon
 
-Try inline html icon, if icon is in public dir.
+Try inline html favicon, if icon is in public dir.
 
 default: `true`
 
@@ -132,12 +138,24 @@ type: `boolean`
 
 ### removeInlinedPublicIconFiles
 
-Remove inlined html icon files.
+Remove inlined html favicon files.
 
 default: `true`
 
 type: `boolean`
 
+### enableCompressInlinedIcon
+
+Enable compress inlined html favicon.
+
+This option is only valid when the `enableCompress` option is set to true.
+
+⚠️ Not works on Safari (See [#20](https://github.com/bddjr/vite-plugin-singlefile-compression/issues/20))
+
+default: `false`
+
+type: `boolean`
+
 ### useImportMetaPolyfill
 
 Use import.meta polyfill.
@@ -149,24 +167,24 @@ type: `boolean`
 
 ## Effect
 
-Preview: https://bddjr.github.io/vite-plugin-singlefile-compression/
+Preview: https://bddjr.github.io/vite-plugin-singlefile-compression/#/
 
 ```
 vite v8.0.8 building client environment for production...
 ✓ 43 modules transformed.
 rendering chunks (1)...
 
-vite-plugin-singlefile-compression 2.3.3 deflate-raw base128-ascii
+vite-plugin-singlefile-compression 2.4.0 deflate-raw base128-ascii
 
   file:///D:/code/js/vite-plugin-singlefile-compression/test/dist/index.html
-  125.847 kB -> 51.312 kB
+  126.497 kB -> 59.589 kB
 
 Finish.
 
 computing gzip size...
-dist/index.html  51.31 kB │ gzip: 44.73 kB
+dist/index.html  59.58 kB │ gzip: 44.90 kB
 
-✓ built in 285ms
+✓ built in 293ms
 ```
 
 ## Clone

package/dist/index.d.ts

@@ -37,6 +37,9 @@ interface Options {
    * Use Base128 to encode compressed script.
    * If false, use Base64.
    * https://www.npmjs.com/package/base128-ascii
+   *
+   * This option is only valid when the `enableCompress` option is set to true.
+   *
    * @default true
    */
   useBase128?: boolean;
@@ -45,6 +48,8 @@ interface Options {
    *
    * https://developer.mozilla.org/en-US/docs/Web/API/DecompressionStream/DecompressionStream
    *
+   * This option is only valid when the `enableCompress` option is set to true.
+   *
    * @type {"deflate-raw" | "deflate" | "gzip" | "brotli" | "zstd" | "deflateRaw" | "gz" | "br" | "brotliCompress" | "zstandard" | "zst"}
    *
    * @default "deflate-raw"
@@ -52,6 +57,8 @@ interface Options {
   compressFormat?: CompressFormat | CompressFormatAlias;
   /**
    * Custom compressor.
+   *
+   * This option is only valid when the `enableCompress` option is set to true.
    */
   compressor?: Compressor;
   /**
@@ -70,15 +77,25 @@ interface Options {
    */
   removeInlinedAssetFiles?: boolean;
   /**
-   * Try inline html icon, if icon is in public dir.
+   * Try inline html favicon, if icon is in public dir.
    * @default true
    */
   tryInlineHtmlPublicIcon?: boolean;
   /**
-   * Remove inlined html icon files.
+   * Remove inlined html favicon files.
    * @default true
    */
   removeInlinedPublicIconFiles?: boolean;
+  /**
+   * Enable compress inlined html favicon.
+   *
+   * This option is only valid when the `enableCompress` option is set to true.
+   *
+   * ⚠️ Not works on Safari (See [#20](https://github.com/bddjr/vite-plugin-singlefile-compression/issues/20))
+   *
+   * @default false
+   */
+  enableCompressInlinedIcon?: boolean;
   /**
    * Use import.meta polyfill.
    * @default false

package/dist/index.js

@@ -9,7 +9,7 @@ import zlib from "zlib";
 import svgToTinyDataUri from "mini-svg-data-uri";
 import { lookup } from "mrmime";
 //#region package.json
-var version = "2.3.3";
+var version = "2.4.0";
 //#endregion
 //#region src/compress.ts
 const compressors = {
@@ -127,9 +127,10 @@ const defaultHtmlMinifierTerserOptions = {
 };
 function getInnerOptions(opt) {
 	opt ||= {};
+	const enableCompress = opt.enableCompress ?? true;
 	return {
 		rename: opt.rename == null ? void 0 : String(opt.rename),
-		enableCompress: opt.enableCompress ?? true,
+		enableCompress,
 		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,
@@ -138,6 +139,7 @@ function getInnerOptions(opt) {
 		removeInlinedAssetFiles: opt.removeInlinedAssetFiles ?? true,
 		tryInlineHtmlPublicIcon: opt.tryInlineHtmlPublicIcon ?? true,
 		removeInlinedPublicIconFiles: opt.removeInlinedPublicIconFiles ?? true,
+		enableCompressInlinedIcon: enableCompress && (opt.enableCompressInlinedIcon ?? false),
 		useImportMetaPolyfill: opt.useImportMetaPolyfill ?? false
 	};
 }
@@ -243,44 +245,62 @@ async function generateBundle(bundle, config, options) {
 			}
 			if (options.enableCompress) element.src = `data:${name}`;
 		}
-		if (options.tryInlineHtmlPublicIcon) {
-			let needInline = true;
-			let iconName = "favicon.ico";
-			const element = document.querySelector(`link[rel=icon][href^="${config.base}"], link[rel="shortcut icon"][href^="${config.base}"]`);
-			if (element) {
-				iconName = cutPrefix(element.href, config.base);
-				if (bundleAssetsNames.includes(iconName)) needInline = false;
-				else {
-					element.rel = "icon";
-					element.href = "data:";
-				}
+		let linkFavicon = document.querySelector(`link[rel=icon][href^="${config.base}"]`);
+		{
+			const link_shortcut_icon = document.querySelector(`link[rel="shortcut icon"][href^="${config.base}"]`);
+			if (link_shortcut_icon) if (linkFavicon) link_shortcut_icon.remove();
+			else {
+				link_shortcut_icon.rel = "icon";
+				linkFavicon = link_shortcut_icon;
 			}
-			if (needInline) try {
-				if (!Object.prototype.hasOwnProperty.call(globalPublicFilesCache, iconName)) {
-					let Path = path.join(config.build.outDir, iconName);
-					if (fs.existsSync(Path)) globalRemoveDistFileNames.add(iconName);
-					else Path = path.join(config.publicDir, iconName);
-					const b = fs.readFileSync(Path);
-					globalPublicFilesCache[iconName] = {
-						dataURL: bufferToDataURL(iconName, b),
-						size: b.length
-					};
-				}
-				const { dataURL, size } = globalPublicFilesCache[iconName];
-				oldSize += size;
-				if (options.enableCompress) {
-					newJSCode.push(template.icon(dataURL));
-					if (!element) document.head.insertAdjacentHTML("beforeend", "<link rel=\"icon\" href=\"data:\">");
-				} else if (element) element.href = dataURL;
-				else {
-					const e = document.head.appendChild(document.createElement("link"));
-					e.rel = "icon";
-					e.href = dataURL;
-				}
-			} catch (e) {
-				if (element) console.error(e);
+		}
+		let faviconName = "favicon.ico";
+		let faviconIsDataURL = false;
+		if (linkFavicon) {
+			faviconName = linkFavicon.href;
+			faviconIsDataURL = /^data:/i.test(faviconName);
+			if (!faviconIsDataURL) faviconName = cutPrefix(faviconName, config.base);
+		}
+		function setFaviconDataURL(dataURL) {
+			if (options.enableCompressInlinedIcon) {
+				newJSCode.push(template.icon(dataURL));
+				if (linkFavicon) linkFavicon.href = "data:";
+				else document.head.insertAdjacentHTML("beforeend", "<link rel=\"icon\" href=\"data:\">");
+			} else if (linkFavicon) linkFavicon.href = dataURL;
+			else {
+				const e = document.head.appendChild(document.createElement("link"));
+				e.rel = "icon";
+				e.href = dataURL;
 			}
 		}
+		if (faviconIsDataURL) {
+			if (options.enableCompressInlinedIcon) {
+				newJSCode.push(template.icon(faviconName));
+				linkFavicon.href = "data:";
+			}
+		} else if (bundleAssetsNames.includes(faviconName)) {
+			const asset = bundle[faviconName];
+			if (asset) {
+				setFaviconDataURL(bufferToDataURL(faviconName, Buffer.from(asset.source)));
+				thisDel.add(faviconName);
+			}
+		} else if (options.tryInlineHtmlPublicIcon) try {
+			if (!Object.prototype.hasOwnProperty.call(globalPublicFilesCache, faviconName)) {
+				let Path = path.join(config.build.outDir, faviconName);
+				if (fs.existsSync(Path)) globalRemoveDistFileNames.add(faviconName);
+				else Path = path.join(config.publicDir, faviconName);
+				const b = fs.readFileSync(Path);
+				globalPublicFilesCache[faviconName] = {
+					dataURL: bufferToDataURL(faviconName, b),
+					size: b.length
+				};
+			}
+			const { dataURL, size } = globalPublicFilesCache[faviconName];
+			oldSize += size;
+			setFaviconDataURL(dataURL);
+		} catch (e) {
+			if (linkFavicon) console.error(e);
+		}
 		htmlChunk.source = dom.serialize();
 		if (options.htmlMinifierTerser) htmlChunk.source = await minify(htmlChunk.source, options.htmlMinifierTerser);
 		function inlineHtmlAssets() {
@@ -296,10 +316,7 @@ async function generateBundle(bundle, config, options) {
 			code = code.replace(/;?\n?$/, "");
 			for (const name of bundleAssetsNames) {
 				const assetName = name.slice(assetsDir.length);
-				if (code.includes(assetName)) {
-					globalDoNotDelete.add(name);
-					delete assetsDataURL[assetName];
-				}
+				if (code.includes(assetName)) globalDoNotDelete.add(name);
 			}
 			inlineHtmlAssets();
 			if (options.useImportMetaPolyfill) newJSCode.push(template.importmeta(scriptName));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-singlefile-compression",
-  "version": "2.3.3",
+  "version": "2.4.0",
   "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.",
@@ -14,7 +14,7 @@
     "build": "tsc && node build.js && tsc _dist/templateRaw.ts --ignoreConfig --noEmit && cd test && node --run build",
     "prepublishOnly": "node --run build"
   },
-  "homepage": "https://bddjr.github.io/vite-plugin-singlefile-compression/",
+  "homepage": "https://bddjr.github.io/vite-plugin-singlefile-compression/#/",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/bddjr/vite-plugin-singlefile-compression.git"
@@ -90,7 +90,7 @@
   },
   "dependencies": {
     "@types/html-minifier-terser": ">=7.0.2",
-    "base128-ascii": ">=4.0.1",
+    "base128-ascii": ">=5.0.0",
     "html-minifier-terser": ">=7.2.0",
     "jsdom": ">=29.0.2",
     "mini-svg-data-uri": ">=1.4.4",