@bboss/uuid32 0.1.0 → 1.0.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 bigboss.dev (https://github.com/bigbossdev/uuid32)
-
-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
+MIT License
+
+Copyright (c) 2025 bigboss.dev (https://github.com/bigbossdev/uuid32)
+
+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

@@ -1,125 +1,125 @@
-# @bboss/uuid32
-
-A lightweight TypeScript library for encoding and decoding UUIDs to/from Crockford Base32 strings, designed exclusively for Node.js environments.
-
-## Features
-
-- 🚀 **Fast & Lightweight**: Zero dependencies, optimized for performance
-- 🔒 **Node.js Only**: Built specifically for server-side applications
-- 📦 **TypeScript Native**: Full TypeScript support with type definitions
-- 🧪 **Well Tested**: Comprehensive test suite with high coverage
-- 🔧 **Simple API**: Easy-to-use functions for encoding, decoding, and validation
-- 🛡️ **User-Friendly**: Excludes confusing characters (I, L, O, U) to prevent input errors
-
-## Use Cases
-
-- **Product Key Generation**: Software license keys, serial numbers
-- **API Key Generation**: Service authentication tokens, access keys
-- **Short IDs**: URL shortening, reference codes, tracking IDs
-- **Manual Input**: Reduced errors when users need to type keys manually
-
-## Installation
-
-```bash
-# npm
-npm install @bboss/uuid32
-
-# yarn
-yarn add @bboss/uuid32
-```
-
-## Requirements
-
-- Node.js 16.0.0 or higher (requires `crypto.randomUUID()`)
-- **Node.js only** - not compatible with browser environments
-
-## Usage
-
-```javascript
-import uuid32 from '@bboss/uuid32';
-// const uuid32 = require('@bboss/uuid32'); // legacy way
-
-// Generate a new Base32 UUID
-const shortId = uuid32.generateBase32();
-console.log(shortId); // → "29STNWYQG28H4VWA59PD0XYJR8" (random)
-
-// Encode existing UUID to Base32
-const encoded = uuid32.encode('49ceabcf-5e02-4449-be28-a9b341df4b08');
-console.log(encoded); // → "29STNWYQG28H4VWA59PD0XYJR8"
-
-// Decode Base32 back to standard UUID
-const decoded = uuid32.decode('29STNWYQG28H4VWA59PD0XYJR8');
-console.log(decoded); // → "49ceabcf-5e02-4449-be28-a9b341df4b08"
-
-// Validation
-console.log(uuid32.isValidBase32('29STNWYQG28H4VWA59PD0XYJR8')); // → true
-```
-
-## API Reference
-
-### `generateBase32(): string`
-Generates a new UUID v4 using `crypto.randomUUID()` and encodes it to Crockford Base32.
-
-**Returns:** Base32 encoded UUID string
-
-### `encode(uuid: string): string`
-Encodes a standard UUID to Crockford Base32 format.
-
-**Parameters:**
-- `uuid` - Standard UUID string (with or without hyphens)
-
-**Returns:** Base32 encoded string
-
-**Throws:** Error if UUID format is invalid
-
-### `decode(base32: string): string`
-Decodes a Crockford Base32 string back to standard UUID format.
-
-**Parameters:**
-- `base32` - Base32 encoded string
-
-**Returns:** Standard UUID string with hyphens
-
-**Throws:** Error if Base32 format is invalid
-
-### `isValidBase32(str: string): boolean`
-Validates if a string is a valid Crockford Base32 format.
-
-**Parameters:**
-- `str` - String to validate
-
-**Returns:** `true` if valid Base32, `false` otherwise
-
-## Error Handling
-
-The library throws descriptive errors for invalid inputs:
-
-```javascript
-try {
-    uuid32.encode('invalid-uuid');
-} catch (error) {
-    console.log(error.message); // → "Invalid UUID format"
-}
-
-try {
-    uuid32.decode('invalid@base32!');
-} catch (error) {
-    console.log(error.message); // → "Invalid Base32 format"
-}
-```
-
-## Crockford Base32 Character Set
-
-Uses the following 32 characters: `0123456789ABCDEFGHJKMNPQRSTVWXYZ`
-
-**Excluded characters for clarity:**
-- `I` (can be confused with `1`)
-- `L` (can be confused with `1`) 
-- `O` (can be confused with `0`)
-- `U` (can be confused with `V`)
-
-This makes the encoded strings more reliable for manual input and reduces transcription errors.
-
-## License
-
+# @bboss/uuid32
+
+A lightweight TypeScript library for encoding and decoding UUIDs to/from Crockford Base32 strings, designed exclusively for Node.js environments.
+
+## Features
+
+- 🚀 **Fast & Lightweight**: Zero dependencies, optimized for performance
+- 🔒 **Node.js Only**: Built specifically for server-side applications
+- 📦 **TypeScript Native**: Full TypeScript support with type definitions
+- 🧪 **Well Tested**: Comprehensive test suite with high coverage
+- 🔧 **Simple API**: Easy-to-use functions for encoding, decoding, and validation
+- 🛡️ **User-Friendly**: Excludes confusing characters (I, L, O, U) to prevent input errors
+
+## Use Cases
+
+- **Product Key Generation**: Software license keys, serial numbers
+- **API Key Generation**: Service authentication tokens, access keys
+- **Short IDs**: URL shortening, reference codes, tracking IDs
+- **Manual Input**: Reduced errors when users need to type keys manually
+
+## Installation
+
+```bash
+# npm
+npm install @bboss/uuid32
+
+# yarn
+yarn add @bboss/uuid32
+```
+
+## Requirements
+
+- Node.js 16.0.0 or higher (requires `crypto.randomUUID()`)
+- **Node.js only** - not compatible with browser environments
+
+## Usage
+
+```javascript
+import uuid32 from '@bboss/uuid32';
+// const uuid32 = require('@bboss/uuid32'); // legacy way
+
+// Generate a new Base32 UUID
+const shortId = uuid32.generateBase32();
+console.log(shortId); // → "29STNWYQG28H4VWA59PD0XYJR8" (random)
+
+// Encode existing UUID to Base32
+const encoded = uuid32.encode('49ceabcf-5e02-4449-be28-a9b341df4b08');
+console.log(encoded); // → "29STNWYQG28H4VWA59PD0XYJR8"
+
+// Decode Base32 back to standard UUID
+const decoded = uuid32.decode('29STNWYQG28H4VWA59PD0XYJR8');
+console.log(decoded); // → "49ceabcf-5e02-4449-be28-a9b341df4b08"
+
+// Validation
+console.log(uuid32.isValidBase32('29STNWYQG28H4VWA59PD0XYJR8')); // → true
+```
+
+## API Reference
+
+### `generateBase32(): string`
+Generates a new UUID v4 using `crypto.randomUUID()` and encodes it to Crockford Base32.
+
+**Returns:** Base32 encoded UUID string
+
+### `encode(uuid: string): string`
+Encodes a standard UUID to Crockford Base32 format.
+
+**Parameters:**
+- `uuid` - Standard UUID string (with or without hyphens)
+
+**Returns:** Base32 encoded string
+
+**Throws:** Error if UUID format is invalid
+
+### `decode(base32: string): string`
+Decodes a Crockford Base32 string back to standard UUID format.
+
+**Parameters:**
+- `base32` - Base32 encoded string
+
+**Returns:** Standard UUID string with hyphens
+
+**Throws:** Error if Base32 format is invalid
+
+### `isValidBase32(str: string): boolean`
+Validates if a string is a valid Crockford Base32 format.
+
+**Parameters:**
+- `str` - String to validate
+
+**Returns:** `true` if valid Base32, `false` otherwise
+
+## Error Handling
+
+The library throws descriptive errors for invalid inputs:
+
+```javascript
+try {
+    uuid32.encode('invalid-uuid');
+} catch (error) {
+    console.log(error.message); // → "Invalid UUID format"
+}
+
+try {
+    uuid32.decode('invalid@base32!');
+} catch (error) {
+    console.log(error.message); // → "Invalid Base32 format"
+}
+```
+
+## Crockford Base32 Character Set
+
+Uses the following 32 characters: `0123456789ABCDEFGHJKMNPQRSTVWXYZ`
+
+**Excluded characters for clarity:**
+- `I` (can be confused with `1`)
+- `L` (can be confused with `1`) 
+- `O` (can be confused with `0`)
+- `U` (can be confused with `V`)
+
+This makes the encoded strings more reliable for manual input and reduces transcription errors.
+
+## License
+
 MIT License - see [LICENSE](LICENSE) file for details.

package/package.json

@@ -1,52 +1,52 @@
-{
-    "name": "@bboss/uuid32",
-    "version": "0.1.0",
-    "description": "UUID to Crockford Base32 encoding/decoding library for Node.js",
-    "keywords": [
-        "uuid",
-        "base32",
-        "crockford",
-        "encoding",
-        "decoding",
-        "product-key",
-        "api-key",
-        "typescript",
-        "nodejs"
-    ],
-    "author": "bigboss.dev",
-    "license": "MIT",
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/bigbossdev/uuid32.git"
-    },
-    "bugs": {
-        "url": "https://github.com/bigbossdev/uuid32/issues"
-    },
-    "homepage": "https://github.com/bigbossdev/uuid32#readme",
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
-    "files": [
-        "dist/**/*",
-        "README.md",
-        "LICENSE"
-    ],
-    "engines": {
-        "node": ">=16.0.0"
-    },
-    "scripts": {
-        "build": "rimraf dist && tsc",
-        "test": "jest",
-        "test:watch": "jest --watch",
-        "test:coverage": "jest --coverage",
-        "prepublishOnly": "npm run build"
-    },
-    "devDependencies": {
-        "@types/jest": "^29.5.14",
-        "@types/node": "^22.0.0",
-        "jest": "^29.7.0",
-        "rimraf": "^6.0.1",
-        "ts-jest": "^29.4.5",
-        "typescript": "^5.9.3"
-    },
-    "packageManager": "yarn@4.10.3"
-}
+{
+    "name": "@bboss/uuid32",
+    "version": "1.0.0",
+    "description": "UUID to Crockford Base32 encoding/decoding library for Node.js",
+    "keywords": [
+        "uuid",
+        "base32",
+        "crockford",
+        "encoding",
+        "decoding",
+        "product-key",
+        "api-key",
+        "typescript",
+        "nodejs"
+    ],
+    "author": "bigboss.dev",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/bigbossdev/uuid32.git"
+    },
+    "bugs": {
+        "url": "https://github.com/bigbossdev/uuid32/issues"
+    },
+    "homepage": "https://github.com/bigbossdev/uuid32#readme",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist/**/*",
+        "README.md",
+        "LICENSE"
+    ],
+    "engines": {
+        "node": ">=16.0.0"
+    },
+    "scripts": {
+        "build": "rimraf dist && tsc",
+        "test": "jest",
+        "test:watch": "jest --watch",
+        "test:coverage": "jest --coverage",
+        "prepublishOnly": "npm run build"
+    },
+    "devDependencies": {
+        "@types/jest": "^29.5.14",
+        "@types/node": "^22.0.0",
+        "jest": "^29.7.0",
+        "rimraf": "^6.0.1",
+        "ts-jest": "^29.4.5",
+        "typescript": "^5.9.3"
+    },
+    "packageManager": "yarn@4.10.3"
+}