bufferbase 1.3.0 → 2.0.0

package/README.md

@@ -1,33 +1,114 @@
 # bufferbase
 
-Buffer-to-BaseN Encoding and Decoding for Node.js.
-
-bufferbase is a Node.js library that provides straightforward encoding and decoding of buffer objects into various BaseN formats. It's designed to be simple, efficient, and flexible for different application needs.
-
-## Features
-
-- Supports multiple base encoding formats.
-- Optimized for Node.js buffer handling.
-- Intuitive API for easy integration.
-- Suitable for various data types.
-- Consistent and reliable performance.
+Buffer-to-BaseN encoding and decoding for Node.js.
 
 ## Installation
 
-Install bufferbase using npm:
-
 ```bash
 npm install bufferbase
 ```
 
 ## Usage
 
-See [src/example.ts](/src/example.ts)
+### Simple Function API
+
+```typescript
+import { encode, decode, convert, validate } from 'bufferbase';
+
+// Encode buffer to base58
+const encoded = encode(Buffer.from('Hello'), 'base58');
+
+// Decode base58 string to buffer
+const decoded = decode(encoded, 'base58');
+
+// Decode with fixed size (pads with leading zeros)
+const fixed = decode(encoded, 'base58', { size: 32 });
+
+// Convert between bases
+const base64 = convert(encoded, 'base58', 'base64url');
+
+// Validate string
+validate('9Ajdvz', 'base58'); // true
+validate('0Ajdvz', 'base58'); // false ('0' not in base58)
+```
+
+### Pre-defined Codecs
+
+```typescript
+import { Codecs } from 'bufferbase';
+
+const encoded = Codecs.base58.encode(Buffer.from('Hello'));
+const decoded = Codecs.base58.decode(encoded);
+
+// Convert between codecs
+const base64 = Codecs.base58.convertTo(Codecs.base64url, encoded);
+
+// Validate
+Codecs.base58.validate('9Ajdvz'); // true
+```
+
+### Custom Character Set
+
+```typescript
+import { createCodec } from 'bufferbase';
+
+const binary = createCodec('01');
+binary.encode(Buffer.from([5])); // '101'
+binary.decode('101'); // Buffer([5])
+```
+
+## Supported Encodings
+
+| Name | Characters |
+|------|------------|
+| `decimal` | 0-9 |
+| `base16` / `hex` | 0-9A-F |
+| `base32` | A-Z2-7 |
+| `base32crockford` | 0-9A-HJKMNP-TV-Z |
+| `base36` | 0-9A-Z |
+| `base52` | A-Za-z |
+| `base58` | Bitcoin alphabet (no 0OIl) |
+| `base64` | A-Za-z0-9+/ |
+| `base64url` | A-Za-z0-9-_ |
+| `base64xml` | A-Za-z0-9._ |
+| `base64xmlname` | A-Za-z0-9_: |
+| `ascii85` | ASCII85 |
+| `base85` | Base85 |
+| `z85` | ZeroMQ Z85 |
+
+## API
+
+### Functions
+
+- `encode(buffer, base)` - Encode buffer to string
+- `decode(encoded, base, options?)` - Decode string to buffer
+- `convert(input, from, to)` - Convert between bases
+- `validate(input, base)` - Check if string is valid for base
+- `createCodec(chars)` - Create codec with custom character set
+
+### Codecs Object
+
+```typescript
+Codecs.base58.encode(buffer)
+Codecs.base58.decode(encoded, options?)
+Codecs.base58.validate(input)
+Codecs.base58.convertTo(targetCodec, input)
+```
+
+### Options
+
+```typescript
+interface DecodeOptions {
+  size?: number; // Expected buffer size (pads with zeros if smaller)
+}
+```
 
+### Errors
 
-## Contributing
+- `InvalidCharacterError` - Invalid character in decode input
+- `BufferSizeError` - Decoded buffer exceeds specified size
+- `UnknownBaseError` - Unknown base name
 
-Contributions to bufferbase are welcome! Please read our contributing guidelines for more information.
-License
+## License
 
-bufferbase is ISC licensed.
+ISC

package/dist/cjs/bases.d.ts

@@ -0,0 +1,82 @@
+import type { BaseName } from './types.js';
+/**
+ * Character sets for common base encodings.
+ *
+ * Use these with `createCodec()` or the deprecated `BufferEncoder` class
+ * when you need direct access to character sets.
+ *
+ * @example
+ * ```typescript
+ * import { Chars, createCodec } from 'bufferbase';
+ *
+ * const codec = createCodec(Chars.Base58);
+ * const encoded = codec.encode(Buffer.from('Hello'));
+ * ```
+ */
+export declare const Chars: {
+    /** Base 10: 0-9 */
+    readonly Decimal: "0123456789";
+    /** Hexadecimal: 0-9A-F */
+    readonly Base16: "0123456789ABCDEF";
+    /** RFC 4648 Base32: A-Z2-7 */
+    readonly Base32: "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567";
+    /** Crockford's Base32: 0-9A-HJKMNP-TV-Z (no I, L, O, U) */
+    readonly Base32Crockford: "0123456789ABCDEFGHJKMNPQRSTVWXYZ";
+    /** Alphanumeric: 0-9A-Z */
+    readonly Base36: "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ";
+    /** Letters only: A-Za-z */
+    readonly Base52: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+    /** Bitcoin alphabet: 1-9A-HJ-NP-Za-km-z (no 0, O, I, l) */
+    readonly Base58: "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
+    /** Standard Base64: A-Za-z0-9+/ */
+    readonly Base64: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+    /** URL-safe Base64: A-Za-z0-9-_ */
+    readonly Base64Url: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_";
+    /** XML token Base64: A-Za-z0-9._ */
+    readonly Base64Xml: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789._";
+    /** XML name Base64: A-Za-z0-9_: */
+    readonly Base64XmlName: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_:";
+    /** ASCII85 encoding */
+    readonly Ascii85: "!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^_`abcdefghijklmnopqrstu";
+    /** Base85 encoding */
+    readonly Base85: "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!#$%&()*+-;<=>?@^_`{|}~";
+    /** ZeroMQ Z85 encoding */
+    readonly Z85: "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-:+=^!/*?&<>()[]{}@%$#";
+};
+/**
+ * Resolves a base name or character set string to a character set.
+ *
+ * This function is used internally by the function API to convert
+ * base names (like `'base58'`) to their character sets.
+ *
+ * @param base - Base name (e.g., `'base58'`) or custom character set string
+ * @returns The character set string
+ * @throws {UnknownBaseError} If base name is not recognized and string length <= 15
+ *
+ * @example
+ * ```typescript
+ * import { resolveChars } from 'bufferbase';
+ *
+ * resolveChars('base58'); // Returns Bitcoin alphabet
+ * resolveChars('0123456789ABCDEF'); // Returns the string as-is (custom charset)
+ * resolveChars('invalid'); // Throws UnknownBaseError
+ * ```
+ */
+export declare function resolveChars(base: BaseName | string): string;
+/**
+ * Checks if a string is a valid base name.
+ *
+ * @param value - The string to check
+ * @returns `true` if the value is a valid `BaseName`, `false` otherwise
+ *
+ * @example
+ * ```typescript
+ * import { isBaseName } from 'bufferbase';
+ *
+ * isBaseName('base58'); // true
+ * isBaseName('BASE58'); // true (case-insensitive)
+ * isBaseName('unknown'); // false
+ * ```
+ */
+export declare function isBaseName(value: string): value is BaseName;
+//# sourceMappingURL=bases.d.ts.map

package/dist/cjs/bases.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bases.d.ts","sourceRoot":"","sources":["../../src/bases.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAG3C;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,KAAK;IAChB,mBAAmB;;IAEnB,0BAA0B;;IAE1B,8BAA8B;;IAE9B,2DAA2D;;IAE3D,2BAA2B;;IAE3B,2BAA2B;;IAE3B,2DAA2D;;IAE3D,mCAAmC;;IAEnC,mCAAmC;;IAEnC,oCAAoC;;IAEpC,mCAAmC;;IAEnC,uBAAuB;;IAEvB,sBAAsB;;IAEtB,0BAA0B;;CAElB,CAAC;AAwBX;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,CAW5D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,QAAQ,CAE3D"}

package/dist/cjs/bases.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Chars = void 0;
+exports.resolveChars = resolveChars;
+exports.isBaseName = isBaseName;
+const errors_js_1 = require("./errors.js");
+/**
+ * Character sets for common base encodings.
+ *
+ * Use these with `createCodec()` or the deprecated `BufferEncoder` class
+ * when you need direct access to character sets.
+ *
+ * @example
+ * ```typescript
+ * import { Chars, createCodec } from 'bufferbase';
+ *
+ * const codec = createCodec(Chars.Base58);
+ * const encoded = codec.encode(Buffer.from('Hello'));
+ * ```
+ */
+exports.Chars = {
+    /** Base 10: 0-9 */
+    Decimal: '0123456789',
+    /** Hexadecimal: 0-9A-F */
+    Base16: '0123456789ABCDEF',
+    /** RFC 4648 Base32: A-Z2-7 */
+    Base32: 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567',
+    /** Crockford's Base32: 0-9A-HJKMNP-TV-Z (no I, L, O, U) */
+    Base32Crockford: '0123456789ABCDEFGHJKMNPQRSTVWXYZ',
+    /** Alphanumeric: 0-9A-Z */
+    Base36: '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ',
+    /** Letters only: A-Za-z */
+    Base52: 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz',
+    /** Bitcoin alphabet: 1-9A-HJ-NP-Za-km-z (no 0, O, I, l) */
+    Base58: '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz',
+    /** Standard Base64: A-Za-z0-9+/ */
+    Base64: 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/',
+    /** URL-safe Base64: A-Za-z0-9-_ */
+    Base64Url: 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_',
+    /** XML token Base64: A-Za-z0-9._ */
+    Base64Xml: 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789._',
+    /** XML name Base64: A-Za-z0-9_: */
+    Base64XmlName: 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_:',
+    /** ASCII85 encoding */
+    Ascii85: '!"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^_`abcdefghijklmnopqrstu',
+    /** Base85 encoding */
+    Base85: '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!#$%&()*+-;<=>?@^_`{|}~',
+    /** ZeroMQ Z85 encoding */
+    Z85: '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-:+=^!/*?&<>()[]{}@%$#',
+};
+/**
+ * Internal mapping from base names to character sets.
+ * @internal
+ */
+const baseNameToChars = {
+    decimal: exports.Chars.Decimal,
+    base16: exports.Chars.Base16,
+    hex: exports.Chars.Base16,
+    base32: exports.Chars.Base32,
+    base32crockford: exports.Chars.Base32Crockford,
+    base36: exports.Chars.Base36,
+    base52: exports.Chars.Base52,
+    base58: exports.Chars.Base58,
+    base64: exports.Chars.Base64,
+    base64url: exports.Chars.Base64Url,
+    base64xml: exports.Chars.Base64Xml,
+    base64xmlname: exports.Chars.Base64XmlName,
+    ascii85: exports.Chars.Ascii85,
+    base85: exports.Chars.Base85,
+    z85: exports.Chars.Z85,
+};
+/**
+ * Resolves a base name or character set string to a character set.
+ *
+ * This function is used internally by the function API to convert
+ * base names (like `'base58'`) to their character sets.
+ *
+ * @param base - Base name (e.g., `'base58'`) or custom character set string
+ * @returns The character set string
+ * @throws {UnknownBaseError} If base name is not recognized and string length <= 15
+ *
+ * @example
+ * ```typescript
+ * import { resolveChars } from 'bufferbase';
+ *
+ * resolveChars('base58'); // Returns Bitcoin alphabet
+ * resolveChars('0123456789ABCDEF'); // Returns the string as-is (custom charset)
+ * resolveChars('invalid'); // Throws UnknownBaseError
+ * ```
+ */
+function resolveChars(base) {
+    const normalized = base.toLowerCase();
+    if (normalized in baseNameToChars) {
+        return baseNameToChars[normalized];
+    }
+    // If not a known base name, treat as custom character set
+    // (must be longer than 15 chars to distinguish from typos)
+    if (base.length > 15) {
+        return base;
+    }
+    throw new errors_js_1.UnknownBaseError(base);
+}
+/**
+ * Checks if a string is a valid base name.
+ *
+ * @param value - The string to check
+ * @returns `true` if the value is a valid `BaseName`, `false` otherwise
+ *
+ * @example
+ * ```typescript
+ * import { isBaseName } from 'bufferbase';
+ *
+ * isBaseName('base58'); // true
+ * isBaseName('BASE58'); // true (case-insensitive)
+ * isBaseName('unknown'); // false
+ * ```
+ */
+function isBaseName(value) {
+    return value.toLowerCase() in baseNameToChars;
+}
+//# sourceMappingURL=bases.js.map

package/dist/cjs/bases.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bases.js","sourceRoot":"","sources":["../../src/bases.ts"],"names":[],"mappings":";;;AAyFA,oCAWC;AAiBD,gCAEC;AAtHD,2CAA+C;AAE/C;;;;;;;;;;;;;GAaG;AACU,QAAA,KAAK,GAAG;IACnB,mBAAmB;IACnB,OAAO,EAAE,YAAY;IACrB,0BAA0B;IAC1B,MAAM,EAAE,kBAAkB;IAC1B,8BAA8B;IAC9B,MAAM,EAAE,kCAAkC;IAC1C,2DAA2D;IAC3D,eAAe,EAAE,kCAAkC;IACnD,2BAA2B;IAC3B,MAAM,EAAE,sCAAsC;IAC9C,2BAA2B;IAC3B,MAAM,EAAE,sDAAsD;IAC9D,2DAA2D;IAC3D,MAAM,EAAE,4DAA4D;IACpE,mCAAmC;IACnC,MAAM,EAAE,kEAAkE;IAC1E,mCAAmC;IACnC,SAAS,EAAE,kEAAkE;IAC7E,oCAAoC;IACpC,SAAS,EAAE,kEAAkE;IAC7E,mCAAmC;IACnC,aAAa,EAAE,kEAAkE;IACjF,uBAAuB;IACvB,OAAO,EAAE,uFAAuF;IAChG,sBAAsB;IACtB,MAAM,EAAE,uFAAuF;IAC/F,0BAA0B;IAC1B,GAAG,EAAE,uFAAuF;CACpF,CAAC;AAEX;;;GAGG;AACH,MAAM,eAAe,GAA6B;IAChD,OAAO,EAAE,aAAK,CAAC,OAAO;IACtB,MAAM,EAAE,aAAK,CAAC,MAAM;IACpB,GAAG,EAAE,aAAK,CAAC,MAAM;IACjB,MAAM,EAAE,aAAK,CAAC,MAAM;IACpB,eAAe,EAAE,aAAK,CAAC,eAAe;IACtC,MAAM,EAAE,aAAK,CAAC,MAAM;IACpB,MAAM,EAAE,aAAK,CAAC,MAAM;IACpB,MAAM,EAAE,aAAK,CAAC,MAAM;IACpB,MAAM,EAAE,aAAK,CAAC,MAAM;IACpB,SAAS,EAAE,aAAK,CAAC,SAAS;IAC1B,SAAS,EAAE,aAAK,CAAC,SAAS;IAC1B,aAAa,EAAE,aAAK,CAAC,aAAa;IAClC,OAAO,EAAE,aAAK,CAAC,OAAO;IACtB,MAAM,EAAE,aAAK,CAAC,MAAM;IACpB,GAAG,EAAE,aAAK,CAAC,GAAG;CACf,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,YAAY,CAAC,IAAuB;IAClD,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,EAAc,CAAC;IAClD,IAAI,UAAU,IAAI,eAAe,EAAE,CAAC;QAClC,OAAO,eAAe,CAAC,UAAU,CAAC,CAAC;IACrC,CAAC;IACD,0DAA0D;IAC1D,2DAA2D;IAC3D,IAAI,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,IAAI,4BAAgB,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,UAAU,CAAC,KAAa;IACtC,OAAO,KAAK,CAAC,WAAW,EAAE,IAAI,eAAe,CAAC;AAChD,CAAC"}

package/dist/cjs/bufferbase.d.ts

@@ -1,60 +1,43 @@
-/// <reference types="node" />
 /**
- * A collection of common bases.
+ * @deprecated Use the new API instead:
+ * - `encode(buffer, 'base58')` or `base58.encode(buffer)`
+ * - `decode(encoded, 'base58')` or `base58.decode(encoded)`
+ * - `convert(input, 'base58', 'base64')` or `base58.convertTo(base64, input)`
+ * - `validate(input, 'base58')` or `base58.validate(input)`
  */
-export declare const Chars: {
-    Decimal: string;
-    Base16: string;
-    Base32: string;
-    Base32Crockford: string;
-    Base36: string;
-    Base52: string;
-    Base58: string;
-    Base64_STD: string;
-    Base64_URL_SAFE: string;
-    Base64_XML_NMTOKEN: string;
-    Base64_XML_NAME: string;
-    Ascii85: string;
-    Base85: string;
-    Z85: string;
-};
-export declare class InvalidCharacterError extends Error {
-    message: string;
-}
-export declare class BufferSizeError extends Error {
-    message: string;
-}
+import { Buffer } from 'node:buffer';
+import { InvalidCharacterError, BufferSizeError } from './errors.js';
+export { Chars } from './bases.js';
+export { InvalidCharacterError, BufferSizeError };
 /**
- * Encodes and decodes buffers to and from a base.
+ * @deprecated Use `Codec` or `createCodec()` instead.
  */
 export declare class BufferEncoder {
     private baseChars;
+    private codec;
     constructor(baseChars: string);
-    /**
-     * Encodes a buffer to a string.
-     */
     encode(buffer: Buffer): string;
-    /**
-     * Decodes a string to a buffer.
-     */
     decode(encoded: string, bufferSize?: number): Buffer;
 }
 /**
- * Creates a converter function that can convert between two bases.
+ * @deprecated Use `convert()` function or `codec.convertTo()` instead.
  */
 export declare class Converter {
     decoder: BufferEncoder;
     encoder: BufferEncoder;
     constructor(inputBase: string, outputBase: string);
-    /**
-     * Converts a string from the input base to the output base.
-     */
     convert(input: string): string;
 }
+/**
+ * @deprecated Use `validate()` function or `codec.validate()` instead.
+ */
 export declare class Validator {
-    decorder: BufferEncoder;
+    private codec;
     constructor(inputBase: string);
     validate(input: string): boolean;
 }
+/**
+ * @deprecated Use `validate()` from the main module instead.
+ */
 export declare const validate: (input: string, base: string) => boolean;
 //# sourceMappingURL=bufferbase.d.ts.map

package/dist/cjs/bufferbase.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bufferbase.d.ts","sourceRoot":"","sources":["../../src/bufferbase.ts"],"names":[],"mappings":";AAAA;;GAEG;AACH,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;CAqBjB,CAAC;AAEF,qBAAa,qBAAsB,SAAQ,KAAK;IAC9C,OAAO,SAA6B;CACrC;AAED,qBAAa,eAAgB,SAAQ,KAAK;IACxC,OAAO,SAAwC;CAChD;AAED;;GAEG;AACH,qBAAa,aAAa;IACZ,OAAO,CAAC,SAAS;gBAAT,SAAS,EAAE,MAAM;IAErC;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IA2B9B;;OAEG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM;CAgCrD;AAED;;GAEG;AACH,qBAAa,SAAS;IACpB,OAAO,EAAE,aAAa,CAAC;IACvB,OAAO,EAAE,aAAa,CAAC;gBAEX,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAKjD;;OAEG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;CAG/B;AAED,qBAAa,SAAS;IACpB,QAAQ,EAAE,aAAa,CAAC;gBAEZ,SAAS,EAAE,MAAM;IAI7B,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;CAWjC;AAED,eAAO,MAAM,QAAQ,UAAW,MAAM,QAAQ,MAAM,KAAG,OAEtD,CAAC"}
+{"version":3,"file":"bufferbase.d.ts","sourceRoot":"","sources":["../../src/bufferbase.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAGrE,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAGnC,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,CAAC;AAElD;;GAEG;AACH,qBAAa,aAAa;IAGZ,OAAO,CAAC,SAAS;IAF7B,OAAO,CAAC,KAAK,CAAQ;gBAED,SAAS,EAAE,MAAM;IAIrC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAI9B,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM;CAGrD;AAED;;GAEG;AACH,qBAAa,SAAS;IACpB,OAAO,EAAE,aAAa,CAAC;IACvB,OAAO,EAAE,aAAa,CAAC;gBAEX,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAKjD,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;CAG/B;AAED;;GAEG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,KAAK,CAAQ;gBAET,SAAS,EAAE,MAAM;IAI7B,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;CAGjC;AAED;;GAEG;AACH,eAAO,MAAM,QAAQ,GAAI,OAAO,MAAM,EAAE,MAAM,MAAM,KAAG,OAEtD,CAAC"}

package/dist/cjs/bufferbase.js

@@ -1,148 +1,64 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validate = exports.Validator = exports.Converter = exports.BufferEncoder = exports.BufferSizeError = exports.InvalidCharacterError = exports.Chars = void 0;
 /**
- * A collection of common bases.
+ * @deprecated Use the new API instead:
+ * - `encode(buffer, 'base58')` or `base58.encode(buffer)`
+ * - `decode(encoded, 'base58')` or `base58.decode(encoded)`
+ * - `convert(input, 'base58', 'base64')` or `base58.convertTo(base64, input)`
+ * - `validate(input, 'base58')` or `base58.validate(input)`
  */
-exports.Chars = {
-    Decimal: '0123456789',
-    Base16: '0123456789ABCDEF',
-    Base32: 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567',
-    Base32Crockford: '0123456789ABCDEFGHJKMNPQRSTVWXYZ',
-    Base36: '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ',
-    Base52: 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz',
-    Base58: '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz',
-    Base64_STD: 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/',
-    Base64_URL_SAFE: 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_',
-    Base64_XML_NMTOKEN: 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789._',
-    Base64_XML_NAME: 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_:',
-    Ascii85: '!"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^_`abcdefghijklmnopqrstu',
-    Base85: '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!#$%&()*+-;<=>?@^_`{|}~',
-    Z85: '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-:+=^!/*?&<>()[]{}@%$#',
-};
-class InvalidCharacterError extends Error {
-    constructor() {
-        super(...arguments);
-        this.message = 'Invalid character found';
-    }
-}
-exports.InvalidCharacterError = InvalidCharacterError;
-class BufferSizeError extends Error {
-    constructor() {
-        super(...arguments);
-        this.message = 'Buffer size exceeds specified size';
-    }
-}
-exports.BufferSizeError = BufferSizeError;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validate = exports.Validator = exports.Converter = exports.BufferEncoder = exports.BufferSizeError = exports.InvalidCharacterError = exports.Chars = void 0;
+const codec_js_1 = require("./codec.js");
+const errors_js_1 = require("./errors.js");
+Object.defineProperty(exports, "InvalidCharacterError", { enumerable: true, get: function () { return errors_js_1.InvalidCharacterError; } });
+Object.defineProperty(exports, "BufferSizeError", { enumerable: true, get: function () { return errors_js_1.BufferSizeError; } });
+// Re-export Chars for backward compatibility
+var bases_js_1 = require("./bases.js");
+Object.defineProperty(exports, "Chars", { enumerable: true, get: function () { return bases_js_1.Chars; } });
 /**
- * Encodes and decodes buffers to and from a base.
+ * @deprecated Use `Codec` or `createCodec()` instead.
  */
 class BufferEncoder {
     constructor(baseChars) {
         this.baseChars = baseChars;
+        this.codec = new codec_js_1.Codec(baseChars);
     }
-    /**
-     * Encodes a buffer to a string.
-     */
     encode(buffer) {
-        let result = [];
-        for (const byte of buffer) {
-            let carry = byte;
-            for (let j = 0; j < result.length; j++) {
-                carry += result[j] * 256;
-                result[j] = carry % this.baseChars.length;
-                carry = Math.floor(carry / this.baseChars.length);
-            }
-            while (carry > 0) {
-                result.push(carry % this.baseChars.length);
-                carry = Math.floor(carry / this.baseChars.length);
-            }
-        }
-        for (const byte of buffer) {
-            if (byte === 0) {
-                result.push(0);
-            }
-            else {
-                break;
-            }
-        }
-        return result
-            .reverse()
-            .map((index) => this.baseChars[index])
-            .join('');
+        return this.codec.encode(buffer);
     }
-    /**
-     * Decodes a string to a buffer.
-     */
     decode(encoded, bufferSize) {
-        let result = Buffer.alloc(0);
-        for (const char of encoded) {
-            const value = this.baseChars.indexOf(char);
-            if (value === -1)
-                throw new InvalidCharacterError();
-            let carry = value;
-            let tempResult = Buffer.alloc(result.length);
-            let i;
-            for (i = 0; i < result.length; i++) {
-                carry += result[i] * this.baseChars.length;
-                tempResult[i] = carry % 256;
-                carry = Math.floor(carry / 256);
-            }
-            while (carry > 0) {
-                tempResult = Buffer.concat([tempResult, Buffer.from([carry % 256])]);
-                carry = Math.floor(carry / 256);
-            }
-            result = tempResult;
-        }
-        // buffer size
-        if (bufferSize && result.length < bufferSize) {
-            result = Buffer.concat([
-                result,
-                Buffer.from(Array(bufferSize - result.length).fill(0)),
-            ]);
-        }
-        if (bufferSize && result.length > bufferSize) {
-            throw new BufferSizeError();
-        }
-        result.reverse();
-        return result;
+        return this.codec.decode(encoded, bufferSize !== undefined ? { size: bufferSize } : undefined);
     }
 }
 exports.BufferEncoder = BufferEncoder;
 /**
- * Creates a converter function that can convert between two bases.
+ * @deprecated Use `convert()` function or `codec.convertTo()` instead.
  */
 class Converter {
     constructor(inputBase, outputBase) {
         this.decoder = new BufferEncoder(inputBase);
         this.encoder = new BufferEncoder(outputBase);
     }
-    /**
-     * Converts a string from the input base to the output base.
-     */
     convert(input) {
         return this.encoder.encode(this.decoder.decode(input));
     }
 }
 exports.Converter = Converter;
+/**
+ * @deprecated Use `validate()` function or `codec.validate()` instead.
+ */
 class Validator {
     constructor(inputBase) {
-        this.decorder = new BufferEncoder(inputBase);
+        this.codec = new codec_js_1.Codec(inputBase);
     }
     validate(input) {
-        try {
-            this.decorder.decode(input);
-            return true;
-        }
-        catch (e) {
-            if (e instanceof InvalidCharacterError) {
-                return false;
-            }
-            throw e;
-        }
+        return this.codec.validate(input);
     }
 }
 exports.Validator = Validator;
+/**
+ * @deprecated Use `validate()` from the main module instead.
+ */
 const validate = (input, base) => {
     return new Validator(base).validate(input);
 };

package/dist/cjs/bufferbase.js.map

@@ -1 +1 @@
-{"version":3,"file":"bufferbase.js","sourceRoot":"","sources":["../../src/bufferbase.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACU,QAAA,KAAK,GAAG;IACnB,OAAO,EAAE,YAAY;IACrB,MAAM,EAAE,kBAAkB;IAC1B,MAAM,EAAE,kCAAkC;IAC1C,eAAe,EAAE,kCAAkC;IACnD,MAAM,EAAE,sCAAsC;IAC9C,MAAM,EAAE,sDAAsD;IAC9D,MAAM,EAAE,4DAA4D;IACpE,UAAU,EACR,kEAAkE;IACpE,eAAe,EACb,kEAAkE;IACpE,kBAAkB,EAChB,kEAAkE;IACpE,eAAe,EACb,kEAAkE;IACpE,OAAO,EACL,uFAAuF;IACzF,MAAM,EACJ,uFAAuF;IACzF,GAAG,EAAE,uFAAuF;CAC7F,CAAC;AAEF,MAAa,qBAAsB,SAAQ,KAAK;IAAhD;;QACE,YAAO,GAAG,yBAAyB,CAAC;IACtC,CAAC;CAAA;AAFD,sDAEC;AAED,MAAa,eAAgB,SAAQ,KAAK;IAA1C;;QACE,YAAO,GAAG,oCAAoC,CAAC;IACjD,CAAC;CAAA;AAFD,0CAEC;AAED;;GAEG;AACH,MAAa,aAAa;IACxB,YAAoB,SAAiB;QAAjB,cAAS,GAAT,SAAS,CAAQ;IAAG,CAAC;IAEzC;;OAEG;IACH,MAAM,CAAC,MAAc;QACnB,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,IAAI,KAAK,GAAG,IAAI,CAAC;YACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACvC,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;gBACzB,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;gBAC1C,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YACpD,CAAC;YACD,OAAO,KAAK,GAAG,CAAC,EAAE,CAAC;gBACjB,MAAM,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBAC3C,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gBACf,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACjB,CAAC;iBAAM,CAAC;gBACN,MAAM;YACR,CAAC;QACH,CAAC;QACD,OAAO,MAAM;aACV,OAAO,EAAE;aACT,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;aACrC,IAAI,CAAC,EAAE,CAAC,CAAC;IACd,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,OAAe,EAAE,UAAmB;QACzC,IAAI,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC7B,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC3C,IAAI,KAAK,KAAK,CAAC,CAAC;gBAAE,MAAM,IAAI,qBAAqB,EAAE,CAAC;YACpD,IAAI,KAAK,GAAG,KAAK,CAAC;YAClB,IAAI,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC7C,IAAI,CAAC,CAAC;YACN,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACnC,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;gBAC3C,UAAU,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,GAAG,CAAC;gBAC5B,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC;YAClC,CAAC;YACD,OAAO,KAAK,GAAG,CAAC,EAAE,CAAC;gBACjB,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBACrE,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC;YAClC,CAAC;YACD,MAAM,GAAG,UAAU,CAAC;QACtB,CAAC;QACD,cAAc;QACd,IAAI,UAAU,IAAI,MAAM,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;YAC7C,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;gBACrB,MAAM;gBACN,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACvD,CAAC,CAAC;QACL,CAAC;QACD,IAAI,UAAU,IAAI,MAAM,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;YAC7C,MAAM,IAAI,eAAe,EAAE,CAAC;QAC9B,CAAC;QACD,MAAM,CAAC,OAAO,EAAE,CAAC;QACjB,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AApED,sCAoEC;AAED;;GAEG;AACH,MAAa,SAAS;IAIpB,YAAY,SAAiB,EAAE,UAAkB;QAC/C,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC;QAC5C,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,KAAa;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACzD,CAAC;CACF;AAfD,8BAeC;AAED,MAAa,SAAS;IAGpB,YAAY,SAAiB;QAC3B,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC;IAED,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC;YACH,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC5B,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,YAAY,qBAAqB,EAAE,CAAC;gBACvC,OAAO,KAAK,CAAC;YACf,CAAC;YACD,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;CACF;AAlBD,8BAkBC;AAEM,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAE,IAAY,EAAW,EAAE;IAC/D,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC7C,CAAC,CAAC;AAFW,QAAA,QAAQ,YAEnB"}
+{"version":3,"file":"bufferbase.js","sourceRoot":"","sources":["../../src/bufferbase.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAGH,yCAAmC;AACnC,2CAAqE;AAM5D,sGANA,iCAAqB,OAMA;AAAE,gGANA,2BAAe,OAMA;AAJ/C,6CAA6C;AAC7C,uCAAmC;AAA1B,iGAAA,KAAK,OAAA;AAKd;;GAEG;AACH,MAAa,aAAa;IAGxB,YAAoB,SAAiB;QAAjB,cAAS,GAAT,SAAS,CAAQ;QACnC,IAAI,CAAC,KAAK,GAAG,IAAI,gBAAK,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,CAAC,MAAc;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAED,MAAM,CAAC,OAAe,EAAE,UAAmB;QACzC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACjG,CAAC;CACF;AAdD,sCAcC;AAED;;GAEG;AACH,MAAa,SAAS;IAIpB,YAAY,SAAiB,EAAE,UAAkB;QAC/C,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC;QAC5C,IAAI,CAAC,OAAO,GAAG,IAAI,aAAa,CAAC,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED,OAAO,CAAC,KAAa;QACnB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACzD,CAAC;CACF;AAZD,8BAYC;AAED;;GAEG;AACH,MAAa,SAAS;IAGpB,YAAY,SAAiB;QAC3B,IAAI,CAAC,KAAK,GAAG,IAAI,gBAAK,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;IAED,QAAQ,CAAC,KAAa;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;CACF;AAVD,8BAUC;AAED;;GAEG;AACI,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAE,IAAY,EAAW,EAAE;IAC/D,OAAO,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC7C,CAAC,CAAC;AAFW,QAAA,QAAQ,YAEnB"}