bufferbase 2.0.0 → 3.0.1

package/dist/cjs/codec-radix.d.ts

@@ -0,0 +1,46 @@
+import { Buffer } from 'node:buffer';
+import type { BufferLike, DecodeOptions, RadixSpec } from './types.js';
+import { BaseCodec } from './codec-base.js';
+/**
+ * Reads the buffer as one big integer and rewrites it in base
+ * `alphabet.length`.
+ *
+ * This is the Base58 family of encodings. It accepts any alphabet and any
+ * input length, but it is not RFC 4648: the output length is not a fixed
+ * function of the input length, so it cannot be streamed, and encoding is
+ * O(n²) in the input size.
+ *
+ * Leading zero bytes carry no value in an integer, so they are recorded
+ * separately as leading `alphabet[0]` characters.
+ *
+ * @example
+ * ```typescript
+ * import { RadixCodec } from 'bufferbase';
+ *
+ * const binary = new RadixCodec({ alphabet: '01', algorithm: 'radix' });
+ * binary.encode(Uint8Array.of(5)); // '101'
+ * ```
+ */
+export declare class RadixCodec extends BaseCodec {
+    readonly algorithm: "radix";
+    /** Alphabet plus the extra check symbols, or `null` when unchecked. */
+    private readonly checkChars;
+    /** Value of every character a check symbol may be written as. */
+    private readonly checkValues;
+    constructor(spec: RadixSpec);
+    encode(input: BufferLike): string;
+    decode(encoded: string, options?: DecodeOptions): Buffer;
+    validate(input: string): boolean;
+    /**
+     * Decodes the body, verifying the check symbol when the codec carries one.
+     *
+     * Everything `decode` can reject other than `DecodeOptions.size` is checked
+     * here, so `validate` and `decode` always agree.
+     */
+    private read;
+    /** Rewrites the digits of `body` as bytes, most significant first. */
+    private toBytes;
+    /** The value the bytes denote, modulo `divisor`. */
+    private remainderOf;
+}
+//# sourceMappingURL=codec-radix.d.ts.map

package/dist/cjs/codec-radix.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"codec-radix.d.ts","sourceRoot":"","sources":["../../src/codec-radix.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvE,OAAO,EAAE,SAAS,EAAY,MAAM,iBAAiB,CAAC;AAStD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,UAAW,SAAQ,SAAS;IACvC,QAAQ,CAAC,SAAS,EAAG,OAAO,CAAU;IAEtC,uEAAuE;IACvE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;IAE3C,iEAAiE;IACjE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA8B;gBAE9C,IAAI,EAAE,SAAS;IA6B3B,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM;IAgCjC,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM;IAexD,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAmBhC;;;;;OAKG;IACH,OAAO,CAAC,IAAI;IAmBZ,sEAAsE;IACtE,OAAO,CAAC,OAAO;IAoCf,oDAAoD;IACpD,OAAO,CAAC,WAAW;CAOpB"}

package/dist/cjs/codec-radix.js

@@ -0,0 +1,181 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RadixCodec = void 0;
+const node_buffer_1 = require("node:buffer");
+const codec_base_js_1 = require("./codec-base.js");
+const errors_js_1 = require("./errors.js");
+/**
+ * Reads the buffer as one big integer and rewrites it in base
+ * `alphabet.length`.
+ *
+ * This is the Base58 family of encodings. It accepts any alphabet and any
+ * input length, but it is not RFC 4648: the output length is not a fixed
+ * function of the input length, so it cannot be streamed, and encoding is
+ * O(n²) in the input size.
+ *
+ * Leading zero bytes carry no value in an integer, so they are recorded
+ * separately as leading `alphabet[0]` characters.
+ *
+ * @example
+ * ```typescript
+ * import { RadixCodec } from 'bufferbase';
+ *
+ * const binary = new RadixCodec({ alphabet: '01', algorithm: 'radix' });
+ * binary.encode(Uint8Array.of(5)); // '101'
+ * ```
+ */
+class RadixCodec extends codec_base_js_1.BaseCodec {
+    constructor(spec) {
+        super(spec);
+        this.algorithm = 'radix';
+        const extra = spec.checkSymbols;
+        if (extra === undefined || extra === '') {
+            this.checkChars = null;
+            this.checkValues = new Map();
+            return;
+        }
+        const combined = spec.alphabet + extra;
+        if (new Set(combined).size !== combined.length) {
+            throw new errors_js_1.InvalidCodecError('checkSymbols repeat a character of the alphabet');
+        }
+        // The symbol is matched by value, so that a case-insensitive codec accepts
+        // it in either case just as it does the rest of the string.
+        const values = new Map();
+        for (let i = 0; i < combined.length; i++) {
+            const char = combined[i];
+            values.set(char, i);
+            if (spec.caseInsensitive === true) {
+                values.set(char.toLowerCase(), i);
+                values.set(char.toUpperCase(), i);
+            }
+        }
+        this.checkChars = combined;
+        this.checkValues = values;
+    }
+    encode(input) {
+        const buffer = (0, codec_base_js_1.toBuffer)(input);
+        const base = this.chars.length;
+        const digits = [];
+        for (const byte of buffer) {
+            let carry = byte;
+            for (let i = 0; i < digits.length; i++) {
+                carry += digits[i] * 256;
+                digits[i] = carry % base;
+                carry = Math.floor(carry / base);
+            }
+            while (carry > 0) {
+                digits.push(carry % base);
+                carry = Math.floor(carry / base);
+            }
+        }
+        for (let i = 0; i < buffer.length && buffer[i] === 0; i++) {
+            digits.push(0);
+        }
+        let out = '';
+        for (let i = digits.length - 1; i >= 0; i--) {
+            out += this.chars[digits[i]];
+        }
+        if (this.checkChars !== null) {
+            out += this.checkChars[this.remainderOf(buffer, this.checkChars.length)];
+        }
+        return out;
+    }
+    decode(encoded, options) {
+        const bytes = this.read(this.strip(encoded));
+        const size = options?.size;
+        if (size === undefined) {
+            return node_buffer_1.Buffer.from(bytes);
+        }
+        if (bytes.length > size) {
+            throw new errors_js_1.BufferSizeError(bytes.length, size);
+        }
+        const padded = node_buffer_1.Buffer.alloc(size);
+        node_buffer_1.Buffer.from(bytes).copy(padded, size - bytes.length);
+        return padded;
+    }
+    validate(input) {
+        const stripped = this.strip(input);
+        if (this.checkChars === null) {
+            // Every string over the alphabet decodes, so the characters settle it.
+            for (let i = 0; i < stripped.length; i++) {
+                if (this.valueAt(stripped, i) < 0) {
+                    return false;
+                }
+            }
+            return true;
+        }
+        try {
+            this.read(stripped);
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    /**
+     * Decodes the body, verifying the check symbol when the codec carries one.
+     *
+     * Everything `decode` can reject other than `DecodeOptions.size` is checked
+     * here, so `validate` and `decode` always agree.
+     */
+    read(input) {
+        let body = input;
+        if (this.checkChars !== null) {
+            if (body.length === 0) {
+                throw new errors_js_1.InvalidLengthError(0, 'a checked encoding always carries a check symbol');
+            }
+            const found = body.slice(-1);
+            body = body.slice(0, -1);
+            const bytes = this.toBytes(body);
+            const expected = this.remainderOf(bytes, this.checkChars.length);
+            if (this.checkValues.get(found) !== expected) {
+                throw new errors_js_1.CheckSymbolError(found, this.checkChars[expected]);
+            }
+            return bytes;
+        }
+        return this.toBytes(input);
+    }
+    /** Rewrites the digits of `body` as bytes, most significant first. */
+    toBytes(body) {
+        const base = this.chars.length;
+        const bytes = [];
+        let leadingZeros = 0;
+        let stillLeading = true;
+        for (let at = 0; at < body.length; at++) {
+            const value = this.valueAt(body, at);
+            if (value < 0) {
+                throw new errors_js_1.InvalidCharacterError(body[at]);
+            }
+            if (stillLeading && value === 0) {
+                leadingZeros++;
+                continue;
+            }
+            stillLeading = false;
+            let carry = value;
+            for (let i = 0; i < bytes.length; i++) {
+                carry += bytes[i] * base;
+                bytes[i] = carry % 256;
+                carry = Math.floor(carry / 256);
+            }
+            while (carry > 0) {
+                bytes.push(carry % 256);
+                carry = Math.floor(carry / 256);
+            }
+        }
+        for (let i = 0; i < leadingZeros; i++) {
+            bytes.push(0);
+        }
+        bytes.reverse();
+        return bytes;
+    }
+    /** The value the bytes denote, modulo `divisor`. */
+    remainderOf(bytes, divisor) {
+        let remainder = 0;
+        for (const byte of bytes) {
+            remainder = (remainder * 256 + byte) % divisor;
+        }
+        return remainder;
+    }
+}
+exports.RadixCodec = RadixCodec;
+//# sourceMappingURL=codec-radix.js.map

package/dist/cjs/codec-radix.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codec-radix.js","sourceRoot":"","sources":["../../src/codec-radix.ts"],"names":[],"mappings":";;;AAAA,6CAAqC;AAErC,mDAAsD;AACtD,2CAMqB;AAErB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,UAAW,SAAQ,yBAAS;IASvC,YAAY,IAAe;QACzB,KAAK,CAAC,IAAI,CAAC,CAAC;QATL,cAAS,GAAG,OAAgB,CAAC;QAWpC,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC;QAChC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;YACxC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;YACvB,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAE,CAAC;YAC7B,OAAO;QACT,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACvC,IAAI,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC/C,MAAM,IAAI,6BAAiB,CAAC,iDAAiD,CAAC,CAAC;QACjF,CAAC;QAED,2EAA2E;QAC3E,4DAA4D;QAC5D,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;QACzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACzC,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YACzB,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YACpB,IAAI,IAAI,CAAC,eAAe,KAAK,IAAI,EAAE,CAAC;gBAClC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;gBAClC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC;QAC3B,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;IAC5B,CAAC;IAED,MAAM,CAAC,KAAiB;QACtB,MAAM,MAAM,GAAG,IAAA,wBAAQ,EAAC,KAAK,CAAC,CAAC;QAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;QAC/B,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,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;gBACzB,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,KAAK,GAAG,CAAC,EAAE,CAAC;gBACjB,MAAM,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;gBAC1B,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC1D,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjB,CAAC;QAED,IAAI,GAAG,GAAG,EAAE,CAAC;QACb,KAAK,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5C,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/B,CAAC;QACD,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;YAC7B,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;QAC3E,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED,MAAM,CAAC,OAAe,EAAE,OAAuB;QAC7C,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QAE7C,MAAM,IAAI,GAAG,OAAO,EAAE,IAAI,CAAC;QAC3B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,oBAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC;YACxB,MAAM,IAAI,2BAAe,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAChD,CAAC;QACD,MAAM,MAAM,GAAG,oBAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClC,oBAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QACrD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,QAAQ,CAAC,KAAa;QACpB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACnC,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;YAC7B,uEAAuE;YACvE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACzC,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;oBAClC,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACpB,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACK,IAAI,CAAC,KAAa;QACxB,IAAI,IAAI,GAAG,KAAK,CAAC;QAEjB,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;YAC7B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACtB,MAAM,IAAI,8BAAkB,CAAC,CAAC,EAAE,kDAAkD,CAAC,CAAC;YACtF,CAAC;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACzB,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YACjE,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAE,CAAC;gBAC7C,MAAM,IAAI,4BAAgB,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC/D,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED,sEAAsE;IAC9D,OAAO,CAAC,IAAY;QAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;QAC/B,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAI,YAAY,GAAG,CAAC,CAAC;QACrB,IAAI,YAAY,GAAG,IAAI,CAAC;QAExB,KAAK,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC;YACxC,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACrC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACd,MAAM,IAAI,iCAAqB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;YAC5C,CAAC;YACD,IAAI,YAAY,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;gBAChC,YAAY,EAAE,CAAC;gBACf,SAAS;YACX,CAAC;YACD,YAAY,GAAG,KAAK,CAAC;YAErB,IAAI,KAAK,GAAG,KAAK,CAAC;YAClB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACtC,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;gBACzB,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,GAAG,CAAC;gBACvB,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC;YAClC,CAAC;YACD,OAAO,KAAK,GAAG,CAAC,EAAE,CAAC;gBACjB,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC;gBACxB,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC;YAClC,CAAC;QACH,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChB,CAAC;QACD,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,oDAAoD;IAC5C,WAAW,CAAC,KAAuB,EAAE,OAAe;QAC1D,IAAI,SAAS,GAAG,CAAC,CAAC;QAClB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,SAAS,GAAG,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC;QACjD,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AA9KD,gCA8KC"}

package/dist/cjs/codec.d.ts

@@ -1,124 +1,38 @@
-import { Buffer } from 'node:buffer';
-import type { ICodec, DecodeOptions, BufferLike } from './types.js';
+import type { CodecSpec, ICodec } from './types.js';
+import { RadixCodec } from './codec-radix.js';
 /**
- * Codec for encoding and decoding buffers to/from a specific base.
+ * Builds the codec described by a spec.
  *
- * Use pre-defined codecs from `Codecs` for common encodings,
- * or create custom codecs with `createCodec()`.
+ * A bare string is read as a custom alphabet for a radix conversion, which is
+ * the only algorithm that works with an alphabet of any length.
  *
  * @example
  * ```typescript
- * import { Codec, Codecs, createCodec } from 'bufferbase';
- *
- * // Use pre-defined codec
- * const encoded = Codecs.base58.encode(Buffer.from('Hello'));
+ * import { createCodec } from 'bufferbase';
  *
- * // Create custom codec
  * const binary = createCodec('01');
- * const bits = binary.encode(Buffer.from([5])); // '101'
+ * binary.encode(Uint8Array.of(5)); // '101'
+ *
+ * const paddedHex = createCodec({ alphabet: '0123456789abcdef', algorithm: 'block' });
+ * paddedHex.encode(Uint8Array.of(0, 1)); // '0001'
  * ```
  */
-export declare class Codec implements ICodec {
-    /** Character set used for encoding. */
-    readonly chars: string;
-    /** @internal */
-    private readonly charToIndex;
-    /**
-     * Creates a new codec with the specified character set.
-     * @param chars - The character set to use for encoding/decoding
-     */
-    constructor(chars: string);
-    /**
-     * Encodes a buffer to a base-encoded string.
-     *
-     * Leading zero bytes in the buffer are preserved as the first character
-     * of the encoding alphabet (e.g., '1' for Base58).
-     *
-     * @param input - The buffer or Uint8Array to encode
-     * @returns Base-encoded string
-     *
-     * @example
-     * ```typescript
-     * const codec = Codecs.base58;
-     * codec.encode(Buffer.from('Hello')); // '9Ajdvzr'
-     * codec.encode(new Uint8Array([0, 0, 1])); // '112' (preserves leading zeros)
-     * ```
-     */
-    encode(input: BufferLike): string;
-    /**
-     * Decodes a base-encoded string to a buffer.
-     *
-     * Leading characters that represent zero (first char of alphabet)
-     * are converted to leading zero bytes in the result.
-     *
-     * @param encoded - The string to decode
-     * @param options - Decode options
-     * @returns Decoded buffer
-     * @throws {InvalidCharacterError} If the string contains invalid characters
-     * @throws {BufferSizeError} If the result exceeds the specified size
-     *
-     * @example
-     * ```typescript
-     * const codec = Codecs.base58;
-     * codec.decode('9Ajdvzr'); // Buffer('Hello')
-     * codec.decode('9Ajdvzr', { size: 32 }); // Pads to 32 bytes
-     * ```
-     */
-    decode(encoded: string, options?: DecodeOptions): Buffer;
-    /**
-     * Validates if a string contains only valid characters for this base.
-     *
-     * This is a fast check that doesn't perform full decoding.
-     *
-     * @param input - The string to validate
-     * @returns `true` if all characters are valid, `false` otherwise
-     *
-     * @example
-     * ```typescript
-     * Codecs.base58.validate('9Ajdvzr'); // true
-     * Codecs.base58.validate('0invalid'); // false ('0' not in Base58)
-     * ```
-     */
-    validate(input: string): boolean;
-    /**
-     * Converts a string from this base to another base.
-     *
-     * Internally decodes to a buffer, then encodes with the target codec.
-     *
-     * @param target - Target codec to convert to
-     * @param input - The string to convert
-     * @returns String in the target base encoding
-     * @throws {InvalidCharacterError} If the input contains invalid characters
-     *
-     * @example
-     * ```typescript
-     * const base58str = '9Ajdvzr';
-     * const base64str = Codecs.base58.convertTo(Codecs.base64url, base58str);
-     * ```
-     */
-    convertTo(target: ICodec, input: string): string;
-}
+export declare function createCodec(spec: CodecSpec | string): ICodec;
 /**
- * Creates a new codec with the specified character set.
- *
- * Use this to create codecs for custom base encodings.
- * The base is determined by the length of the character set.
- *
- * @param chars - The character set to use for encoding/decoding
- * @returns A new Codec instance
- *
- * @example
- * ```typescript
- * import { createCodec } from 'bufferbase';
+ * Returns the codec for a spec, building it once per spec object.
  *
- * // Binary codec (base 2)
- * const binary = createCodec('01');
- * binary.encode(Buffer.from([5])); // '101'
- *
- * // Octal codec (base 8)
- * const octal = createCodec('01234567');
- * octal.encode(Buffer.from([255])); // '377'
- * ```
+ * Named bases always resolve to the same spec object, so they are built once
+ * for the lifetime of the process.
  */
-export declare function createCodec(chars: string): Codec;
+export declare function getCodec(spec: CodecSpec): ICodec;
+export { RadixCodec } from './codec-radix.js';
+export { BlockCodec } from './codec-block.js';
+export { Block85Codec } from './codec-block85.js';
+/**
+ * @deprecated Use `createCodec({ alphabet, algorithm: 'radix' })`, or
+ * `createCodec(alphabet)` for the same thing.
+ */
+export declare class Codec extends RadixCodec {
+    constructor(chars: string);
+}
 //# sourceMappingURL=codec.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"codec.d.ts","sourceRoot":"","sources":["../../src/codec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAcpE;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,KAAM,YAAW,MAAM;IAClC,uCAAuC;IACvC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB,gBAAgB;IAChB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsB;IAElD;;;OAGG;gBACS,KAAK,EAAE,MAAM;IAQzB;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM;IA6CjC;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM;IAgExD;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAShC;;;;;;;;;;;;;;;OAeG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;CAIjD;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,CAEhD"}
+{"version":3,"file":"codec.d.ts","sourceRoot":"","sources":["../../src/codec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAI9C;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,GAAG,MAAM,CAY5D;AAID;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAQhD;AAED,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;;GAGG;AACH,qBAAa,KAAM,SAAQ,UAAU;gBACvB,KAAK,EAAE,MAAM;CAG1B"}