Added BASE32 encoding

Author: fenying

.gitignore

@@ -1,3 +1,3 @@
 /node_modules/
 /lib/
-/samples/
+/examples/

.npmignore

@@ -7,3 +7,4 @@
 /tsconfig.json
 /tslint.json
 /docs/
+/examples/

.vscode/launch.json

@@ -7,61 +7,73 @@
         {
             "type": "node",
             "request": "launch",
-            "name": "[LiteRT/Encodings.js] Sample 01 - BASE64Url Encodings",
-            "program": "${workspaceFolder}/src/samples/01-base64url.ts",
+            "name": "[LiteRT/Encodings.js] Example 01 - BASE64Url Encodings",
+            "program": "${workspaceFolder}/src/examples/01-base64url.ts",
             "sourceMaps": true,
             "cwd": "${workspaceFolder}",
             "outFiles": [
                 "${workspaceFolder}/lib/*.js",
-                "${workspaceFolder}/samples/*.js"
+                "${workspaceFolder}/examples/*.js"
             ]
         },
         {
             "type": "node",
             "request": "launch",
-            "name": "[LiteRT/Encodings.js] Sample 02 - Strict-URI Encoding",
-            "program": "${workspaceFolder}/src/samples/02-strict_uri.ts",
+            "name": "[LiteRT/Encodings.js] Example 02 - Strict-URI Encoding",
+            "program": "${workspaceFolder}/src/examples/02-strict_uri.ts",
             "sourceMaps": true,
             "cwd": "${workspaceFolder}",
             "outFiles": [
                 "${workspaceFolder}/lib/*.js",
-                "${workspaceFolder}/samples/*.js"
+                "${workspaceFolder}/examples/*.js"
             ]
         },
         {
             "type": "node",
             "request": "launch",
-            "name": "[LiteRT/Encodings.js] Sample 03 - URL Encodings",
-            "program": "${workspaceFolder}/src/samples/03-urlencode.ts",
+            "name": "[LiteRT/Encodings.js] Example 03 - URL Encodings",
+            "program": "${workspaceFolder}/src/examples/03-urlencode.ts",
             "sourceMaps": true,
             "cwd": "${workspaceFolder}",
             "outFiles": [
                 "${workspaceFolder}/lib/*.js",
-                "${workspaceFolder}/samples/*.js"
+                "${workspaceFolder}/examples/*.js"
             ]
         },
         {
             "type": "node",
             "request": "launch",
-            "name": "[LiteRT/Encodings.js] Sample 04 - Hex API",
-            "program": "${workspaceFolder}/src/samples/04-hex.ts",
+            "name": "[LiteRT/Encodings.js] Example 04 - Hex API",
+            "program": "${workspaceFolder}/src/examples/04-hex.ts",
             "sourceMaps": true,
             "cwd": "${workspaceFolder}",
             "outFiles": [
                 "${workspaceFolder}/lib/*.js",
-                "${workspaceFolder}/samples/*.js"
+                "${workspaceFolder}/examples/*.js"
             ]
         },
         {
             "type": "node",
             "request": "launch",
-            "name": "[LiteRT/Encodings.js] Sample 05 - Base62x Encodings",
-            "program": "${workspaceFolder}/src/samples/05-base62x.ts",
+            "name": "[LiteRT/Encodings.js] Example 05 - Base62x Encodings",
+            "program": "${workspaceFolder}/src/examples/05-base62x.ts",
             "sourceMaps": true,
             "cwd": "${workspaceFolder}",
             "outFiles": [
                 "${workspaceFolder}/lib/*.js",
-                "${workspaceFolder}/samples/*.js"
+                "${workspaceFolder}/examples/*.js"
+            ]
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "[LiteRT/Encodings.js] Example 06 - Base32 Encodings",
+            "program": "${workspaceFolder}/src/examples/06-base32.ts",
+            "sourceMaps": true,
+            "cwd": "${workspaceFolder}",
+            "outFiles": [
+                "${workspaceFolder}/lib/*.js",
+                "${workspaceFolder}/examples/*.js"
             ]
         }
     ]

CHANGES.md

@@ -1,9 +1,17 @@
 # Changes Logs
 
+## v2.1.0
+
+- Added encoding `base32`.
+
+## v2.0.0
+
+- Simplified the APIs.
+
 ## v1.1.1
 
 - Fixed the `convert` result from `base62x` to `buffer`, `hex`, `base64`, `utf8`.
-- Improved the sample `04-compare` with **binary-safe** tests.
+- Improved the example `04-compare` with **binary-safe** tests.
 - Added supports for encoding `urlencode`.
 
 ## v1.1.0

README.md

@@ -6,13 +6,15 @@
 [![GitHub Releases](https://img.shields.io/github/release/litert/encodings.js.svg)](https://github.com/litert/encodings.js/releases "Stable Release")
 
 The buffer-based encoding utility method for node.js.
+
 Following types of encodings are supported:
 
 Name         | Description                     | Binary-Safe
 -------------|---------------------------------|:-----------:
 `base64`     | The standard BASE64 encoding.   | Yes
 `base64url`  | The URL-safe BASE64 encoding.   | Yes
 `base62x`    | The BASE62x encoding.           | Yes
+`base32`     | The standard BASE32 encoding.   | Yes
 `hex`        | The hexadecimal encoding.       | Yes
 `urlencode`  | The purely URL-safe encoding.   | Yes
 `strict_uri` | The extended URL-safe encoding. | No
@@ -65,6 +67,7 @@ const hex = Enc.stringToHex("hello world");             // Encode a string into
 const b62 = Enc.stringToBase62("hello world");          // Encode a string into BASE62
 const b64 = Enc.stringToBase64("hello world");          // Encode a string into BASE64
 const b64url = Enc.stringToBase64Url("hello world");    // Encode a string into BASE64URL
+const b32 = Enc.stringToBase32("hello world");          // Encode a string into BASE32
 const url = Enc.stringToUrlencode("hello world");       // Encode a string into URL
 const strict = Enc.stringToStrictUri("hello world");    // Encode a string into Strict-URI
 
@@ -74,20 +77,23 @@ Enc.bufferToHex(Buffer.from("hello world"));
 Enc.bufferToBase62(Buffer.from("hello world"));
 Enc.bufferToBase64(Buffer.from("hello world"));
 Enc.bufferToBase64Url(Buffer.from("hello world"));
+Enc.bufferToBase32(Buffer.from("hello world"));
 Enc.bufferToUrlencode(Buffer.from("hello world"));
 Enc.bufferToStrictUri(Buffer.from("hello world"));
 
 Enc.stringFromHex(hex);                         // Decode a hex-encoded data as a string
 Enc.stringFromBase62(b62);                      // Decode a BASE62-encoded data as a string
 Enc.stringFromBase64(b64);                      // Decode a BASE64-encoded data as a string
 Enc.stringFromBase64Url(b64url);                // Decode a BASE64URL-encoded data as a string
+Enc.stringFromBase32(b32);                      // Decode a BASE32-encoded data as a string
 Enc.stringFromUrlencode(url);                   // Decode a urlencoded data as a string
 Enc.stringFromStrictUri(strict);                // Decode a Strict-URI-encoded data as a string
 
 Enc.bufferFromHex(hex);
 Enc.bufferFromBase62(b62);
 Enc.bufferFromBase64(b64);
 Enc.bufferFromBase64Url(b64url);
+Enc.bufferFromBase32(b32);
 Enc.bufferFromUrlencode(url);
 Enc.bufferFromStrictUri(strict);
 ```

package-lock.json

@@ -1,15 +1,15 @@
 {
   "name": "@litert/encodings",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "The buffer-based encoding utility method for node.js.",
   "main": "lib/index.js",
   "scripts": {
     "prepare": "npm run rebuild",
     "build": "echo Using TypeScript && tsc -v && tsc -p .",
     "build-watch": "echo Using TypeScript && tsc -v && tsc -w -p .",
     "rebuild": "npm run clean && npm run lint && npm run build",
-    "test": "echo See directory sources/samples",
-    "clean": "rm -rf lib samples",
+    "test": "echo See directory sources/examples",
+    "clean": "rm -rf lib examples",
     "lint": "tslint -p . -c tslint.json"
   },
   "repository": {

package.json

@@ -18,10 +18,32 @@
 
 import * as Enc from "../lib";
 
-const RAW_DATA = "Hello world!@#$%^&*()~`\":<>?,./[]{}\\|-=_+;'";
+const RAND_SOURCE = "abcdefghijlkmnopqrstuvwxyzABCDEFGHIJLKMNOPQRSTUVWXYZ0123456";
 
-const base62 = Enc.stringToBase62(RAW_DATA);
+function randStr(len: number): string {
 
-console.info(`Base62:       ${base62}`);
+    return Array(len).fill(0).map((v) => RAND_SOURCE[Math.floor(Math.random() * RAND_SOURCE.length)]).join("");
+}
 
-console.info(`RawData:      ${Enc.stringFromBase62(base62)}`);
+for (let i = 0; i < 256; i++) {
+
+    const origin = randStr(i);
+
+    console.info(`Origin:       ${origin}`);
+
+    const base62 = Enc.stringToBase62(origin);
+
+    console.info(`Base62:       ${base62}`);
+
+    const decoded = Enc.stringFromBase62(base62);
+
+    if (origin === decoded) {
+
+        console.info(`Decoded:      Matched`);
+    }
+    else {
+
+        console.error(`Decoded:      ${decoded}`);
+        break;
+    }
+}

src/samples/01-base64url.ts src/examples/01-base64url.ts

@@ -0,0 +1,49 @@
+/**
+ * Copyright 2019 Angus.Fenying <fenying@litert.org>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// tslint:disable:no-console
+
+import * as Enc from "../lib";
+
+const RAND_SOURCE = "abcdefghijlkmnopqrstuvwxyzABCDEFGHIJLKMNOPQRSTUVWXYZ0123456";
+
+function randStr(len: number): string {
+
+    return Array(len).fill(0).map((v) => RAND_SOURCE[Math.floor(Math.random() * RAND_SOURCE.length)]).join("");
+}
+
+for (let i = 0; i < 256; i++) {
+
+    const origin = randStr(i);
+
+    console.info(`Origin:       ${origin}`);
+
+    const base32 = Enc.stringToBase32(origin);
+
+    console.info(`Base32:       ${base32}`);
+
+    const decoded = Enc.stringFromBase32(base32);
+
+    if (origin === decoded) {
+
+        console.info(`Decoded:      Matched`);
+    }
+    else {
+
+        console.error(`Decoded:      ${decoded}`);
+        break;
+    }
+}