@pfeiferio/custom-base 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Pascal Pfeifer <pascal@pfeifer.zone>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,112 @@
+# @pfeiferio/custom-base
+
+Custom base encoding and decoding for numbers and BigInts using arbitrary charsets.
+
+This library allows you to encode and decode numeric values using **any character set**.
+It supports both JavaScript `number` and `bigint` types and is fully ESM-based with no dependencies.
+
+---
+
+## Features
+
+- Encode / decode `number` and `bigint`
+- Arbitrary custom charsets
+- Built-in presets (base2, base16, base42, base128)
+- Cached and validated charset handling
+- Zero dependencies
+- Native Node.js test runner
+
+---
+
+## Installation
+
+```bash
+npm install @pfeiferio/custom-base
+````
+
+---
+
+## Usage
+
+### Encoding and decoding numbers
+
+```js
+import { encodeNumber, decodeNumber, presets } from '@pfeiferio/custom-base'
+
+const encoded = encodeNumber(255, presets.base16)
+const decoded = decodeNumber(encoded, presets.base16)
+
+console.log(encoded) // "ff"
+console.log(decoded) // 255
+```
+
+---
+
+### Encoding and decoding BigInts
+
+```js
+import { encodeBigInt, decodeBigInt, presets } from '@pfeiferio/custom-base'
+
+const value = 12345678901234567890n
+
+const encoded = encodeBigInt(value, presets.base42)
+const decoded = decodeBigInt(encoded, presets.base42)
+
+console.log(decoded === value) // true
+```
+
+---
+
+### Custom charsets
+
+You can provide your own charset as a string:
+
+```js
+import { encodeNumber } from '@pfeiferio/custom-base'
+
+const charset = 'ABCDEFG123456'
+const encoded = encodeNumber(1337, charset)
+```
+
+---
+
+### Charset normalization
+
+Internally, charsets are compiled, validated and cached.
+You can normalize inputs manually if needed:
+
+```js
+import { ensureCharset, presets } from '@pfeiferio/custom-base'
+
+const charset = ensureCharset(presets.base2)
+```
+
+The returned `Charset` object is immutable and guaranteed to be valid.
+
+---
+
+## Presets
+
+```js
+import { presets } from '@pfeiferio/custom-base'
+
+presets.base2
+presets.base16
+presets.base42
+presets.base128
+```
+
+All presets are non-standard and provided purely for convenience.
+
+---
+
+## Node.js Support
+
+* Node.js ≥ 18
+* ESM only
+
+---
+
+## License
+
+MIT

package/dist/Charset.d.ts

@@ -0,0 +1,30 @@
+type Presets = {
+    readonly base128: string;
+    readonly base42: string;
+    readonly base2: string;
+    readonly base16: string;
+};
+export declare const presets: Presets;
+interface CharsMapPartial<T> {
+    readonly map: Readonly<Record<string, T>>;
+    readonly base: T;
+}
+export interface Charset {
+    readonly chars: string;
+    readonly int: CharsMapPartial<number>;
+    readonly bigInt: CharsMapPartial<bigint>;
+    /** internal brand – do not rely on */
+    readonly [charsetBrand]: boolean;
+}
+declare const charsetBrand: unique symbol;
+export declare const isCharset: (map: any) => map is Charset;
+export declare const ensureCharset: (charset: string | Charset) => Charset;
+/**
+ * Creates a map where each character in the given character set is assigned its index within the set.
+ * This is useful for converting characters to their numeric values in custom numeral systems.
+ * @param {string} chars - The character set to map.
+ * @returns {Charset}
+ */
+export declare const createCharsMap: (chars: string) => Charset;
+export {};
+//# sourceMappingURL=Charset.d.ts.map

package/dist/Charset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Charset.d.ts","sourceRoot":"","sources":["../src/Charset.ts"],"names":[],"mappings":"AAAA,KAAK,OAAO,GAAG;IACb,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB,CAAA;AACD,eAAO,MAAM,OAAO,EAAE,OAMrB,CAAA;AAKD,UAAU,eAAe,CAAC,CAAC;IACzB,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAA;IACzC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;CACjB;AAED,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,GAAG,EAAE,eAAe,CAAC,MAAM,CAAC,CAAA;IACrC,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC,MAAM,CAAC,CAAA;IAExC,sCAAsC;IACtC,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,OAAO,CAAA;CACjC;AAED,QAAA,MAAM,YAAY,EAAE,OAAO,MAAiB,CAAA;AAG5C,eAAO,MAAM,SAAS,GAAI,KAAK,GAAG,KAAG,GAAG,IAAI,OAE3C,CAAA;AAGD,eAAO,MAAM,aAAa,GAAI,SAAS,MAAM,GAAG,OAAO,KAAG,OAGzD,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,OAAO,MAAM,KAAG,OA+B9C,CAAA"}

package/dist/Charset.js

@@ -0,0 +1,55 @@
+export const presets = Object.freeze({
+    base128: '0123456789!"#$%&\'()*+,-./:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^_`abcdefghijklmnopqrstuvwxyz{|}~¡¢£¤¥¦§¨©ª«¬®¯°±²³´µ¶·¸¹º»¼½¾¿ÀÁÂÃ',
+    base42: 'ktTnDFVJHM3Nm2SQCqd51g9XcWl70LwrjfhRKGs4v8',
+    base2: '01',
+    base16: '0123456789abcdef'
+});
+// Object to cache character maps for different character sets.
+const charsetMap = {};
+const charsetBrand = Symbol();
+export const isCharset = (map) => {
+    return map?.[charsetBrand] === true;
+};
+export const ensureCharset = (charset) => {
+    if (isCharset(charset))
+        return charset;
+    return charsetMap[charset] ??= createCharsMap(charset);
+};
+/**
+ * Creates a map where each character in the given character set is assigned its index within the set.
+ * This is useful for converting characters to their numeric values in custom numeral systems.
+ * @param {string} chars - The character set to map.
+ * @returns {Charset}
+ */
+export const createCharsMap = (chars) => {
+    const mapInt = {};
+    const mapBigInt = {};
+    const base = chars.length;
+    for (let i = 0; i < base; i++) {
+        mapInt[chars[i]] = i;
+        mapBigInt[chars[i]] = BigInt(i);
+    }
+    const result = {
+        chars,
+        int: {
+            map: mapInt,
+            base
+        },
+        bigInt: {
+            map: mapBigInt,
+            base: BigInt(base)
+        },
+        [charsetBrand]: true
+    };
+    Object.defineProperty(result, charsetBrand, {
+        value: true,
+        enumerable: false,
+        configurable: false
+    });
+    return charsetMap[chars] = Object.freeze(result);
+};
+ensureCharset(presets.base2);
+ensureCharset(presets.base16);
+ensureCharset(presets.base42);
+ensureCharset(presets.base128);
+//# sourceMappingURL=Charset.js.map

package/dist/Charset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Charset.js","sourceRoot":"","sources":["../src/Charset.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,MAAM,OAAO,GAAY,MAAM,CAAC,MAAM,CAAC;IAC1C,OAAO,EAAE,kIAAkI;IAC3I,MAAM,EAAE,4CAA4C;IACpD,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,kBAAkB;CAC3B,CACF,CAAA;AAED,+DAA+D;AAC/D,MAAM,UAAU,GAA4B,EAAE,CAAA;AAgB9C,MAAM,YAAY,GAAkB,MAAM,EAAE,CAAA;AAG5C,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAQ,EAAkB,EAAE;IACpD,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,IAAI,CAAA;AACrC,CAAC,CAAA;AAGD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,OAAyB,EAAW,EAAE;IAClE,IAAI,SAAS,CAAC,OAAO,CAAC;QAAE,OAAO,OAAO,CAAA;IACtC,OAAO,UAAU,CAAC,OAAO,CAAC,KAAK,cAAc,CAAC,OAAO,CAAC,CAAA;AACxD,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAa,EAAW,EAAE;IAEvD,MAAM,MAAM,GAA2B,EAAE,CAAA;IACzC,MAAM,SAAS,GAA2B,EAAE,CAAA;IAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAA;IAEzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,GAAG,CAAC,CAAA;QACrB,SAAS,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IAClC,CAAC;IAED,MAAM,MAAM,GAAG;QACb,KAAK;QACL,GAAG,EAAE;YACH,GAAG,EAAE,MAAM;YACX,IAAI;SACL;QACD,MAAM,EAAE;YACN,GAAG,EAAE,SAAS;YACd,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;SACnB;QACD,CAAC,YAAY,CAAC,EAAE,IAAI;KACrB,CAAA;IAED,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,YAAY,EAAE;QAC1C,KAAK,EAAE,IAAI;QACX,UAAU,EAAE,KAAK;QACjB,YAAY,EAAE,KAAK;KACpB,CAAC,CAAA;IAEF,OAAO,UAAU,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;AAClD,CAAC,CAAA;AAED,aAAa,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AAC5B,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;AAC7B,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;AAC7B,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA"}

package/dist/decodeBigInt.d.ts

@@ -0,0 +1,12 @@
+import { type Charset } from "./Charset.js";
+/**
+ * Converts a string representation in a custom base back to its integer form as a BigInt.
+ * This function is essential for handling very large numbers that exceed the safe integer limit of Number in JavaScript.
+ *
+ * @param {string} encodedString - The string in the custom base to be converted back to a BigInt.
+ * @param {string} charset - The charset used for the custom base, matching the one used for conversion.
+ * @return {bigint} The BigInt value represented by the custom base string.
+ * @throws {Error} If an invalid character (not found in charset) is encountered in the input string.
+ */
+export declare const decodeBigInt: (encodedString: string, charset: string | Charset) => bigint;
+//# sourceMappingURL=decodeBigInt.d.ts.map

package/dist/decodeBigInt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decodeBigInt.d.ts","sourceRoot":"","sources":["../src/decodeBigInt.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,OAAO,EAAgB,MAAM,cAAc,CAAC;AAEzD;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GAAI,eAAe,MAAM,EAAE,SAAS,MAAM,GAAG,OAAO,KAAG,MAiB/E,CAAA"}

package/dist/decodeBigInt.js

@@ -0,0 +1,28 @@
+import { ensureCharset } from "./Charset.js";
+/**
+ * Converts a string representation in a custom base back to its integer form as a BigInt.
+ * This function is essential for handling very large numbers that exceed the safe integer limit of Number in JavaScript.
+ *
+ * @param {string} encodedString - The string in the custom base to be converted back to a BigInt.
+ * @param {string} charset - The charset used for the custom base, matching the one used for conversion.
+ * @return {bigint} The BigInt value represented by the custom base string.
+ * @throws {Error} If an invalid character (not found in charset) is encountered in the input string.
+ */
+export const decodeBigInt = (encodedString, charset) => {
+    charset = ensureCharset(charset);
+    const { map, base } = charset.bigInt;
+    let currentMultiplier = 1n;
+    const customBaseStringAsArray = encodedString.split('');
+    let result = 0n;
+    let length = encodedString.length - 1;
+    for (let i = length; i >= 0; i -= 1) {
+        const char = customBaseStringAsArray[i];
+        if (map[char] === undefined) {
+            throw new Error(`Invalid character "${customBaseStringAsArray[i]}" in input string.`);
+        }
+        result += currentMultiplier * map[char];
+        currentMultiplier *= base;
+    }
+    return result;
+};
+//# sourceMappingURL=decodeBigInt.js.map

package/dist/decodeBigInt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decodeBigInt.js","sourceRoot":"","sources":["../src/decodeBigInt.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,aAAa,EAAC,MAAM,cAAc,CAAC;AAEzD;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,aAAqB,EAAE,OAAyB,EAAU,EAAE;IAEvF,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,CAAA;IAChC,MAAM,EAAC,GAAG,EAAE,IAAI,EAAC,GAAG,OAAO,CAAC,MAAM,CAAA;IAClC,IAAI,iBAAiB,GAAG,EAAE,CAAA;IAC1B,MAAM,uBAAuB,GAAG,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;IACvD,IAAI,MAAM,GAAG,EAAE,CAAA;IACf,IAAI,MAAM,GAAG,aAAa,CAAC,MAAM,GAAG,CAAC,CAAA;IACrC,KAAK,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,GAAW,uBAAuB,CAAC,CAAC,CAAE,CAAA;QAChD,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,sBAAsB,uBAAuB,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC;QACxF,CAAC;QACD,MAAM,IAAI,iBAAiB,GAAG,GAAG,CAAC,IAAI,CAAC,CAAA;QACvC,iBAAiB,IAAI,IAAI,CAAA;IAC3B,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA"}

package/dist/decodeNumber.d.ts

@@ -0,0 +1,14 @@
+import { type Charset } from "./Charset.js";
+/**
+ * Converts a string representation in a custom base back to its integer form.
+ * This function reverses the conversion process of `convertIntToCustomBase`, turning a custom base
+ * string back into a standard integer. It's essential for the input string to use the same charset
+ * as used for the conversion to the custom base.
+ *
+ * @param {string} encodedString - The string in the custom base to be converted back to an integer.
+ * @param {string|Charset} charset - The charset used for the custom base, matching the one used for conversion.
+ * @return {number} The integer value represented by the custom base string.
+ * @throws {Error} If an invalid character (not found in charset) is encountered in the input string.
+ */
+export declare const decodeNumber: (encodedString: string, charset: string | Charset) => number;
+//# sourceMappingURL=decodeNumber.d.ts.map

package/dist/decodeNumber.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decodeNumber.d.ts","sourceRoot":"","sources":["../src/decodeNumber.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,OAAO,EAAgB,MAAM,cAAc,CAAC;AAEzD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,GAAI,eAAe,MAAM,EAAE,SAAS,MAAM,GAAG,OAAO,KAAG,MAiB/E,CAAA"}

package/dist/decodeNumber.js

@@ -0,0 +1,30 @@
+import { ensureCharset } from "./Charset.js";
+/**
+ * Converts a string representation in a custom base back to its integer form.
+ * This function reverses the conversion process of `convertIntToCustomBase`, turning a custom base
+ * string back into a standard integer. It's essential for the input string to use the same charset
+ * as used for the conversion to the custom base.
+ *
+ * @param {string} encodedString - The string in the custom base to be converted back to an integer.
+ * @param {string|Charset} charset - The charset used for the custom base, matching the one used for conversion.
+ * @return {number} The integer value represented by the custom base string.
+ * @throws {Error} If an invalid character (not found in charset) is encountered in the input string.
+ */
+export const decodeNumber = (encodedString, charset) => {
+    charset = ensureCharset(charset);
+    const { map, base } = charset.int;
+    let currentMultiplier = 1;
+    const customBaseStringAsArray = encodedString.split('');
+    let result = 0;
+    let length = encodedString.length - 1;
+    for (let i = length; i >= 0; i -= 1) {
+        const char = customBaseStringAsArray[i];
+        if (map[char] === undefined) {
+            throw new Error(`Invalid character "${customBaseStringAsArray[i]}" in input string.`);
+        }
+        result += currentMultiplier * map[char];
+        currentMultiplier *= base;
+    }
+    return result;
+};
+//# sourceMappingURL=decodeNumber.js.map

package/dist/decodeNumber.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decodeNumber.js","sourceRoot":"","sources":["../src/decodeNumber.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,aAAa,EAAC,MAAM,cAAc,CAAC;AAEzD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,aAAqB,EAAE,OAAyB,EAAU,EAAE;IAEvF,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,CAAA;IAChC,MAAM,EAAC,GAAG,EAAE,IAAI,EAAC,GAAG,OAAO,CAAC,GAAG,CAAA;IAC/B,IAAI,iBAAiB,GAAG,CAAC,CAAA;IACzB,MAAM,uBAAuB,GAAG,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;IACvD,IAAI,MAAM,GAAG,CAAC,CAAA;IACd,IAAI,MAAM,GAAG,aAAa,CAAC,MAAM,GAAG,CAAC,CAAA;IACrC,KAAK,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,GAAW,uBAAuB,CAAC,CAAC,CAAE,CAAA;QAChD,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,sBAAsB,uBAAuB,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC;QACxF,CAAC;QACD,MAAM,IAAI,iBAAiB,GAAG,GAAG,CAAC,IAAI,CAAC,CAAA;QACvC,iBAAiB,IAAI,IAAI,CAAA;IAC3B,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA"}

package/dist/encodeBigInt.d.ts

@@ -0,0 +1,11 @@
+import { type Charset } from "./Charset.js";
+/**
+ * Converts a bigint to a string representation in a custom base using a predefined charset.
+ * This function allows converting big integers into a string format based on any custom numeric system,
+ * as long as the charset provides the symbols for that base.
+ * @param {bigint} number
+ * @param charset
+ * @returns {string}
+ */
+export declare const encodeBigInt: (number: bigint, charset: string | Charset) => string;
+//# sourceMappingURL=encodeBigInt.d.ts.map

package/dist/encodeBigInt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encodeBigInt.d.ts","sourceRoot":"","sources":["../src/encodeBigInt.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,OAAO,EAAgB,MAAM,cAAc,CAAC;AAEzD;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,GAAI,QAAQ,MAAM,EAAE,SAAS,MAAM,GAAG,OAAO,KAAG,MAkBxE,CAAA"}

package/dist/encodeBigInt.js

@@ -0,0 +1,26 @@
+import { ensureCharset } from "./Charset.js";
+/**
+ * Converts a bigint to a string representation in a custom base using a predefined charset.
+ * This function allows converting big integers into a string format based on any custom numeric system,
+ * as long as the charset provides the symbols for that base.
+ * @param {bigint} number
+ * @param charset
+ * @returns {string}
+ */
+export const encodeBigInt = (number, charset) => {
+    charset = ensureCharset(charset);
+    const base = charset.bigInt.base;
+    const characters = charset.chars;
+    let result = '';
+    if (number < base) {
+        return characters.charAt(Number(number));
+    }
+    while (number > 0) {
+        const index = number % base;
+        result = characters.charAt(Number(index)) + result;
+        number /= base;
+        // number = Math.floor(number / base);
+    }
+    return result;
+};
+//# sourceMappingURL=encodeBigInt.js.map

package/dist/encodeBigInt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encodeBigInt.js","sourceRoot":"","sources":["../src/encodeBigInt.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,aAAa,EAAC,MAAM,cAAc,CAAC;AAEzD;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAAc,EAAE,OAAyB,EAAU,EAAE;IAEhF,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,CAAA;IAChC,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA;IAChC,MAAM,UAAU,GAAG,OAAO,CAAC,KAAK,CAAA;IAChC,IAAI,MAAM,GAAG,EAAE,CAAA;IAEf,IAAI,MAAM,GAAG,IAAI,EAAE,CAAC;QAClB,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAA;IAC1C,CAAC;IAED,OAAO,MAAM,GAAG,CAAC,EAAE,CAAC;QAClB,MAAM,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;QAC5B,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,MAAM,CAAA;QAClD,MAAM,IAAI,IAAI,CAAC;QACf,sCAAsC;IACxC,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA"}

package/dist/encodeNumber.d.ts

@@ -0,0 +1,12 @@
+import { type Charset } from "./Charset.js";
+/**
+ * Converts an integer to a string representation in a custom base using a predefined charset.
+ * This function allows converting numbers into a string format based on any custom numeric system,
+ * as long as the charset provides the symbols for that base.
+ *
+ * @param {number} number - The integer value to be converted into the custom base.
+ * @param {string} charset - A string representing all the symbols used in the custom base, ordered from 0 upwards.
+ * @return {string} The string representation of the integer in the custom base.
+ */
+export declare const encodeNumber: (number: number, charset: string | Charset) => string;
+//# sourceMappingURL=encodeNumber.d.ts.map

package/dist/encodeNumber.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"encodeNumber.d.ts","sourceRoot":"","sources":["../src/encodeNumber.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,OAAO,EAAY,MAAM,cAAc,CAAC;AAErD;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY,GAAI,QAAQ,MAAM,EAAE,SAAS,MAAM,GAAG,OAAO,KAAG,MAkBxE,CAAA"}

package/dist/encodeNumber.js

@@ -0,0 +1,26 @@
+import { isCharset } from "./Charset.js";
+/**
+ * Converts an integer to a string representation in a custom base using a predefined charset.
+ * This function allows converting numbers into a string format based on any custom numeric system,
+ * as long as the charset provides the symbols for that base.
+ *
+ * @param {number} number - The integer value to be converted into the custom base.
+ * @param {string} charset - A string representing all the symbols used in the custom base, ordered from 0 upwards.
+ * @return {string} The string representation of the integer in the custom base.
+ */
+export const encodeNumber = (number, charset) => {
+    const isMap = isCharset(charset);
+    const base = isMap ? charset.int.base : charset.length;
+    const characters = isMap ? charset.chars : charset;
+    let result = '';
+    if (number < base) {
+        return characters.charAt(number);
+    }
+    while (number > 0) {
+        const index = number % base;
+        result = characters.charAt(index) + result;
+        number = Math.floor(number / base);
+    }
+    return result;
+};
+//# sourceMappingURL=encodeNumber.js.map

package/dist/encodeNumber.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"encodeNumber.js","sourceRoot":"","sources":["../src/encodeNumber.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,SAAS,EAAC,MAAM,cAAc,CAAC;AAErD;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAAc,EAAE,OAAyB,EAAU,EAAE;IAEhF,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,CAAA;IAChC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAA;IACtD,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAA;IAElD,IAAI,MAAM,GAAG,EAAE,CAAA;IAEf,IAAI,MAAM,GAAG,IAAI,EAAE,CAAC;QAClB,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAClC,CAAC;IAED,OAAO,MAAM,GAAG,CAAC,EAAE,CAAC;QAClB,MAAM,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;QAC5B,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAA;QAC1C,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACrC,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export { ensureCharset, presets } from "./Charset.js";
+export { encodeNumber } from './encodeNumber.js';
+export { encodeBigInt } from './encodeBigInt.js';
+export { decodeNumber } from './decodeNumber.js';
+export { decodeBigInt } from './decodeBigInt.js';
+export type { Charset } from "./Charset.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,OAAO,EAAC,MAAM,cAAc,CAAC;AACpD,OAAO,EAAC,YAAY,EAAC,MAAM,mBAAmB,CAAA;AAC9C,OAAO,EAAC,YAAY,EAAC,MAAM,mBAAmB,CAAA;AAC9C,OAAO,EAAC,YAAY,EAAC,MAAM,mBAAmB,CAAA;AAC9C,OAAO,EAAC,YAAY,EAAC,MAAM,mBAAmB,CAAA;AAC9C,YAAY,EAAC,OAAO,EAAC,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -0,0 +1,6 @@
+export { ensureCharset, presets } from "./Charset.js";
+export { encodeNumber } from './encodeNumber.js';
+export { encodeBigInt } from './encodeBigInt.js';
+export { decodeNumber } from './decodeNumber.js';
+export { decodeBigInt } from './decodeBigInt.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,OAAO,EAAC,MAAM,cAAc,CAAC;AACpD,OAAO,EAAC,YAAY,EAAC,MAAM,mBAAmB,CAAA;AAC9C,OAAO,EAAC,YAAY,EAAC,MAAM,mBAAmB,CAAA;AAC9C,OAAO,EAAC,YAAY,EAAC,MAAM,mBAAmB,CAAA;AAC9C,OAAO,EAAC,YAAY,EAAC,MAAM,mBAAmB,CAAA"}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@pfeiferio/custom-base",
+  "version": "1.0.0",
+  "description": "Custom base encoding and decoding for numbers and BigInts using arbitrary charsets",
+  "license": "MIT",
+  "author": "Pascal Pfeifer <pascal@pfeifer.zone>",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "base",
+    "base-encoding",
+    "custom-base",
+    "charset",
+    "encoding",
+    "decoding",
+    "bigint",
+    "number",
+    "id",
+    "token",
+    "utility",
+    "no-dependencies",
+    "esm"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pfeiferio/custom-base.git"
+  },
+  "bugs": {
+    "url": "https://github.com/pfeiferio/custom-base/issues"
+  },
+  "homepage": "https://github.com/pfeiferio/custom-base#readme",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "npm run build && node --test",
+    "test:watch": "node --test --watch",
+    "test:coverage": "npm run build && node --test --experimental-test-coverage",
+    "prepublishOnly": "npm run build && npm test",
+    "clean": "rm -rf dist"
+  },
+  "devDependencies": {
+    "@types/node": "^20.17.9",
+    "typescript": "^5.9.3"
+  }
+}