feat: add types for base32

Author: ChALkeR

README.md

@@ -326,7 +326,7 @@ Encode a `Uint8Array` to a lowercase hex string
 
 ### `@exodus/bytes/base64.js`
 
-Implements Base64 from [RFC4648](https://datatracker.ietf.org/doc/html/rfc4648)
+Implements base64 and base64url from [RFC4648](https://datatracker.ietf.org/doc/html/rfc4648)
 (no differences from [RFC3548](https://datatracker.ietf.org/doc/html/rfc4648)).
 
 ```js
@@ -363,7 +363,7 @@ Encode a `Uint8Array` to a base64url string (RFC 4648)
 
 ### `@exodus/bytes/base32.js`
 
-Implements Base32 from [RFC4648](https://datatracker.ietf.org/doc/html/rfc4648)
+Implements base32 and base32hex from [RFC4648](https://datatracker.ietf.org/doc/html/rfc4648)
 (no differences from [RFC3548](https://datatracker.ietf.org/doc/html/rfc4648)).
 
 ```js
@@ -372,10 +372,25 @@ import { fromBase32hex, toBase32hex } from '@exodus/bytes/base32.js'
 ```
 
 #### `fromBase32(string, { format = 'uint8', padding = 'both' })`
+
+Decode a base32 string to bytes
+
+Operates in strict mode for last chunk, does not allow whitespace
+
 #### `fromBase32hex(string, { format = 'uint8', padding = 'both' })`
+
+Decode a base32hex string to bytes
+
+Operates in strict mode for last chunk, does not allow whitespace
+
 #### `toBase32(arr, { padding = false })`
+
+Encode a `Uint8Array` to a base32 string (RFC 4648)
+
 #### `toBase32hex(arr, { padding = false })`
 
+Encode a `Uint8Array` to a base32hex string (RFC 4648)
+
 ### `@exodus/bytes/bech32.js`
 
 Implements [BIP-0173](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki#specification)

base32.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Implements base32 and base32hex from [RFC4648](https://datatracker.ietf.org/doc/html/rfc4648)
+ * (no differences from [RFC3548](https://datatracker.ietf.org/doc/html/rfc4648)).
+ *
+ * ```js
+ * import { fromBase32, toBase32 } from '@exodus/bytes/base32.js'
+ * import { fromBase32hex, toBase32hex } from '@exodus/bytes/base32.js'
+ * ```
+ *
+ * @module @exodus/bytes/base32.js
+ */
+
+/// <reference types="node" />
+
+import type { OutputFormat, Uint8ArrayBuffer } from './array.js';
+
+/**
+ * Options for base32 encoding
+ */
+export interface ToBase32Options {
+  /** Whether to include padding characters (default: false) */
+  padding?: boolean;
+}
+
+/**
+ * Padding mode for base32 decoding
+ * - `true`: padding is required
+ * - `false`: padding is not allowed
+ * - `'both'`: padding is optional (default)
+ */
+export type PaddingMode = boolean | 'both';
+
+/**
+ * Options for base32 decoding
+ */
+export interface FromBase32Options {
+  /** Output format (default: 'uint8') */
+  format?: OutputFormat;
+  /** Padding mode */
+  padding?: PaddingMode;
+}
+
+/**
+ * Encode a `Uint8Array` to a base32 string (RFC 4648)
+ *
+ * @param arr - The input bytes
+ * @param options - Encoding options
+ * @returns The base32 encoded string
+ */
+export function toBase32(arr: Uint8ArrayBuffer, options?: ToBase32Options): string;
+
+/**
+ * Encode a `Uint8Array` to a base32hex string (RFC 4648)
+ *
+ * @param arr - The input bytes
+ * @param options - Encoding options (padding defaults to false)
+ * @returns The base32hex encoded string
+ */
+export function toBase32hex(arr: Uint8ArrayBuffer, options?: ToBase32Options): string;
+
+/**
+ * Decode a base32 string to bytes
+ *
+ * Operates in strict mode for last chunk, does not allow whitespace
+ *
+ * @param string - The base32 encoded string
+ * @param options - Decoding options
+ * @returns The decoded bytes
+ */
+export function fromBase32(string: string, options?: FromBase32Options): Uint8ArrayBuffer;
+export function fromBase32(string: string, options: FromBase32Options & { format: 'buffer' }): Buffer;
+
+/**
+ * Decode a base32hex string to bytes
+ *
+ * Operates in strict mode for last chunk, does not allow whitespace
+ *
+ * @param string - The base32hex encoded string
+ * @param options - Decoding options
+ * @returns The decoded bytes
+ */
+export function fromBase32hex(string: string, options?: FromBase32Options): Uint8ArrayBuffer;
+export function fromBase32hex(string: string, options: FromBase32Options & { format: 'buffer' }): Buffer;

base64.d.ts

@@ -1,5 +1,5 @@
 /**
- * Implements Base64 from [RFC4648](https://datatracker.ietf.org/doc/html/rfc4648)
+ * Implements base64 and base64url from [RFC4648](https://datatracker.ietf.org/doc/html/rfc4648)
  * (no differences from [RFC3548](https://datatracker.ietf.org/doc/html/rfc4648)).
  *
  * ```js
@@ -26,7 +26,7 @@ export interface ToBase64Options {
 /**
  * Padding mode for base64 decoding
  * - `true`: padding is required
- * - `false`: padding is not allowed
+ * - `false`: padding is not allowed (default for base64url)
  * - `'both'`: padding is optional (default for base64)
  */
 export type PaddingMode = boolean | 'both';

package.json

@@ -82,6 +82,7 @@
     "/array.d.ts",
     "/assert.js",
     "/base32.js",
+    "/base32.d.ts",
     "/base58.js",
     "/base58check.js",
     "/base58check.node.js",
@@ -125,7 +126,10 @@
       "types": "./array.d.ts",
       "default": "./array.js"
     },
-    "./base32.js": "./base32.js",
+    "./base32.js": {
+      "types": "./base32.d.ts",
+      "default": "./base32.js"
+    },
     "./base58.js": "./base58.js",
     "./base58check.js": {
       "node": "./base58check.node.js",