fix: replace micro-bmark with tinybench for benchmarking, enhance codec implementations, and update README with new features and usage examples

Author: hugomrdias

packages/iso-base/bench.js

@@ -2,78 +2,106 @@
 /** biome-ignore-all lint/suspicious/noConsole: benckmark */
 
 import * as scure from '@scure/base'
-import bench from 'micro-bmark'
+import { Bench } from 'tinybench'
+import * as rfc4648 from './src/bases/rfc4648.js'
 import * as iso from './src/index.js'
 
+/**
+ * Codecs to benchmark
+ * @type {Record<string, {
+ *   encode: Record<string, (buf: Uint8Array) => string>,
+ *   decode: Record<string, (str: string) => Uint8Array>,
+ * }>}
+ */
 const codecs = {
   Hex: {
     encode: {
       node: (buf) => Buffer.from(buf).toString('hex'),
-      iso: (buf) => iso.hex.encode(buf),
+      iso: (buf) => iso.Rfc4648.hex.encode(buf),
       scure: (buf) => scure.hex.encode(buf),
+      web: (buf) => buf.toHex(),
     },
     decode: {
       node: (str) => Buffer.from(str, 'hex'),
-      iso: (str) => iso.hex.decode(str),
+      iso: (str) => iso.Rfc4648.hex.decode(str),
       scure: (str) => scure.hex.decode(str),
+      web: (str) => Uint8Array.fromHex(str),
+      isoNew: (str) => rfc4648.hex.decode(str),
     },
   },
-  Base64: {
-    encode: {
-      node: (buf) => Buffer.from(buf).toString('base64'),
-      iso: (buf) => iso.base64.encode(buf),
-      scure: (buf) => scure.base64.encode(buf),
-    },
-    decode: {
-      node: (str) => Buffer.from(str, 'base64'),
-      iso: (str) => iso.base64.decode(str),
-      noble: (str) => scure.base64.decode(str),
-    },
-  },
+  // Base64: {
+  //   encode: {
+  //     node: (buf) => Buffer.from(buf).toString('base64'),
+  //     iso: (buf) => iso.Rfc4648.base64.encode(buf),
+  //     scure: (buf) => scure.base64.encode(buf),
+  //     web: (buf) => buf.toBase64(),
+  //   },
+  //   decode: {
+  //     node: (str) => Buffer.from(str, 'base64'),
+  //     iso: (str) => iso.Rfc4648.base64.decode(str),
+  //     scure: (str) => scure.base64.decode(str),
+  //     web: (str) => Uint8Array.fromBase64(str),
+  //   },
+  // },
 
-  UTF8: {
-    encode: {
-      node: (buf) => Buffer.from(buf).toString('utf8'),
-      iso: (buf) => iso.utf8.encode(buf),
-    },
-    decode: {
-      node: (str) => Buffer.from(str, 'utf8'),
-      iso: (str) => iso.utf8.decode(str),
-    },
-  },
+  // UTF8: {
+  //   encode: {
+  //     node: (buf) => Buffer.from(buf).toString('utf8'),
+  //     iso: (buf) => iso.UTF8.utf8.encode(buf),
+  //   },
+  //   decode: {
+  //     node: (str) => Buffer.from(str, 'utf8'),
+  //     iso: (str) => iso.UTF8.utf8.decode(str),
+  //   },
+  // },
 }
 
 // buffer title, sample count, data
 const buffers = {
-  '32 B': [20_000, new Uint8Array(32).fill(1)],
-  '64 B': [20_000, new Uint8Array(64).fill(1)],
-  '1 KB': [500, new Uint8Array(1024).fill(2)],
-  '8 KB': [10, new Uint8Array(1024 * 8).fill(3)],
+  '32 B': new Uint8Array(32).fill(1),
+  '64 B': new Uint8Array(64).fill(1),
+  '1 KB': new Uint8Array(1024).fill(2),
+  '8 KB': new Uint8Array(1024 * 8).fill(3),
+}
+const strs = {
+  '32 B': iso.Rfc4648.hex.encode(new Uint8Array(32).fill(1)),
+  '64 B': iso.Rfc4648.hex.encode(new Uint8Array(64).fill(1)),
+  '1 KB': iso.Rfc4648.hex.encode(new Uint8Array(1024).fill(2)),
+  '8 KB': iso.Rfc4648.hex.encode(new Uint8Array(1024 * 8).fill(3)),
+}
+
+const parseSize = (sizeStr) => {
+  const match = sizeStr.match(/^(\d+)\s*(B|KB)$/)
+  if (!match) return 0
+  const value = parseInt(match[1], 10)
+  const unit = match[2]
+  return unit === 'KB' ? value * 1024 : value
 }
 
-const main = () =>
-  bench.run(async () => {
-    for (const [k, libs] of Object.entries(codecs)) {
-      console.log(`==== ${k} ====`)
-      for (const [size, [samples, buf]] of Object.entries(buffers)) {
-        // encode
-        for (const [lib, fn] of Object.entries(libs.encode))
-          await bench.mark(`${k} (encode) ${size} ${lib}`, samples, () =>
-            fn(buf)
-          )
-        console.log()
+const main = async () => {
+  const sortedSizes = Object.keys(buffers).sort(
+    (a, b) => parseSize(a) - parseSize(b)
+  )
+
+  for (const size of sortedSizes) {
+    console.log(`==== ${size} ====`)
+    const buf = buffers[size]
+    const str = strs[size]
 
-        // decode
-        const str = libs.encode.iso(buf)
-        for (const [lib, fn] of Object.entries(libs.decode))
-          await bench.mark(`${k} (decode) ${size} ${lib}`, samples, () =>
-            fn(str)
-          )
-        console.log()
+    // All encodes and decodes for all codecs in one bench
+    const bench = new Bench({ time: 10 })
+    for (const [codecName, libs] of Object.entries(codecs)) {
+      for (const [lib, fn] of Object.entries(libs.encode)) {
+        bench.add(`${codecName} (encode) ${size} ${lib}`, () => fn(buf))
+      }
+      for (const [lib, fn] of Object.entries(libs.decode)) {
+        bench.add(`${codecName} (decode) ${size} ${lib}`, () => fn(str))
       }
     }
-    // Log current RAM
-    bench.logMem()
-  })
+    await bench.run()
+    console.table(bench.table())
+    console.log()
+  }
+}
 
 main()

packages/iso-base/package.json

@@ -70,6 +70,7 @@
     "crypto": false,
     "./src/crypto.js": "./src/crypto-browser.js"
   },
+  "sideEffects": false,
   "typesVersions": {
     "*": {
       "utils": [
@@ -122,7 +123,7 @@
     "@types/mocha": "^10.0.10",
     "@types/node": "^24.10.2",
     "assert": "^2.1.0",
-    "micro-bmark": "^0.4.2",
+    "tinybench": "^6.0.0",
     "mocha": "^11.7.5",
     "playwright-test": "^14.1.12",
     "typescript": "5.9.3"