quantaroute-geocoding 1.1.0 → 1.2.0

package/README.md

@@ -33,11 +33,13 @@ A **unique** Node.js/TypeScript library for geocoding addresses to DigiPin codes
 npm install quantaroute-geocoding
 ```
 
-For offline DigiPin processing, also install the DigiPin library:
-
-```bash
-npm install digipin
-```
+**What's included:**
+- ✅ Official India Post DigiPin algorithm (vendored, no external dependencies)
+- ✅ Complete offline DigiPin processing
+- ✅ Location Lookup API client
+- ✅ Geocoding & Reverse Geocoding
+- ✅ Enterprise-grade security (RASP, code obfuscation)
+- ✅ Full TypeScript support
 
 ## Quick Start
 
@@ -100,29 +102,78 @@ console.log(`House Name: ${reverseResult.addressComponents.amenity || reverseRes
 
 ### Offline Processing
 
+**NEW: Official India Post DigiPin Algorithm Vendored!** 🎉
+
+`quantaroute-geocoding` now includes the **official DigiPin algorithm** directly - no external dependencies needed!
+
+#### Using OfflineProcessor Class
+
 ```typescript
 import { OfflineProcessor } from 'quantaroute-geocoding';
 
-// Initialize offline processor
+// Initialize offline processor (no dependencies needed!)
 const processor = new OfflineProcessor();
 
-// Convert coordinates to DigiPin (offline)
+// Convert coordinates to DigiPin (offline, 100% accurate)
 const offlineResult = processor.coordinatesToDigiPin(28.6139, 77.2090);
-console.log(`DigiPin: ${offlineResult.digipin}`);
+console.log(`DigiPin: ${offlineResult.digipin}`); // "39J-438-TJC7"
+console.log(`Source: ${offlineResult.source}`);   // "offline"
 
 // Convert DigiPin to coordinates (offline)
 const coordsResult = processor.digiPinToCoordinates("39J-438-TJC7");
-console.log(`Coordinates: ${coordsResult.coordinates}`);
+console.log(`Latitude: ${coordsResult.coordinates.latitude}`);
+console.log(`Longitude: ${coordsResult.coordinates.longitude}`);
 
 // Validate DigiPin format
 const validation = processor.validateDigiPin("39J-438-TJC7");
 console.log(`Valid: ${validation.isValid}`);
+if (!validation.isValid) {
+  console.log(`Errors: ${validation.errors.join(', ')}`);
+}
 
 // Calculate distance between coordinates
 const distance = processor.calculateDistance(28.6139, 77.2090, 28.6150, 77.2100);
 console.log(`Distance: ${distance.toFixed(2)} km`);
 ```
 
+#### Using Core DigiPin Functions Directly
+
+For simple use cases, you can use the core functions directly:
+
+```typescript
+import {
+  getDigiPin,
+  getLatLngFromDigiPin,
+  isValidDigiPinFormat,
+  getBounds
+} from 'quantaroute-geocoding';
+
+// Convert coordinates to DigiPin
+const digipin = getDigiPin(28.6139, 77.2090);
+console.log('DigiPin:', digipin); // "39J-438-TJC7"
+
+// Convert DigiPin to coordinates
+const coords = getLatLngFromDigiPin("39J-438-TJC7");
+console.log('Latitude:', coords.latitude);   // "28.613900"
+console.log('Longitude:', coords.longitude); // "77.209000"
+
+// Validate DigiPin
+const isValid = isValidDigiPinFormat("39J-438-TJC7");
+console.log('Valid:', isValid); // true
+
+// Get India bounds covered by DigiPin
+const bounds = getBounds();
+console.log('Bounds:', bounds);
+// { minLat: 2.5, maxLat: 38.5, minLon: 63.5, maxLon: 99.5 }
+```
+
+**Why This Matters:**
+- ✅ **Zero Dependencies**: No need to install separate `digipin` packages
+- ✅ **100% Offline**: Works without internet or API calls
+- ✅ **Official Algorithm**: Same code as India Post's official implementation
+- ✅ **Apache 2.0 License**: Open source from Government of India
+- ✅ **Type-Safe**: Full TypeScript definitions included
+
 ### 🔔 Webhook Management
 
 ```typescript