@lumjs/encode 2.3.0 → 2.3.2

package/CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.3.2] - 2026-01-14
+### Fixed
+- More things I missed, sigh.
+
+## [2.3.1] - 2026-01-14
+### Fixed
+- Another broken reference in the HOTP library from its prototype stage.
+- Forgot to add a `Base32` alias property to the default module.
+
 ## [2.3.0] - 2026-01-13
 ### Added
 - New `base32` module with encoding and decoding of four variants of Base32.
@@ -68,7 +77,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Initial release.
 
-[Unreleased]: https://github.com/supernovus/lum.encode.js/compare/v2.3.0...HEAD
+[Unreleased]: https://github.com/supernovus/lum.encode.js/compare/v2.3.2...HEAD
+[2.3.2]: https://github.com/supernovus/lum.encode.js/compare/v2.3.1...v2.3.2
+[2.3.1]: https://github.com/supernovus/lum.encode.js/compare/v2.3.0...v2.3.1
 [2.3.0]: https://github.com/supernovus/lum.encode.js/compare/v2.2.2...v2.3.0
 [2.2.2]: https://github.com/supernovus/lum.encode.js/compare/v2.2.0...v2.2.2
 [2.2.0]: https://github.com/supernovus/lum.encode.js/compare/v2.1.0...v2.2.0

package/lib/base64.js

@@ -65,7 +65,7 @@ function deurlize(string)
 /**
  * Convert a Base64-encoded string into a Uint8Array.
  * 
- * This is a low-level function with no options.
+ * This is a low-level function with minimal options.
  * See `decodeText()` for a more full-featured function.
  *
  * This now checks to see if `Uint8Array.fromBase64()` exists,
@@ -117,10 +117,16 @@ function fromBytes(bytes, options={})
 /**
  * Encode a string to Base64.
  * 
- * Uses the `TextEncoder` API and `fromBytes()`.
- * May optionally pass the output through `urlize()`.
+ * This adds a bunch of extra features on top of `fromBytes()`,
+ * including optionally passing the output through `urlize()`.
+ * 
+ * @param {(string|Uint8Array)} data - Data to be encoded.
+ * 
+ * If this is a String we'll use a `TextEncoder` instance to
+ * convert it into a Uint8Array before passing it to fromBytes().
+ * 
+ * If this is a Uint8Array, we can skip the TextEncoder part.
  * 
- * @param {string} data - Any valid (Unicode) string
  * @param {(object|boolean)} [options] Options
  * 
  * - If `boolean`, used as `options.url`
@@ -138,8 +144,11 @@ function encodeText(data, options={})
     options = {url: options};
   }
 
-  const encoder = new TextEncoder();
-  data = encoder.encode(data);
+  if (!(data instanceof Uint8Array))
+  {
+    const encoder = new TextEncoder();
+    data = encoder.encode(data);
+  }
   const toB64 = (typeof data.toBase64 === F);
 
   if (toB64 && options.url)
@@ -171,13 +180,15 @@ function encodeText(data, options={})
  * - Passed to `new TextDecoder()`
  * - Passed to `decoder.decode()`
  * 
- * @param {boolean} [options.url=true] Deurlize the output?
+ * @param {boolean} [options.string=true] Decode as a string?
+ * @param {boolean} [options.url=true] Deurlize the base64 string?
  * 
  * Unless this is explicitly set as `false`, the `base64`
  * string will be passed to `deurlize()` before being
  * processed further.
  * 
- * @returns {string} A Unicode string
+ * @returns {(string|Uint8Array)} 
+ * Returned type depends on `opts.string`.
  */
 function decodeText(base64, options={})
 {
@@ -186,7 +197,7 @@ function decodeText(base64, options={})
     options = {url: options};
   }
 
-  if (options.url !== false)
+  if (options.url ?? true)
   { // Unless explicitly disabled, use deurlize() first.
     if (UI8_FB64)
     {
@@ -204,9 +215,13 @@ function decodeText(base64, options={})
     }
   }
 
-  const encoding = options.encoding ?? D_ENC;
-  const decoder = new TextDecoder(encoding, options);
-  return decoder.decode(toBytes(base64, options), options);
+  const bytes = toBytes(base64, options);
+  if (options.string ?? true) {
+    const encoding = options.encoding ?? D_ENC;
+    const decoder = new TextDecoder(encoding, options);
+    return decoder.decode(bytes, options);
+  }
+  return bytes;
 }
 
 /**

package/lib/hash.js

@@ -3,6 +3,7 @@
 const {S,F,isObj,isNil} = require('@lumjs/core/types');
 
 const util   = require('./util');
+const base32 = require('./base32');
 const base64 = require('./base64');
 const base91 = require('./base91');
 
@@ -156,6 +157,7 @@ module.exports = class
 
     this.defaults =
     {
+      base32: options.base32 ?? {},
       base64: options.base64 ?? {},
       base91: options.base91 ?? {},
     }
@@ -289,6 +291,22 @@ module.exports = class
     return (hashArr.map((b)=>b.toString(16).padStart(2, "0")).join(""));
   }
 
+  /**
+   * Get hash as a Base32-encoded string.
+   * 
+   * @param {(string|object|null)} [input]
+   * See [hash()]{@link module:@lumjs/encode/hash#hash}
+   * 
+   * @param {object} [options] Options to pass to base32.encode().
+   * 
+   * @returns {string}
+   */
+  async base32(input, opts=this.defaults.base32)
+  {
+    const hash = await this.hash(input);
+    return base32.encode(new Uint8Array(hash), opts);
+  }
+
   /**
    * Get hash as a Base64-encoded string.
    *
@@ -311,12 +329,14 @@ module.exports = class
   /**
    * Get hash as a Base91-encoded string.
    * 
-   * @param {(string|WordArray)} [input] 
+   * @param {(string|object|null)} [input] 
    * See [hash()]{@link module:@lumjs/encode/hash#hash}
    * @param {object} [opts] Options for how to encode the hash.
    * 
    * @param {(boolean|object)} [opts.nba=false] Use `numByteArray()` ?
    * 
+   * This options is deprecated and will be removed in v3.0.
+   * 
    * If this is `true` the *hash string* will be passed to `numByteArray()`
    * with the *default options* and the output from that will be passed to 
    * `base91.encode()`.

package/lib/hotp.js

@@ -78,7 +78,9 @@ class HOTP {
       v1,
       v2,
       code,
-      toString,
+      toString() {
+        return this.code;
+      },
     }
 
     if (opts.debug) console.debug(res.code, res);

package/lib/index.js

@@ -30,6 +30,12 @@ def(exports, 'ord', util.ord, E);
  */
 def(exports, 'numByteArray', util.numByteArray, E);
 
+/**
+ * @name module:@lumjs/encode.Base32
+ * @see {@link module:@lumjs/encode/base32}
+ */
+lazy(exports, 'Base32', () => require('./base32'), E);
+
 /**
  * @name module:@lumjs/encode.Base64
  * @see {@link module:@lumjs/encode/base64}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lumjs/encode",
-  "version": "2.3.0",
+  "version": "2.3.2",
   "main": "lib/index.js",
   "exports":
   {