@lumjs/encode 2.6.0 → 2.6.1

package/CHANGELOG.md

@@ -6,8 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [2.6.0] - 2026-02-24
+## [2.6.1] - 2026-03-07
+- Thanks to the wonkiness of CJS vs ESM, I've added some stub .ejs files
+  for any of the module _sets_. Along with the types added in 2.6.0, this
+  is now actually useable in Typescript projects.
 
+## [2.6.0] - 2026-02-24
+- Moved to using [@lumjs/build] to build the docs and Typescript type defs.
+- Added some polyfills for a couple Uint8Array methods that aren't supported
+  on every runtime yet.
 
 ## [2.5.0] - 2026-02-20
 ### Added
@@ -109,7 +116,8 @@ 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.6.0...HEAD
+[Unreleased]: https://github.com/supernovus/lum.encode.js/compare/v2.6.1...HEAD
+[2.6.1]: https://github.com/supernovus/lum.encode.js/compare/v2.6.0...v2.6.1
 [2.6.0]: https://github.com/supernovus/lum.encode.js/compare/v2.5.0...v2.6.0
 [2.5.0]: https://github.com/supernovus/lum.encode.js/compare/v2.4.1...v2.5.0
 [2.4.1]: https://github.com/supernovus/lum.encode.js/compare/v2.4.0...v2.4.1

package/TODO.md

@@ -1,3 +1,11 @@
 # TODO
 
 - Write tests for HMAC, HOTP, TOTP, etc.
+
+## v3.x
+
+- Target `@lumjs/core` 2.x once it is finalised.
+- Rewrite this as ESM with native Typescript typings.
+  That will let me drop all the compatibility cruft I've had to add
+  just to get this package working for a Typescript project.
+

package/lib/hash.js

@@ -282,7 +282,7 @@ module.exports = class Hashifier
    * @param {(string|object|null)} [input]
    * See [hash()]{@link module:@lumjs/encode/hash#hash} for details.
    * 
-   * @returns {string}
+   * @returns {Promise<string>}
    */
   async hex(input)
   {
@@ -299,7 +299,7 @@ module.exports = class Hashifier
    * 
    * @param {object} [options] Options to pass to base32.encode().
    * 
-   * @returns {string}
+   * @returns {Promise<string>}
    */
   async base32(input, opts=this.defaults.base32)
   {
@@ -317,7 +317,7 @@ module.exports = class Hashifier
    * 
    * @param {boolean} [options.url=false] Use URL-safe variant?
    * 
-   * @returns {string}
+   * @returns {Promise<string>}
    */
   async base64(input, opts=this.defaults.base64)
   {
@@ -347,7 +347,7 @@ module.exports = class Hashifier
    * If this is `false` the `ArrayBffer` will be converted into a `Uint8Array`,
    * and that will be passed to `base91.encode()`.
    * 
-   * @returns {string}
+   * @returns {Promise<string>}
    */
   async base91(input, opts=this.defaults.base91)
   {

package/lib/sets/all.mjs

@@ -0,0 +1,2 @@
+export * from './digest.mjs';
+export * from './sign.mjs';

package/lib/sets/base.mjs

@@ -0,0 +1,7 @@
+import mod from './base.js';
+export const {
+  Base32,
+  Base64,
+  Base91,
+  Util,
+} = mod;

package/lib/sets/digest.mjs

@@ -0,0 +1,5 @@
+export * from './base.mjs';
+import mod from './digest.js';
+export const {
+  Hash,
+} = mod;

package/lib/sets/otp.mjs

@@ -0,0 +1,6 @@
+export * from './sign.mjs';
+import mod from './digest.js';
+export const {
+  HOTP,
+  TOTP,
+} = mod;

package/lib/sets/sign.mjs

@@ -0,0 +1,7 @@
+import mod from './sign.js';
+export const {
+  HMAC,
+  PEM,
+  Signature,
+  Util,
+} = mod;

package/lum.build.js

@@ -14,6 +14,7 @@ module.exports = function(rb)
   .add('totp')
   .add('util')
   .src('./lib/sets')
+  .alt('./lib/sets')
   .types('./types/sets')
   .add('all')
   .add('base')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lumjs/encode",
-  "version": "2.6.0",
+  "version": "2.6.1",
   "main": "lib/index.js",
   "exports": {
     ".": "./lib/index.js",
@@ -46,23 +46,28 @@
     },
     "./all": {
       "types": "./types/sets/all.d.ts",
-      "default": "./lib/sets/all.js"
+      "require": "./lib/sets/all.js",
+      "import": "./lib/sets/all.mjs"
     },
     "./base": {
       "types": "./types/sets/base.d.ts",
-      "default": "./lib/sets/base.js"
+      "require": "./lib/sets/base.js",
+      "import": "./lib/sets/base.mjs"
     },
     "./digest": {
       "types": "./types/sets/digest.d.ts",
-      "default": "./lib/sets/digest.js"
+      "require": "./lib/sets/digest.js",
+      "import": "./lib/sets/digest.mjs"
     },
     "./otp": {
       "types": "./types/sets/otp.d.ts",
-      "default": "./lib/sets/otp.js"
+      "require": "./lib/sets/otp.js",
+      "import": "./lib/sets/otp.mjs"
     },
     "./sign": {
       "types": "./types/sets/sign.d.ts",
-      "default": "./lib/sets/sign.js"
+      "require": "./lib/sets/sign.js",
+      "import": "./lib/sets/sign.mjs"
     },
     "./package.json": "./package.json"
   },
@@ -79,8 +84,9 @@
     "@lumjs/tests": "^2.0.0"
   },
   "scripts": {
-    "build": "npm run build-types && npm run build-meta && npm run build-docs",
+    "build": "npm run build-info && npm run build-docs",
     "build-docs": "jsdoc -c ./jsdoc.js",
+    "build-info": "npm run build-types && npm run build-meta",
     "build-meta": "lum-build",
     "build-types": "npx -p typescript tsc",
     "test": "node ./node_modules/@lumjs/tests/bin/lumtest.js"

package/types/auto/hash.d.ts

@@ -125,9 +125,9 @@ declare class Hashifier {
      * @param {(string|object|null)} [input]
      * See [hash()]{@link module:@lumjs/encode/hash#hash} for details.
      *
-     * @returns {string}
+     * @returns {Promise<string>}
      */
-    hex(input?: (string | object | null)): string;
+    hex(input?: (string | object | null)): Promise<string>;
     /**
      * Get hash as a Base32-encoded string.
      *
@@ -136,9 +136,9 @@ declare class Hashifier {
      *
      * @param {object} [options] Options to pass to base32.encode().
      *
-     * @returns {string}
+     * @returns {Promise<string>}
      */
-    base32(input?: (string | object | null), opts?: any): string;
+    base32(input?: (string | object | null), opts?: any): Promise<string>;
     /**
      * Get hash as a Base64-encoded string.
      *
@@ -149,9 +149,9 @@ declare class Hashifier {
      *
      * @param {boolean} [options.url=false] Use URL-safe variant?
      *
-     * @returns {string}
+     * @returns {Promise<string>}
      */
-    base64(input?: (string | object | null), opts?: any): string;
+    base64(input?: (string | object | null), opts?: any): Promise<string>;
     /**
      * Get hash as a Base91-encoded string.
      *
@@ -173,11 +173,11 @@ declare class Hashifier {
      * If this is `false` the `ArrayBffer` will be converted into a `Uint8Array`,
      * and that will be passed to `base91.encode()`.
      *
-     * @returns {string}
+     * @returns {Promise<string>}
      */
     base91(input?: (string | object | null), opts?: {
         nba?: (boolean | object);
-    }): string;
+    }): Promise<string>;
     /**
      * Add input to a progressive hash.
      *

package/types/auto/hash.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hash.d.ts","sourceRoot":"","sources":["../../lib/hash.js"],"names":[],"mappings":";AAyDiB;IA8Xf,0CAGC;IA/XD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsEG;IACH,sBApEW,CAAC,MAAM,GAAC,MAAM,CAAC,EAyGzB;IA9BC,aAAsB;IAEtB;;;;;MAMC;IAED,aAGW;IAOX;;;;MAKC;IAED,aAA6C;IAC7C,cAA8C;IAIhD;;;;;;;;;;;;OAYG;IACH,iBAVW,MAAM,GAMH,MAAM,OAAA,CAoBnB;IAED;;;;;;;;;;;;;;;OAeG;IACH,aARW,CAAC,MAAM,GAAC,MAAM,CAAC,GAEd,OAAO,CAAC,WAAW,CAAC,CAkE/B;IAED;;;;;;;OAOG;IACH,YALW,CAAC,MAAM,GAAC,MAAM,GAAC,IAAI,CAAC,GAGlB,MAAM,CAOlB;IAED;;;;;;;;;OASG;IACH,eAPW,CAAC,MAAM,GAAC,MAAM,GAAC,IAAI,CAAC,eAKlB,MAAM,CAMlB;IAED;;;;;;;;;;;OAWG;IACH,eATW,CAAC,MAAM,GAAC,MAAM,GAAC,IAAI,CAAC,eAOlB,MAAM,CAOlB;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,eApBW,CAAC,MAAM,GAAC,MAAM,GAAC,IAAI,CAAC,SAI5B;QAAgC,GAAG,GAA3B,CAAC,OAAO,GAAC,MAAM,CAAC;KAcxB,GAAU,MAAM,CAclB;IAED;;;;;;;;;;;OAWG;IACH,WATW,CAAC,MAAM,GAAC,MAAM,CAAC,cAOd,MAAM,CAyDjB;IAED,cAGC;CAOF;;;;;;;;;;;QAjZa,MAAM;;;;YACN,MAAM;;;;WACN,MAAM"}
+{"version":3,"file":"hash.d.ts","sourceRoot":"","sources":["../../lib/hash.js"],"names":[],"mappings":";AAyDiB;IA8Xf,0CAGC;IA/XD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsEG;IACH,sBApEW,CAAC,MAAM,GAAC,MAAM,CAAC,EAyGzB;IA9BC,aAAsB;IAEtB;;;;;MAMC;IAED,aAGW;IAOX;;;;MAKC;IAED,aAA6C;IAC7C,cAA8C;IAIhD;;;;;;;;;;;;OAYG;IACH,iBAVW,MAAM,GAMH,MAAM,OAAA,CAoBnB;IAED;;;;;;;;;;;;;;;OAeG;IACH,aARW,CAAC,MAAM,GAAC,MAAM,CAAC,GAEd,OAAO,CAAC,WAAW,CAAC,CAkE/B;IAED;;;;;;;OAOG;IACH,YALW,CAAC,MAAM,GAAC,MAAM,GAAC,IAAI,CAAC,GAGlB,OAAO,CAAC,MAAM,CAAC,CAO3B;IAED;;;;;;;;;OASG;IACH,eAPW,CAAC,MAAM,GAAC,MAAM,GAAC,IAAI,CAAC,eAKlB,OAAO,CAAC,MAAM,CAAC,CAM3B;IAED;;;;;;;;;;;OAWG;IACH,eATW,CAAC,MAAM,GAAC,MAAM,GAAC,IAAI,CAAC,eAOlB,OAAO,CAAC,MAAM,CAAC,CAO3B;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,eApBW,CAAC,MAAM,GAAC,MAAM,GAAC,IAAI,CAAC,SAI5B;QAAgC,GAAG,GAA3B,CAAC,OAAO,GAAC,MAAM,CAAC;KAcxB,GAAU,OAAO,CAAC,MAAM,CAAC,CAc3B;IAED;;;;;;;;;;;OAWG;IACH,WATW,CAAC,MAAM,GAAC,MAAM,CAAC,cAOd,MAAM,CAyDjB;IAED,cAGC;CAOF;;;;;;;;;;;QAjZa,MAAM;;;;YACN,MAAM;;;;WACN,MAAM"}