base60-codec 0.1.11 → 0.2.0

package/README.md

@@ -27,67 +27,76 @@ Ideal for generating compact, URL-safe IDs with predictable ordering.
 
 ## 🚀 Installation
 
-```
+```shell
 npm install base60-codec
 ```
 
 ## 🧩 Quick Usage
 
-```
-import { base60 } from "base60-codec";
+```javascript
+import { encodeUUID, decodeUUID } from "base60-codec";
 
 const uuid = "550e8400-e29b-41d4-a716-446655440000";
 
 // Encode as 22-char Base60
-const encoded = base60.encodeUUID(uuid);
+const encoded = encodeUUID(uuid);
 console.log(encoded); // e.g. "09EzBRW... (22 chars)"
 
 // Decode back to UUID
-console.log(base60.decodeUUID(encoded));
+console.log(decodeUUID(encoded));
 // → "550e8400-e29b-41d4-a716-446655440000"
 ```
 
+💡 Tip
+If you prefer grouped APIs, you can also import the base60 namespace:
+
+```javascript
+import base60 from "base60-codec";
+
+base60.encodeUUID(uuid);
+```
+
 ## ✨ Features
 
 ### ✅ UUID (128-bit) → 22 chars
 
-```
+```javascript
 encodeUUID(uuid: string): string
 decodeUUID(id: Base60String): string
 ```
 
 ### ✅ ULID (26 chars Base32) → 22 chars
 
-```
+```javascript
 encodeULID(ulid: string): Base60String
 decodeULID(id: Base60String): string
 ```
 
 ### ✅ Int64 → 11 chars
 
-```
+```javascript
 encodeInt64(num: number | bigint): string
 decodeInt64(id: Base60String): bigint
 ```
 
 ### ✅ BigInt encoding
 
-```
+```javascript
 encodeBigInt(value: bigint, padLength?: number): string
 decodeToBigInt(text: Base60String): bigint
 ```
 
 ### ✅ Safe comparison
 
-```
+```javascript
 compareAsBigInt(a: Base60String, b: Base60String): -1 | 0 | 1
 ```
 
 ### ✅ Type-safe Base60 string guard
 
-```
+```javascript
 if (base60.isValidBase60(text)) {
-// text is now typed as Base60String
+  // text is now typed as Base60String
 }
 ```
 
@@ -107,7 +116,7 @@ if (base60.isValidBase60(text)) {
 
 Leading zero bytes are dropped:
 
-```
+```javascript
 encodeBytes(Uint8Array([0,1,2]))
 ↓
 decodeToBytes(...) → [1,2]
@@ -119,7 +128,7 @@ UUID / ULID / Int64 are unaffected because they use fixed 16-byte / 8-byte decod
 
 ## 🧪 Testing
 
-```
+```shell
 npm test
 ```
 

package/dist/index.cjs

@@ -21,8 +21,20 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   base60: () => base60,
+  compareAsBigInt: () => compareAsBigInt,
   createBase60Codec: () => createBase60Codec,
-  default: () => index_default
+  decodeInt64: () => decodeInt64,
+  decodeToBigInt: () => decodeToBigInt,
+  decodeToBytes: () => decodeToBytes,
+  decodeULID: () => decodeULID,
+  decodeUUID: () => decodeUUID,
+  default: () => index_default,
+  encodeBigInt: () => encodeBigInt,
+  encodeBytes: () => encodeBytes,
+  encodeInt64: () => encodeInt64,
+  encodeULID: () => encodeULID,
+  encodeUUID: () => encodeUUID,
+  isValidBase60: () => isValidBase60
 });
 module.exports = __toCommonJS(index_exports);
 var FIXED_LEN_UUID = 22;
@@ -71,7 +83,7 @@ function createBase60Codec() {
     }
     return bytes;
   }
-  function encodeBigInt(value, padLength) {
+  function encodeBigInt2(value, padLength) {
     if (value === 0n) {
       return padLength != null ? leftPad(alphabet[0], padLength) : alphabet[0];
     }
@@ -84,7 +96,7 @@ function createBase60Codec() {
     }
     return padLength != null ? leftPad(out, padLength) : out;
   }
-  function decodeToBigInt(text) {
+  function decodeToBigInt2(text) {
     let v = 0n;
     for (const ch of text) {
       const d = charToValue.get(ch);
@@ -98,16 +110,16 @@ function createBase60Codec() {
   return {
     alphabet,
     encodeBytes(bytes) {
-      return encodeBigInt(bytesToBigInt(bytes));
+      return encodeBigInt2(bytesToBigInt(bytes));
     },
     decodeToBytes(text) {
-      return bigIntToBytes(decodeToBigInt(text));
+      return bigIntToBytes(decodeToBigInt2(text));
     },
-    encodeBigInt,
-    decodeToBigInt,
+    encodeBigInt: encodeBigInt2,
+    decodeToBigInt: decodeToBigInt2,
     encodeInt64(value) {
       return leftPad(
-        encodeBigInt(BigInt(value)),
+        encodeBigInt2(BigInt(value)),
         FIXED_LEN_INT64
       );
     },
@@ -115,7 +127,7 @@ function createBase60Codec() {
       if (text.length !== FIXED_LEN_INT64) {
         throw new Error(`Expected ${FIXED_LEN_INT64} chars for Base60 Int64`);
       }
-      return decodeToBigInt(text);
+      return decodeToBigInt2(text);
     },
     encodeUUID(uuid) {
       const hex = uuid.replace(/-/g, "");
@@ -125,12 +137,12 @@ function createBase60Codec() {
         bytes[i] = parseInt(hex.substr(i * 2, 2), 16);
       }
       return leftPad(
-        encodeBigInt(bytesToBigInt(bytes)),
+        encodeBigInt2(bytesToBigInt(bytes)),
         FIXED_LEN_UUID
       );
     },
     decodeUUID(text) {
-      const bytes = bigIntToBytes(decodeToBigInt(text), 16);
+      const bytes = bigIntToBytes(decodeToBigInt2(text), 16);
       const hex = [...bytes].map((b) => b.toString(16).padStart(2, "0")).join("");
       return hex.slice(0, 8) + "-" + hex.slice(8, 12) + "-" + hex.slice(12, 16) + "-" + hex.slice(16, 20) + "-" + hex.slice(20);
     },
@@ -148,14 +160,14 @@ function createBase60Codec() {
         if (v === void 0) throw new Error(`Invalid ULID char: ${ch}`);
         value = (value << 5n) + BigInt(v);
       }
-      const raw = encodeBigInt(value);
+      const raw = encodeBigInt2(value);
       return leftPad(raw, FIXED_LEN_ULID);
     },
     decodeULID(text) {
       if (text.length !== 22) {
         throw new Error("Expected 22-char Base60 ULID");
       }
-      const value = decodeToBigInt(text);
+      const value = decodeToBigInt2(text);
       const bytes = bigIntToBytes(value, 16);
       let bits = "";
       for (const b of bytes) {
@@ -170,8 +182,8 @@ function createBase60Codec() {
       return ulid;
     },
     compareAsBigInt(a, b) {
-      const ai = decodeToBigInt(a);
-      const bi = decodeToBigInt(b);
+      const ai = decodeToBigInt2(a);
+      const bi = decodeToBigInt2(b);
       if (ai < bi) return -1;
       if (ai > bi) return 1;
       return 0;
@@ -185,9 +197,35 @@ function createBase60Codec() {
   };
 }
 var base60 = createBase60Codec();
+var {
+  encodeBytes,
+  decodeToBytes,
+  encodeBigInt,
+  decodeToBigInt,
+  encodeInt64,
+  decodeInt64,
+  encodeUUID,
+  decodeUUID,
+  encodeULID,
+  decodeULID,
+  compareAsBigInt,
+  isValidBase60
+} = base60;
 var index_default = base60;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   base60,
-  createBase60Codec
+  compareAsBigInt,
+  createBase60Codec,
+  decodeInt64,
+  decodeToBigInt,
+  decodeToBytes,
+  decodeULID,
+  decodeUUID,
+  encodeBigInt,
+  encodeBytes,
+  encodeInt64,
+  encodeULID,
+  encodeUUID,
+  isValidBase60
 });

package/dist/index.d.cts

@@ -18,5 +18,17 @@ interface Base60Codec {
 }
 declare function createBase60Codec(): Base60Codec;
 declare const base60: Base60Codec;
+declare const encodeBytes: (bytes: Uint8Array) => string;
+declare const decodeToBytes: (text: Base60String) => Uint8Array;
+declare const encodeBigInt: (value: bigint, padLength?: number) => Base60String;
+declare const decodeToBigInt: (text: Base60String) => bigint;
+declare const encodeInt64: (value: number | bigint) => Base60String;
+declare const decodeInt64: (text: Base60String) => bigint;
+declare const encodeUUID: (uuid: string) => Base60String;
+declare const decodeUUID: (text: Base60String) => string;
+declare const encodeULID: (ulid: string) => Base60String;
+declare const decodeULID: (text: Base60String) => string;
+declare const compareAsBigInt: (a: Base60String, b: Base60String) => number;
+declare const isValidBase60: (text: string) => text is Base60String;
 
-export { type Base60Codec, type Base60String, base60, createBase60Codec, base60 as default };
+export { type Base60Codec, type Base60String, base60, compareAsBigInt, createBase60Codec, decodeInt64, decodeToBigInt, decodeToBytes, decodeULID, decodeUUID, base60 as default, encodeBigInt, encodeBytes, encodeInt64, encodeULID, encodeUUID, isValidBase60 };

package/dist/index.d.ts

@@ -18,5 +18,17 @@ interface Base60Codec {
 }
 declare function createBase60Codec(): Base60Codec;
 declare const base60: Base60Codec;
+declare const encodeBytes: (bytes: Uint8Array) => string;
+declare const decodeToBytes: (text: Base60String) => Uint8Array;
+declare const encodeBigInt: (value: bigint, padLength?: number) => Base60String;
+declare const decodeToBigInt: (text: Base60String) => bigint;
+declare const encodeInt64: (value: number | bigint) => Base60String;
+declare const decodeInt64: (text: Base60String) => bigint;
+declare const encodeUUID: (uuid: string) => Base60String;
+declare const decodeUUID: (text: Base60String) => string;
+declare const encodeULID: (ulid: string) => Base60String;
+declare const decodeULID: (text: Base60String) => string;
+declare const compareAsBigInt: (a: Base60String, b: Base60String) => number;
+declare const isValidBase60: (text: string) => text is Base60String;
 
-export { type Base60Codec, type Base60String, base60, createBase60Codec, base60 as default };
+export { type Base60Codec, type Base60String, base60, compareAsBigInt, createBase60Codec, decodeInt64, decodeToBigInt, decodeToBytes, decodeULID, decodeUUID, base60 as default, encodeBigInt, encodeBytes, encodeInt64, encodeULID, encodeUUID, isValidBase60 };

package/dist/index.js

@@ -45,7 +45,7 @@ function createBase60Codec() {
     }
     return bytes;
   }
-  function encodeBigInt(value, padLength) {
+  function encodeBigInt2(value, padLength) {
     if (value === 0n) {
       return padLength != null ? leftPad(alphabet[0], padLength) : alphabet[0];
     }
@@ -58,7 +58,7 @@ function createBase60Codec() {
     }
     return padLength != null ? leftPad(out, padLength) : out;
   }
-  function decodeToBigInt(text) {
+  function decodeToBigInt2(text) {
     let v = 0n;
     for (const ch of text) {
       const d = charToValue.get(ch);
@@ -72,16 +72,16 @@ function createBase60Codec() {
   return {
     alphabet,
     encodeBytes(bytes) {
-      return encodeBigInt(bytesToBigInt(bytes));
+      return encodeBigInt2(bytesToBigInt(bytes));
     },
     decodeToBytes(text) {
-      return bigIntToBytes(decodeToBigInt(text));
+      return bigIntToBytes(decodeToBigInt2(text));
     },
-    encodeBigInt,
-    decodeToBigInt,
+    encodeBigInt: encodeBigInt2,
+    decodeToBigInt: decodeToBigInt2,
     encodeInt64(value) {
       return leftPad(
-        encodeBigInt(BigInt(value)),
+        encodeBigInt2(BigInt(value)),
         FIXED_LEN_INT64
       );
     },
@@ -89,7 +89,7 @@ function createBase60Codec() {
       if (text.length !== FIXED_LEN_INT64) {
         throw new Error(`Expected ${FIXED_LEN_INT64} chars for Base60 Int64`);
       }
-      return decodeToBigInt(text);
+      return decodeToBigInt2(text);
     },
     encodeUUID(uuid) {
       const hex = uuid.replace(/-/g, "");
@@ -99,12 +99,12 @@ function createBase60Codec() {
         bytes[i] = parseInt(hex.substr(i * 2, 2), 16);
       }
       return leftPad(
-        encodeBigInt(bytesToBigInt(bytes)),
+        encodeBigInt2(bytesToBigInt(bytes)),
         FIXED_LEN_UUID
       );
     },
     decodeUUID(text) {
-      const bytes = bigIntToBytes(decodeToBigInt(text), 16);
+      const bytes = bigIntToBytes(decodeToBigInt2(text), 16);
       const hex = [...bytes].map((b) => b.toString(16).padStart(2, "0")).join("");
       return hex.slice(0, 8) + "-" + hex.slice(8, 12) + "-" + hex.slice(12, 16) + "-" + hex.slice(16, 20) + "-" + hex.slice(20);
     },
@@ -122,14 +122,14 @@ function createBase60Codec() {
         if (v === void 0) throw new Error(`Invalid ULID char: ${ch}`);
         value = (value << 5n) + BigInt(v);
       }
-      const raw = encodeBigInt(value);
+      const raw = encodeBigInt2(value);
       return leftPad(raw, FIXED_LEN_ULID);
     },
     decodeULID(text) {
       if (text.length !== 22) {
         throw new Error("Expected 22-char Base60 ULID");
       }
-      const value = decodeToBigInt(text);
+      const value = decodeToBigInt2(text);
       const bytes = bigIntToBytes(value, 16);
       let bits = "";
       for (const b of bytes) {
@@ -144,8 +144,8 @@ function createBase60Codec() {
       return ulid;
     },
     compareAsBigInt(a, b) {
-      const ai = decodeToBigInt(a);
-      const bi = decodeToBigInt(b);
+      const ai = decodeToBigInt2(a);
+      const bi = decodeToBigInt2(b);
       if (ai < bi) return -1;
       if (ai > bi) return 1;
       return 0;
@@ -159,9 +159,35 @@ function createBase60Codec() {
   };
 }
 var base60 = createBase60Codec();
+var {
+  encodeBytes,
+  decodeToBytes,
+  encodeBigInt,
+  decodeToBigInt,
+  encodeInt64,
+  decodeInt64,
+  encodeUUID,
+  decodeUUID,
+  encodeULID,
+  decodeULID,
+  compareAsBigInt,
+  isValidBase60
+} = base60;
 var index_default = base60;
 export {
   base60,
+  compareAsBigInt,
   createBase60Codec,
-  index_default as default
+  decodeInt64,
+  decodeToBigInt,
+  decodeToBytes,
+  decodeULID,
+  decodeUUID,
+  index_default as default,
+  encodeBigInt,
+  encodeBytes,
+  encodeInt64,
+  encodeULID,
+  encodeUUID,
+  isValidBase60
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "base60-codec",
-  "version": "0.1.11",
+  "version": "0.2.0",
   "description": "A tiny, deterministic Base60 encoder/decoder for UUID, ULID, Int64, and BigInt.",
   "author": "Shinnosuke Hagiwara <hagiwara000@gmail.com>",
   "license": "MIT",