base128-ascii 2.1.12 → 3.0.0

package/README.md

@@ -1,6 +1,6 @@
 Smaller than base64, only use ASCII, can run in web browser.
 
-The project was born for [vite-plugin-singlefile-compression](https://github.com/bddjr/vite-plugin-singlefile-compression).
+Build for [vite-plugin-singlefile-compression](https://github.com/bddjr/vite-plugin-singlefile-compression)
 
 ## Setup
 
@@ -12,21 +12,13 @@ npm i base128-ascii
 
 ```js
 import base128 from "base128-ascii"
-import fs from 'fs'
+import fs from "fs"
 
 const encodedTemplate = base128.encode(fs.readFileSync("example.gz")).toJSTemplateLiterals()
 
 const decoded = base128.decode(eval(encodedTemplate))
 ```
 
-### Browser
-
-```html browser
-<script>
-{class EncodeOutput{constructor(t){this.uint8Array=t}toString(){return(new TextDecoder).decode(this.uint8Array)}toJSTemplateLiterals(){return`\`${this.toString().replace(/[\r\\`]|\${|<\/script/g,t=>"\r"==t?"\\r":"<\/script"==t?"<\\/script":"\\"+t)}\``}}this.base128={EncodeOutput,encode(t){"string"==typeof t&&(t=(new TextEncoder).encode(t));for(var e=t.length,r=new Uint8Array(Math.ceil(e/7*8)),n=0,c=0;n<e;)r[c++]=t[n]>>1&127,r[c++]=127&(t[n++]<<6|t[n]>>2),r[c++]=127&(t[n++]<<5|t[n]>>3),r[c++]=127&(t[n++]<<4|t[n]>>4),r[c++]=127&(t[n++]<<3|t[n]>>5),r[c++]=127&(t[n++]<<2|t[n]>>6),r[c++]=127&(t[n++]<<1|t[n]>>7),r[c++]=127&t[n++];return new EncodeOutput(r)},decode(t){for(var e,r=t.length,n=new Uint8Array(r/8*7),c=0,o=0,i=()=>(e=t.charCodeAt(c++))>127?e=0:e;c<r;)n[o++]=i()<<1|i()>>6,n[o++]=e<<2|i()>>5,n[o++]=e<<3|i()>>4,n[o++]=e<<4|i()>>3,n[o++]=e<<5|i()>>2,n[o++]=e<<6|i()>>1,n[o++]=e<<7|i();return n}}}
-</script>
-```
-
 ---
 
 ## Effect
@@ -37,14 +29,10 @@ Encode this jpg file, use base128 is `109.85 KiB` smaller than base64:
 screenshot-45.519.jpg
 file length: 682086
 
-encode:
-bytes length: 796961
-eval length: 779527
-decoded length: 682086
+base128:
+toJSTemplateLiterals length: 796961
 equal: true
 
 base64:
-length: 909448
+encoded length: 909448
 ```
-
-![img](img.jpg)

package/main.d.ts

@@ -0,0 +1,18 @@
+export declare class Base128Bytes extends Uint8Array {
+    /**
+     * Returns a base128 string.
+     */
+    toString(): string;
+    /**
+     * Returns a base128 [Template literals](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Template_literals).
+     */
+    toJSTemplateLiterals(): string;
+}
+export declare function encode(input: Uint8Array | string): Base128Bytes;
+export declare function decode(input: string): Uint8Array;
+declare const base128: {
+    Base128Bytes: typeof Base128Bytes;
+    encode: typeof encode;
+    decode: typeof decode;
+};
+export default base128;

package/{src/module.mjs → main.js}

@@ -1,18 +1,12 @@
 //@ts-nocheck
 
-export class EncodeOutput {
-    /**
-     * @param {Uint8Array} out
-     */
-    constructor(out) {
-        this.uint8Array = out
-    }
+export class Base128Bytes extends Uint8Array {
     toString() {
-        return new TextDecoder().decode(this.uint8Array)
+        return new TextDecoder().decode(this)
     }
     toJSTemplateLiterals() {
         return `\`${this.toString().replace(
-            /[\r\\`]|\${|<\/script/g,
+            /[\r\\`]|\$\{|<\/script/g,
             (match) => (
                 match == '\r'
                     ? '\\r'
@@ -31,7 +25,7 @@ export function encode(input) {
     if (typeof input == 'string')
         input = new TextEncoder().encode(input)
     var il = input.length
-        , out = new Uint8Array(Math.ceil(il / 7 * 8))
+        , out = new Base128Bytes(Math.ceil(il / 7 * 8))
         , ii = 0
         , oi = 0
     while (ii < il) {
@@ -48,7 +42,7 @@ export function encode(input) {
         /* 6 */ out[oi++] = (input[ii++] << 1 | input[ii] >> 7) & 127
         /* 7 */ out[oi++] = input[ii++] & 127
     }
-    return new EncodeOutput(out)
+    return out
 }
 
 /**
@@ -82,7 +76,7 @@ export function decode(input) {
 }
 
 export default {
-    EncodeOutput,
+    Base128Bytes,
     encode,
     decode
 }

package/package.json

@@ -1,28 +1,26 @@
 {
   "name": "base128-ascii",
-  "version": "2.1.12",
-  "type": "commonjs",
-  "main": "./src/main.js",
-  "module": "./src/module.mjs",
-  "browser": "./dist/browser.min.js",
+  "version": "3.0.0",
+  "author": "bddjr",
+  "license": "Unlicense",
+  "type": "module",
+  "main": "./main.js",
+  "files": [
+    "main.js",
+    "main.d.ts"
+  ],
   "scripts": {
-    "build": "es-check es6 --checkFeatures --module src/**/*.mjs && rimraf dist && node scripts/minify.mjs && es-check es6 --checkFeatures dist/**/*.js src/**/*.js",
-    "test": "node --run build && node scripts/test.mjs",
+    "test": "es-check es6 --checkFeatures --module main.js && node scripts/test.mjs",
     "prepublishOnly": "node --run test"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/bddjr/base128.git"
   },
-  "author": "bddjr",
-  "license": "Unlicense",
-  "files": [
-    "dist",
-    "src"
-  ],
   "keywords": [
     "base128",
     "base64",
+    "base",
     "ascii",
     "encode",
     "decode",
@@ -30,8 +28,6 @@
     "btoa"
   ],
   "devDependencies": {
-    "es-check": "^9.5.3",
-    "rimraf": "^6.0.1",
-    "terser": "^5.44.1"
+    "es-check": "^9.5.3"
   }
 }

package/dist/browser.min.js

@@ -1 +0,0 @@
-{class EncodeOutput{constructor(t){this.uint8Array=t}toString(){return(new TextDecoder).decode(this.uint8Array)}toJSTemplateLiterals(){return`\`${this.toString().replace(/[\r\\`]|\${|<\/script/g,t=>"\r"==t?"\\r":"<\/script"==t?"<\\/script":"\\"+t)}\``}}this.base128={EncodeOutput,encode(t){"string"==typeof t&&(t=(new TextEncoder).encode(t));for(var e=t.length,r=new Uint8Array(Math.ceil(e/7*8)),n=0,c=0;n<e;)r[c++]=t[n]>>1&127,r[c++]=127&(t[n++]<<6|t[n]>>2),r[c++]=127&(t[n++]<<5|t[n]>>3),r[c++]=127&(t[n++]<<4|t[n]>>4),r[c++]=127&(t[n++]<<3|t[n]>>5),r[c++]=127&(t[n++]<<2|t[n]>>6),r[c++]=127&(t[n++]<<1|t[n]>>7),r[c++]=127&t[n++];return new EncodeOutput(r)},decode(t){for(var e,r=t.length,n=new Uint8Array(r/8*7),c=0,o=0,i=()=>(e=t.charCodeAt(c++))>127?e=0:e;c<r;)n[o++]=i()<<1|i()>>6,n[o++]=e<<2|i()>>5,n[o++]=e<<3|i()>>4,n[o++]=e<<4|i()>>3,n[o++]=e<<5|i()>>2,n[o++]=e<<6|i()>>1,n[o++]=e<<7|i();return n}}}

package/src/main.d.ts

@@ -1,12 +0,0 @@
-declare class EncodeOutput {
-    constructor(out: Uint8Array);
-    uint8Array: Uint8Array;
-    toString(): string;
-    toJSTemplateLiterals(): string;
-}
-declare const base128: {
-    EncodeOutput: typeof EncodeOutput;
-    encode(input: Uint8Array | string): EncodeOutput;
-    decode(input: string): Uint8Array;
-};
-export = base128;

package/src/main.js

@@ -1,86 +0,0 @@
-//@ts-nocheck
-
-class EncodeOutput {
-    /**
-     * @param {Uint8Array} out
-     */
-    constructor(out) {
-        this.uint8Array = out
-    }
-    toString() {
-        return new TextDecoder().decode(this.uint8Array)
-    }
-    toJSTemplateLiterals() {
-        return `\`${this.toString().replace(
-            /[\r\\`]|\${|<\/script/g,
-            (match) => (
-                match == '\r'
-                    ? '\\r'
-                    : match == '</script'
-                        ? '<\\/script'
-                        : '\\' + match
-            )
-        )}\``
-    }
-}
-
-module.exports = {
-    EncodeOutput,
-
-    /**
-     * @param {Uint8Array | string} input
-     */
-    encode(input) {
-        if (typeof input == 'string')
-            input = new TextEncoder().encode(input)
-        var il = input.length
-            , out = new Uint8Array(Math.ceil(il / 7 * 8))
-            , ii = 0
-            , oi = 0
-        while (ii < il) {
-            //     0        1        2        3        4        5        6        7
-            // in  00000000 11111111 22222222 33333333 44444444 55555555 66666666
-            // out _0000000 _0111111 _1122222 _2223333 _3333444 _4444455 _5555556 _6666666
-
-            /* 0 */ out[oi++] = input[ii] >> 1 & 127
-            /* 1 */ out[oi++] = (input[ii++] << 6 | input[ii] >> 2) & 127
-            /* 2 */ out[oi++] = (input[ii++] << 5 | input[ii] >> 3) & 127
-            /* 3 */ out[oi++] = (input[ii++] << 4 | input[ii] >> 4) & 127
-            /* 4 */ out[oi++] = (input[ii++] << 3 | input[ii] >> 5) & 127
-            /* 5 */ out[oi++] = (input[ii++] << 2 | input[ii] >> 6) & 127
-            /* 6 */ out[oi++] = (input[ii++] << 1 | input[ii] >> 7) & 127
-            /* 7 */ out[oi++] = input[ii++] & 127
-        }
-        return new EncodeOutput(out)
-    },
-
-    /**
-     * @param {string} input
-     */
-    decode(input) {
-        var il = input.length
-            , out = new Uint8Array(il / 8 * 7)
-            , ii = 0
-            , oi = 0
-            , cache
-            , next = () => (
-                (cache = input.charCodeAt(ii++)) > 127
-                    ? cache = 0 // In HTML, 0 is likely to be converted to 65533 (�)
-                    : cache
-            )
-        while (ii < il) {
-            //     0        1        2        3        4        5        6        7
-            // in  _0000000 _1111111 _2222222 _3333333 _4444444 _5555555 _6666666 _7777777
-            // out 00000001 11111122 22222333 33334444 44455555 55666666 67777777
-
-            /* 0 */ out[oi++] = next() << 1 | next() >> 6
-            /* 1 */ out[oi++] = cache << 2 | next() >> 5
-            /* 2 */ out[oi++] = cache << 3 | next() >> 4
-            /* 3 */ out[oi++] = cache << 4 | next() >> 3
-            /* 4 */ out[oi++] = cache << 5 | next() >> 2
-            /* 5 */ out[oi++] = cache << 6 | next() >> 1
-            /* 6 */ out[oi++] = cache << 7 | next()
-        }
-        return out
-    }
-}

package/src/module.d.mts

@@ -1,14 +0,0 @@
-export declare class EncodeOutput {
-    constructor(out: Uint8Array);
-    uint8Array: Uint8Array;
-    toString(): string;
-    toJSTemplateLiterals(): string;
-}
-export declare function encode(input: Uint8Array | string): EncodeOutput;
-export declare function decode(input: string): Uint8Array;
-declare const base128: {
-    EncodeOutput: typeof EncodeOutput;
-    encode: typeof encode;
-    decode: typeof decode;
-};
-export default base128;