vite-plugin-singlefile-compression 1.2.5 → 1.3.0

package/LICENSE.txt

@@ -1,5 +1,5 @@
 The MIT License (MIT)
-Copyright © 2024-2025 bddjr
+Copyright © 2024-present bddjr ; Adapted from https://www.npmjs.com/package/vite-plugin-singlefile
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/README.md

@@ -25,24 +25,6 @@ export default defineConfig({
     // Add singleFileCompression
     singleFileCompression(),
   ],
-
-  // Not required options:
-  esbuild: {
-    // Remove license comments, make file smaller.
-    legalComments: "none"
-  },
-  build: {
-    terserOptions: {
-      format: {
-        // Remove license comments, make file smaller.
-        comments: false
-      }
-    },
-    // Not use old syntax, make file smaller.
-    target: 'esnext',
-    // Disable reporting compressed chunk sizes, slightly improve build speed.
-    reportCompressedSize: false
-  },
 ```
 
 Then modify [src/router/index.ts](test/src/router/index.ts#L5)
@@ -55,47 +37,7 @@ const router = createRouter({
 
 ## Options
 
-```ts
-export interface Options {
-	/**
-	 * 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 Base128 to encode gzipped script.
-	 * If false, use Base64.
-	 * https://www.npmjs.com/package/base128-ascii
-	 * @default true
-	 */
-	useBase128?: boolean;
-}
-```
+See [src/options.ts](src/options.ts)
 
 ## Effect
 
@@ -106,15 +48,15 @@ vite v6.0.7 building for production...
 ✓ 45 modules transformed.
 rendering chunks (1)...
 
-vite-plugin-singlefile-compression 1.2.5 building...
+vite-plugin-singlefile-compression 1.3.0 building...
 
   file:///D:/bddjr/Desktop/code/js/vite-plugin-singlefile-compression/test/dist/index.html
-  101.02 KiB -> 46.52 KiB
+  101.56 KiB -> 46.76 KiB
 
 Finish.
 
-dist/index.html  47.64 kB
-✓ built in 716ms
+dist/index.html  47.88 kB
+✓ built in 677ms
 ```
 
 ## Clone
@@ -131,6 +73,7 @@ npm run build
 
 ## License
 
-[MIT](LICENSE.txt)
+Using [MIT License](LICENSE.txt).  
+[src/template](src/template) using [Unlicense](src/template/LICENSE.txt).
 
 Adapted from [vite-plugin-singlefile](https://www.npmjs.com/package/vite-plugin-singlefile).

package/dist/KiB.d.ts

@@ -0,0 +1 @@
+export declare function KiB(size: number): string;

package/dist/KiB.js

@@ -0,0 +1,3 @@
+export function KiB(size) {
+    return `${Math.ceil(size / 10.24) / 100} KiB`;
+}

package/dist/compress.d.ts

@@ -0,0 +1,3 @@
+import zlib from 'zlib';
+export type compressFormat = "deflate-raw" | "deflate" | "gzip";
+export declare function compress(format: compressFormat, buf: zlib.InputType, useBase128: boolean): string;

package/dist/compress.js

@@ -0,0 +1,24 @@
+import base128 from "base128-ascii";
+import zlib from 'zlib';
+export function compress(format, buf, useBase128) {
+    const options = {
+        level: zlib.constants.Z_BEST_COMPRESSION,
+    };
+    let outBuf;
+    switch (format) {
+        case "deflate":
+            outBuf = zlib.deflateSync(buf, options);
+            break;
+        case "deflate-raw":
+            outBuf = zlib.deflateRawSync(buf, options);
+            break;
+        case "gzip":
+            outBuf = zlib.gzipSync(buf, options);
+            break;
+        default:
+            throw `unknown compress format ${format}`;
+    }
+    return useBase128
+        ? base128.encode(Uint8Array.from(outBuf)).toJSTemplateLiterals()
+        : outBuf.toString('base64');
+}

package/dist/dataurl.d.ts

@@ -0,0 +1 @@
+export declare function bufferToDataURL(name: string, b: Buffer): string;

package/dist/dataurl.js

@@ -0,0 +1,7 @@
+import svgToTinyDataUri from "mini-svg-data-uri";
+import mime from 'mime';
+export function bufferToDataURL(name, b) {
+    return name.endsWith('.svg')
+        ? svgToTinyDataUri(b.toString())
+        : `data:${mime.getType(name)};base64,${b.toString('base64')}`;
+}

package/dist/getTemplate.d.ts

@@ -0,0 +1,4 @@
+export declare const template: {
+    base(script: string, format: string, useBase128: boolean): string;
+    assets(assetsJSON: string): string;
+};

package/dist/getTemplate.js

@@ -0,0 +1,22 @@
+import path from 'path';
+import fs from 'fs';
+const files = {
+    base64: fs.readFileSync(path.join(import.meta.dirname, "template/base64.js")).toString(),
+    base128: fs.readFileSync(path.join(import.meta.dirname, "template/base128.js")).toString(),
+    assets: fs.readFileSync(path.join(import.meta.dirname, "template/assets.js")).toString().split('{"":""}', 2),
+};
+export const template = {
+    base(script, format, useBase128) {
+        if (useBase128) {
+            return files.base128
+                .replace("<format>", format)
+                .split('"<script>"', 2).join(script);
+        }
+        return files.base64
+            .replace("<format>", format)
+            .split("<script>", 2).join(script);
+    },
+    assets(assetsJSON) {
+        return files.assets.join(assetsJSON);
+    },
+};

package/dist/getVersion.d.ts

@@ -0,0 +1 @@
+export declare const version: string;

package/dist/getVersion.js

@@ -0,0 +1,3 @@
+import fs from 'fs';
+import path from 'path';
+export const { version } = JSON.parse(fs.readFileSync(path.join(import.meta.dirname, "../package.json")).toString());

package/dist/index.d.ts

@@ -1,39 +1,4 @@
 import { PluginOption } from "vite";
-import { Options as htmlMinifierOptions } from 'html-minifier-terser';
-export interface Options {
-    /**
-     * 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 Base128 to encode gzipped script.
-     * If false, use Base64.
-     * https://www.npmjs.com/package/base128-ascii
-     * @default true
-     */
-    useBase128?: boolean;
-}
-export declare const defaultHtmlMinifierTerserOptions: htmlMinifierOptions;
+import { Options } from "./options.js";
 export declare function singleFileCompression(opt?: Options): PluginOption;
 export default singleFileCompression;

package/dist/index.js

@@ -1,90 +1,54 @@
-import mime from 'mime';
 import pc from "picocolors";
-import svgToTinyDataUri from "mini-svg-data-uri";
 import { minify as htmlMinify } from 'html-minifier-terser';
-import base128 from "base128-ascii";
-import zlib from 'zlib';
 import path from 'path';
 import fs from 'fs';
 import { pathToFileURL } from "url";
-export const defaultHtmlMinifierTerserOptions = {
-    removeAttributeQuotes: true,
-    removeComments: true,
-    collapseWhitespace: true,
-    removeOptionalTags: true,
-    removeRedundantAttributes: true,
-    minifyJS: false,
-};
+import { version } from './getVersion.js';
+import { template } from './getTemplate.js';
+import { compress } from "./compress.js";
+import { bufferToDataURL } from "./dataurl.js";
+import { KiB } from "./KiB.js";
+import { getInnerOptions } from "./options.js";
 export function singleFileCompression(opt) {
-    opt ||= {};
-    const innerOpt = {
-        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,
-    };
     let conf;
     return {
         name: "singleFileCompression",
         enforce: "post",
         config: setConfig,
         configResolved(c) { conf = c; },
-        generateBundle: (_, bundle) => generateBundle(bundle, conf, innerOpt),
+        generateBundle: (_, bundle) => generateBundle(bundle, conf, getInnerOptions(opt)),
     };
 }
 export default singleFileCompression;
-const template = fs.readFileSync(path.join(import.meta.dirname, "template.js")).toString().split('{<script>}', 2);
-const templateBase128 = fs.readFileSync(path.join(import.meta.dirname, "template-base128.js")).toString().split('"<script>"', 2);
-const templateAssets = fs.readFileSync(path.join(import.meta.dirname, "template-assets.js")).toString().split('{"":""}', 2);
-const { version } = JSON.parse(fs.readFileSync(path.join(import.meta.dirname, "../package.json")).toString());
-function bufferToDataURL(name, b) {
-    return name.endsWith('.svg')
-        ? svgToTinyDataUri(b.toString())
-        : `data:${mime.getType(name)};base64,${b.toString('base64')}`;
-}
-function gzip(buf) {
-    return zlib.gzipSync(buf, {
-        level: zlib.constants.Z_BEST_COMPRESSION,
-    });
-}
-function gzipToBase64(buf) {
-    return gzip(buf).toString('base64');
-}
-function gzipToBase128(buf) {
-    return base128.encode(Uint8Array.from(gzip(buf))).toJSTemplateLiterals();
-}
-function KiB(size) {
-    return `${Math.ceil(size / 10.24) / 100} KiB`;
-}
 function setConfig(config) {
     config.base = './';
     config.build ??= {};
-    config.build.assetsInlineLimit = () => true;
-    config.build.chunkSizeWarningLimit = Infinity;
-    config.build.cssCodeSplit = false;
     config.build.assetsDir = 'assets';
-    config.build.modulePreload = { polyfill: false };
+    config.build.cssCodeSplit = false;
+    config.build.assetsInlineLimit ??= () => true;
+    config.build.chunkSizeWarningLimit ??= Infinity;
+    config.build.modulePreload ??= { polyfill: false };
+    config.build.target ??= 'esnext';
+    config.build.reportCompressedSize ??= false;
     config.build.rollupOptions ??= {};
     config.build.rollupOptions.output ??= {};
+    function setRollupOutput(output) {
+        output.inlineDynamicImports = true;
+        delete output.assetFileNames;
+        delete output.chunkFileNames;
+        delete output.entryFileNames;
+    }
     if (Array.isArray(config.build.rollupOptions.output)) {
         for (const output of config.build.rollupOptions.output) {
-            output.inlineDynamicImports = true;
+            setRollupOutput(output);
         }
     }
     else {
-        config.build.rollupOptions.output.inlineDynamicImports = true;
+        setRollupOutput(config.build.rollupOptions.output);
     }
 }
 async function generateBundle(bundle, config, options) {
     console.log(pc.cyan('\n\nvite-plugin-singlefile-compression ' + version) + pc.green(' building...'));
-    if (config.base !== './')
-        return console.error("error: config.base has been changed!");
-    if (config.build.assetsDir !== 'assets')
-        return console.error("error: config.build.assetsDir has been changed!");
     const distURL = pathToFileURL(path.resolve(config.build.outDir)).href + '/';
     const globalDelete = new Set();
     const globalDoNotDelete = new Set();
@@ -109,9 +73,6 @@ async function generateBundle(bundle, config, options) {
         const thisDel = new Set();
         // Fix async import
         const newJSCode = ["self.__VITE_PRELOAD__=void 0"];
-        newJSCode.toString = function () {
-            return this.join(';');
-        };
         // remove html comments
         newHtml = newHtml.replaceAll(/<!--[\d\D]*?-->/g, '');
         // get css tag
@@ -227,7 +188,7 @@ async function generateBundle(bundle, config, options) {
                 // add script for load html assets
                 const assetsJSON = JSON.stringify(assetsDataURL);
                 if (assetsJSON != '{}')
-                    newJSCode.push(templateAssets.join(assetsJSON));
+                    newJSCode.push(template.assets(assetsJSON));
             }
             // add script
             newJSCode.push(js.code.replace(/;?\n?$/, ''));
@@ -240,9 +201,8 @@ async function generateBundle(bundle, config, options) {
         if (options.htmlMinifierTerser)
             newHtml = await htmlMinify(newHtml, options.htmlMinifierTerser);
         // fill script
-        newHtml = newHtml.split('self.__vitePluginSinglefileCompression=1', 2).join(options.useBase128
-            ? templateBase128.join(gzipToBase128(newJSCode.toString()))
-            : template.join(gzipToBase64(newJSCode.toString())));
+        const compressedScript = compress(options.compressFormat, newJSCode.join(';'), options.useBase128);
+        newHtml = newHtml.split('self.__vitePluginSinglefileCompression=1', 2).join(template.base(compressedScript, options.compressFormat, options.useBase128));
         // finish
         htmlChunk.source = newHtml;
         console.log("\n"

package/dist/options.d.ts

@@ -0,0 +1,52 @@
+import { Options as htmlMinifierOptions } from 'html-minifier-terser';
+import { compressFormat } from './compress.js';
+export interface Options {
+    /**
+     * 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 Base128 to encode gzipped script.
+     * If false, use Base64.
+     * https://www.npmjs.com/package/base128-ascii
+     * @default true
+     */
+    useBase128?: boolean;
+    /**
+     * Compress format.
+     * @default "deflate-raw"
+     */
+    compressFormat?: compressFormat;
+}
+export declare const defaultHtmlMinifierTerserOptions: htmlMinifierOptions;
+export interface innerOptions {
+    htmlMinifierTerser: htmlMinifierOptions | false;
+    tryInlineHtmlAssets: boolean;
+    removeInlinedAssetFiles: boolean;
+    tryInlineHtmlPublicIcon: boolean;
+    removeInlinedPublicIconFiles: boolean;
+    useBase128: boolean;
+    compressFormat: "deflate-raw" | "deflate" | "gzip";
+}
+export declare function getInnerOptions(opt?: Options): innerOptions;

package/dist/options.js

@@ -0,0 +1,24 @@
+export const defaultHtmlMinifierTerserOptions = {
+    removeAttributeQuotes: true,
+    removeComments: true,
+    collapseWhitespace: true,
+    removeOptionalTags: true,
+    removeRedundantAttributes: true,
+    minifyJS: false,
+};
+export function getInnerOptions(opt) {
+    opt ||= {};
+    return {
+        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: ["deflate-raw", "deflate", "gzip"].includes(opt.compressFormat)
+            ? opt.compressFormat
+            : "deflate-raw",
+    };
+}

package/dist/template/LICENSE.txt

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org/>

package/dist/{template-base128.js → template/base128.js}

@@ -1 +1 @@
-function s(e){let l=0,o=0,n,r=()=>n=e.charCodeAt(l++),t=new Uint8Array(Math.floor(e.length/8*7));for(;l<e.length;)t[o++]=r()<<1|r()>>6,t[o++]=n<<2|r()>>5,t[o++]=n<<3|r()>>4,t[o++]=n<<4|r()>>3,t[o++]=n<<5|r()>>2,t[o++]=n<<6|r()>>1,t[o++]=n<<7|r();return t}new Response(new ReadableStream({start(e){e.enqueue(s("<script>")),e.close()}}).pipeThrough(new DecompressionStream("gzip")),{headers:{"Content-Type":"text/javascript"}}).blob().then(e=>import(e=URL.createObjectURL(e)).finally(()=>URL.revokeObjectURL(e)))
+function s(e){let l=0,o=0,n,r=()=>n=e.charCodeAt(l++),t=new Uint8Array(Math.floor(e.length/8*7));for(;l<e.length;)t[o++]=r()<<1|r()>>6,t[o++]=n<<2|r()>>5,t[o++]=n<<3|r()>>4,t[o++]=n<<4|r()>>3,t[o++]=n<<5|r()>>2,t[o++]=n<<6|r()>>1,t[o++]=n<<7|r();return t}new Response(new ReadableStream({start(e){e.enqueue(s("<script>")),e.close()}}).pipeThrough(new DecompressionStream("<format>")),{headers:{"Content-Type":"text/javascript"}}).blob().then(e=>import(e=URL.createObjectURL(e)).finally(()=>URL.revokeObjectURL(e)))

package/dist/template/base64.js

@@ -0,0 +1 @@
+fetch("data:;base64,<script>").then(e=>new Response(e.body.pipeThrough(new DecompressionStream("<format>")),{headers:{"Content-Type":"text/javascript"}}).blob()).then(e=>import(e=URL.createObjectURL(e)).finally(()=>URL.revokeObjectURL(e)))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-singlefile-compression",
-  "version": "1.2.5",
+  "version": "1.3.0",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "files": [
@@ -42,7 +42,7 @@
   "dependencies": {
     "@types/html-minifier-terser": "^7.0.2",
     "@types/node": "^22.9.3",
-    "base128-ascii": "^2.0.2",
+    "base128-ascii": "^2.0.3",
     "esbuild": "^0.24.0",
     "html-minifier-terser": "^7.2.0",
     "mime": "^4.0.4",

package/dist/template.js

@@ -1 +0,0 @@
-fetch("data:application/gzip;base64,{<script>}").then(e=>new Response(e.body.pipeThrough(new DecompressionStream("gzip")),{headers:{"Content-Type":"text/javascript"}}).blob()).then(e=>import(e=URL.createObjectURL(e)).finally(()=>URL.revokeObjectURL(e)))