@nakanoaas/uuid58 1.2.3 → 2.0.0

package/dist/index.js

@@ -16,49 +16,6 @@
 * ```
 */
 const UUID58_ALPHABET = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
-// check.ts
-const MAX_UUID58 = "YcVfxkQb6JRzqk5kF2tNLv";
-/**
-* Regular expression pattern for validating UUID58 strings.
-*
-* This regex ensures that a string:
-* - Contains exactly 22 characters
-* - Uses only characters from the Base58 alphabet
-*
-* **Note:** This regex does NOT validate that the decoded value fits within
-* 128 bits (UUID size). For complete validation including 128-bit range
-* checking, use {@link isUuid58} instead.
-*
-* @example
-* ```typescript
-* const isValid = UUID58_REGEX.test("XDY9dmBbcMBXqcRvYw8xJ2"); // true
-* const isValid = UUID58_REGEX.test("invalid"); // false
-* const isValid = UUID58_REGEX.test("123"); // false (too short)
-* ```
-*/
-const UUID58_REGEX = /^[1-9A-HJ-NP-Za-km-z]{22}$/u;
-/**
-* Checks if a given string is a valid UUID58-encodable string.
-* This function efficiently validates without performing full decoding.
-*
-* A valid UUID58 string must:
-* - Be exactly 22 characters long
-* - Contain only characters from the Base58 alphabet
-* - Decode to a value that fits within 128 bits (UUID size)
-*
-* @param uuid58 - The string to check
-* @returns `true` if the string is a valid UUID58 string, `false` otherwise
-*
-* @example
-* ```typescript
-* isUuid58("XDY9dmBbcMBXqcRvYw8xJ2"); // true
-* isUuid58("invalid"); // false
-* isUuid58("O0lI"); // false (contains invalid characters)
-* ```
-*/
-function isUuid58(uuid58) {
-	return UUID58_REGEX.test(uuid58) && uuid58 <= MAX_UUID58;
-}
 // internal.ts
 const MAX_PREVIEW_LENGTH = 40;
 /**
@@ -105,31 +62,26 @@ function previewInput(input) {
 var _Uuid58DecodeError;
 const BASE58_INDEX = (/* @__PURE__ */ new Int8Array(128)).fill(-1);
 for (let i = 0; i < 58; i++) BASE58_INDEX[UUID58_ALPHABET.charCodeAt(i)] = i;
+const MAX_UINT128 = (1n << 128n) - 1n;
 /**
-* Error thrown when an invalid Base58 string is provided for decoding.
-* This includes strings containing characters not in the Base58 alphabet.
+* Error thrown when an invalid uuid58 string is provided for decoding.
+* Its {@link Uuid58DecodeError.kind | kind} tells why.
 */
-var Uuid58DecodeError = class extends Error {};
+var Uuid58DecodeError = class extends Error {
+	constructor(message, kind) {
+		super(message);
+		this.kind = kind;
+	}
+};
 _Uuid58DecodeError = Uuid58DecodeError;
 _Uuid58DecodeError.prototype.name = "Uuid58DecodeError";
 /**
-* Converts a 22-character Base58-encoded string back to a standard UUID format, but instead of
-* throwing an error for invalid input, it returns an `Uuid58DecodeError`
-* instance.
-*
-* @param uuid58 - The 22-character Base58-encoded UUID string to decode
-* @returns A standard UUID string (lowercase, with hyphens), or an
-*   `Uuid58DecodeError` if the input is not a valid 22-character Base58 string
-* @note This function does not throw; it returns the error object instead.
-*
-* @example
-* ```typescript
-* const uuid = uuid58DecodeSafe("XDY9dmBbcMBXqcRvYw8xJ2"); // returns "f4b247fd-1f87-45d4-aa06-1c6fc0a8dfaf"
-* const error = uuid58DecodeSafe("invalid"); // returns Uuid58DecodeError
-* ```
+* @internal
+* Decodes a uuid58 string to an unsigned 128-bit integer, checking length,
+* then characters, then range (specification, Section 4).
 */
-function uuid58DecodeSafe(uuid58) {
-	if (uuid58.length !== 22) return new Uuid58DecodeError(`Expected Base58 string of length 22, but received string of length ${uuid58.length}: ${previewInput(uuid58)}`);
+function decodeUint128(uuid58) {
+	if (uuid58.length !== 22) return new Uuid58DecodeError(`Expected Base58 string of length 22, but received string of length ${uuid58.length}: ${previewInput(uuid58)}`, "invalid_length");
 	let num = 0n;
 	for (let start = 0; start < 22;) {
 		const end = start === 0 ? 4 : start + 9;
@@ -139,15 +91,36 @@ function uuid58DecodeSafe(uuid58) {
 			const index = code < 128 ? BASE58_INDEX[code] : -1;
 			if (index < 0) {
 				const char = String.fromCodePoint(uuid58.codePointAt(i));
-				return new Uuid58DecodeError(`Invalid Base58 character ${JSON.stringify(char)} found in input: ${previewInput(uuid58)}`);
+				return new Uuid58DecodeError(`Invalid Base58 character ${JSON.stringify(char)} found in input: ${previewInput(uuid58)}`, "invalid_character");
 			}
 			chunk = chunk * 58 + index;
 		}
 		num = num * BASE58_CHUNK + BigInt(chunk);
 		start = end;
 	}
+	if (num > MAX_UINT128) return new Uuid58DecodeError(`Decoded value exceeds 128 bits of UUID: ${previewInput(uuid58)}`, "overflow");
+	return num;
+}
+/**
+* Converts a 22-character Base58-encoded string back to a standard UUID format, but instead of
+* throwing an error for invalid input, it returns an `Uuid58DecodeError`
+* instance.
+*
+* @param uuid58 - The 22-character Base58-encoded UUID string to decode
+* @returns A standard UUID string (lowercase, with hyphens), or an
+*   `Uuid58DecodeError` if the input is not a valid 22-character Base58 string
+* @note This function does not throw; it returns the error object instead.
+*
+* @example
+* ```typescript
+* const uuid = uuid58DecodeSafe("XDY9dmBbcMBXqcRvYw8xJ2"); // returns "f4b247fd-1f87-45d4-aa06-1c6fc0a8dfaf"
+* const error = uuid58DecodeSafe("invalid"); // returns Uuid58DecodeError (kind: "invalid_length")
+* ```
+*/
+function uuid58DecodeSafe(uuid58) {
+	const num = decodeUint128(uuid58);
+	if (typeof num !== "bigint") return num;
 	const hex = num.toString(16).padStart(32, "0");
-	if (hex.length !== 32) return new Uuid58DecodeError(`Decoded value exceeds 128 bits of UUID: ${previewInput(uuid58)}`);
 	return hex.slice(0, 8) + "-" + hex.slice(8, 12) + "-" + hex.slice(12, 16) + "-" + hex.slice(16, 20) + "-" + hex.slice(20);
 }
 /**
@@ -170,18 +143,44 @@ function uuid58Decode(uuid58) {
 // encode.ts
 var _Uuid58EncodeError;
 const HEX32_REGEX = /^[0-9a-f]{32}$/i;
+const HYPHENATED_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
 /**
-* Error thrown when an invalid UUID string is provided for encoding.
-* This includes strings that don't match the standard UUID format (32 hexadecimal characters with optional hyphens).
+* Error thrown when an invalid UUID string or byte array is provided for
+* encoding. Its {@link Uuid58EncodeError.kind | kind} tells why.
 */
-var Uuid58EncodeError = class extends Error {};
+var Uuid58EncodeError = class extends Error {
+	constructor(message, kind) {
+		super(message);
+		this.kind = kind;
+	}
+};
 _Uuid58EncodeError = Uuid58EncodeError;
 _Uuid58EncodeError.prototype.name = "Uuid58EncodeError";
 /**
+* @internal
+* Parses a UUID string in one of the two forms of the specification
+* (Section 5.1) into an unsigned 128-bit integer.
+*/
+function parseUuidString(uuid) {
+	let hex;
+	if (uuid.length === 32) {
+		if (!HEX32_REGEX.test(uuid)) return new Uuid58EncodeError(`Invalid UUID: ${previewInput(uuid)} must be 32 hexadecimal digits`, "invalid_character");
+		hex = uuid;
+	} else if (uuid.length === 36) {
+		if (!HYPHENATED_REGEX.test(uuid)) return new Uuid58EncodeError(`Invalid UUID: ${previewInput(uuid)} must be in the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`, "invalid_character");
+		hex = uuid.slice(0, 8) + uuid.slice(9, 13) + uuid.slice(14, 18) + uuid.slice(19, 23) + uuid.slice(24);
+	} else return new Uuid58EncodeError(`Invalid UUID length: expected 32 or 36 characters, got ${uuid.length} in ${previewInput(uuid)}`, "invalid_length");
+	return BigInt("0x" + hex);
+}
+/**
 * Converts a standard UUID string to a 22-character Base58-encoded format, but instead of
 * throwing an error for invalid input, it returns an `Uuid58EncodeError` instance.
 *
-* @param uuid - The UUID string to encode (with or without hyphens)
+* Only two forms are accepted, in any letter case: the hyphenated form
+* (`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`) and 32 hexadecimal digits. Braces,
+* `urn:uuid:`, whitespace, and hyphens in other positions are rejected.
+*
+* @param uuid - The UUID string to encode (hyphenated, or 32 hexadecimal digits)
 * @returns A 22-character Base58-encoded string, or an `Uuid58EncodeError` if the input is
 *   not a valid UUID
 * @note This function does not throw; it returns the error object instead.
@@ -195,21 +194,20 @@ _Uuid58EncodeError.prototype.name = "Uuid58EncodeError";
 * // Uppercase UUID is also accepted
 * const base58 = uuid58EncodeSafe("F4B247FD-1F87-45D4-AA06-1C6FC0A8DFAF"); // returns "XDY9dmBbcMBXqcRvYw8xJ2"
 * // Invalid UUID format
-* const error = uuid58EncodeSafe("invalid"); // returns Uuid58EncodeError
+* const error = uuid58EncodeSafe("invalid"); // returns Uuid58EncodeError (kind: "invalid_length")
 * ```
 */
 function uuid58EncodeSafe(uuid) {
-	const hex = uuid.replace(/-/g, "");
-	if (hex.length !== 32) return new Uuid58EncodeError(`Invalid UUID length: expected 32 characters (excluding hyphens), got ${hex.length} characters in ${previewInput(uuid)}`);
-	if (!HEX32_REGEX.test(hex)) return new Uuid58EncodeError(`Invalid UUID format: ${previewInput(uuid)} contains non-hexadecimal characters`);
-	return encodeUint128(BigInt("0x" + hex));
+	const num = parseUuidString(uuid);
+	return typeof num === "bigint" ? encodeUint128(num) : num;
 }
 /**
 * Converts a standard UUID string to a 22-character Base58-encoded format.
 *
-* @param uuid - The UUID string to encode. Can be provided with or without hyphens
-*              (format: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" or "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx").
-*              The input is case-insensitive, so both uppercase and lowercase hexadecimal characters are accepted.
+* @param uuid - The UUID string to encode, either hyphenated
+*              ("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") or as 32 hexadecimal digits
+*              ("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"). Hexadecimal digits may be in any case.
+*              Other forms, including hyphens in other positions, are rejected.
 * @returns A 22-character Base58-encoded string representation of the UUID
 * @throws {Uuid58EncodeError} If the input string is not a valid UUID format
 *
@@ -228,6 +226,129 @@ function uuid58Encode(uuid) {
 	if (result instanceof Uuid58EncodeError) throw result;
 	return result;
 }
+// bytes.ts
+/**
+* Encodes 16 bytes, in big-endian (RFC 9562) order, as a 22-character uuid58
+* string, but instead of throwing an error for invalid input, it returns an
+* `Uuid58EncodeError` instance.
+*
+* @param bytes - The 16 bytes of the UUID
+* @returns A 22-character uuid58 string, or an `Uuid58EncodeError` (kind
+*   `"invalid_length"`) if `bytes` is not exactly 16 bytes long
+* @note This function does not throw; it returns the error object instead.
+*
+* @example
+* ```typescript
+* const bytes = new Uint8Array(16); // nil UUID
+* uuid58EncodeBytesSafe(bytes); // returns "1111111111111111111111"
+* ```
+*/
+function uuid58EncodeBytesSafe(bytes) {
+	if (bytes.length !== 16) return new Uuid58EncodeError(`Invalid byte length: expected 16 bytes, got ${bytes.length}`, "invalid_length");
+	const view = new DataView(bytes.buffer, bytes.byteOffset, 16);
+	return encodeUint128(view.getBigUint64(0) << 64n | view.getBigUint64(8));
+}
+/**
+* Encodes 16 bytes, in big-endian (RFC 9562) order, as a 22-character uuid58
+* string.
+*
+* @param bytes - The 16 bytes of the UUID
+* @returns A 22-character uuid58 string
+* @throws {Uuid58EncodeError} If `bytes` is not exactly 16 bytes long
+*
+* @example
+* ```typescript
+* uuid58EncodeBytes(new Uint8Array(16)); // returns "1111111111111111111111"
+* ```
+*/
+function uuid58EncodeBytes(bytes) {
+	const result = uuid58EncodeBytesSafe(bytes);
+	if (result instanceof Uuid58EncodeError) throw result;
+	return result;
+}
+/**
+* Decodes a uuid58 string to 16 bytes in big-endian (RFC 9562) order, but
+* instead of throwing an error for invalid input, it returns an
+* `Uuid58DecodeError` instance.
+*
+* @param uuid58 - The 22-character uuid58 string to decode
+* @returns A new 16-byte `Uint8Array`, or an `Uuid58DecodeError`
+* @note This function does not throw; it returns the error object instead.
+*
+* @example
+* ```typescript
+* uuid58DecodeBytesSafe("1111111111111111111111"); // returns Uint8Array(16) of zeros
+* ```
+*/
+function uuid58DecodeBytesSafe(uuid58) {
+	const num = decodeUint128(uuid58);
+	if (typeof num !== "bigint") return num;
+	const bytes = /* @__PURE__ */ new Uint8Array(16);
+	const view = new DataView(bytes.buffer);
+	view.setBigUint64(0, num >> 64n);
+	view.setBigUint64(8, num & 18446744073709551615n);
+	return bytes;
+}
+/**
+* Decodes a uuid58 string to 16 bytes in big-endian (RFC 9562) order.
+*
+* @param uuid58 - The 22-character uuid58 string to decode
+* @returns A new 16-byte `Uint8Array`
+* @throws {Uuid58DecodeError} If the input is not a valid uuid58 string
+*
+* @example
+* ```typescript
+* const bytes = uuid58DecodeBytes("XDY9dmBbcMBXqcRvYw8xJ2");
+* ```
+*/
+function uuid58DecodeBytes(uuid58) {
+	const result = uuid58DecodeBytesSafe(uuid58);
+	if (result instanceof Uuid58DecodeError) throw result;
+	return result;
+}
+// check.ts
+const MAX_UUID58 = "YcVfxkQb6JRzqk5kF2tNLv";
+/**
+* Regular expression pattern for validating UUID58 strings.
+*
+* This regex ensures that a string:
+* - Contains exactly 22 characters
+* - Uses only characters from the Base58 alphabet
+*
+* **Note:** This regex does NOT validate that the decoded value fits within
+* 128 bits (UUID size). For complete validation including 128-bit range
+* checking, use {@link isUuid58} instead.
+*
+* @example
+* ```typescript
+* const isValid = UUID58_REGEX.test("XDY9dmBbcMBXqcRvYw8xJ2"); // true
+* const isValid = UUID58_REGEX.test("invalid"); // false
+* const isValid = UUID58_REGEX.test("123"); // false (too short)
+* ```
+*/
+const UUID58_REGEX = /^[1-9A-HJ-NP-Za-km-z]{22}$/u;
+/**
+* Checks if a given string is a valid UUID58-encodable string.
+* This function efficiently validates without performing full decoding.
+*
+* A valid UUID58 string must:
+* - Be exactly 22 characters long
+* - Contain only characters from the Base58 alphabet
+* - Decode to a value that fits within 128 bits (UUID size)
+*
+* @param uuid58 - The string to check
+* @returns `true` if the string is a valid UUID58 string, `false` otherwise
+*
+* @example
+* ```typescript
+* isUuid58("XDY9dmBbcMBXqcRvYw8xJ2"); // true
+* isUuid58("invalid"); // false
+* isUuid58("O0lI"); // false (contains invalid characters)
+* ```
+*/
+function isUuid58(uuid58) {
+	return UUID58_REGEX.test(uuid58) && uuid58 <= MAX_UUID58;
+}
 // generate.ts
 const random = /* @__PURE__ */ new BigUint64Array(2);
 /**
@@ -249,4 +370,4 @@ function uuid58() {
 	const low = random[1] & 4611686018427387903n | 9223372036854775808n;
 	return encodeUint128(high << 64n | low);
 }
-export { UUID58_ALPHABET, UUID58_REGEX, Uuid58DecodeError, Uuid58EncodeError, isUuid58, uuid58, uuid58Decode, uuid58DecodeSafe, uuid58Encode, uuid58EncodeSafe };
+export { UUID58_ALPHABET, UUID58_REGEX, Uuid58DecodeError, Uuid58EncodeError, isUuid58, uuid58, uuid58Decode, uuid58DecodeBytes, uuid58DecodeBytesSafe, uuid58DecodeSafe, uuid58Encode, uuid58EncodeBytes, uuid58EncodeBytesSafe, uuid58EncodeSafe };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nakanoaas/uuid58",
-  "version": "1.2.3",
+  "version": "2.0.0",
   "description": "A tiny, zero-dependency library for generating and converting UUIDs to Base58-encoded strings.",
   "bugs": {
     "url": "https://github.com/nakanoasaservice/uuid58/issues"
@@ -8,7 +8,8 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/nakanoasaservice/uuid58.git"
+    "url": "git+https://github.com/nakanoasaservice/uuid58.git",
+    "directory": "js"
   },
   "files": [
     "dist"