quantaroute-geocoding 1.0.4 → 1.2.0

package/README.md

@@ -4,13 +4,19 @@ A **unique** Node.js/TypeScript library for geocoding addresses to DigiPin codes
 
 ## 🚀 Unique Features
 
+### 🔒 **Enterprise-Grade Security** - *Runtime Protection & Code Security*
+- 🛡️ **RASP Protection**: Runtime Application Self-Protection with anti-debugging, integrity checks, and behavior monitoring
+- 🔐 **Secure API Key Storage**: Encrypted storage with Symbol-based properties
+- 🔏 **Request Signing**: HMAC-SHA256 signatures prevent tampering
+- 🔒 **Code Obfuscation**: Production builds are automatically obfuscated
+
 ### 🎯 **NEW: Location Lookup API** - *Service that even government doesn't provide!*
 - 🗺️ **Administrative Boundary Lookup**: Get state, division, locality, pincode, district, delivery status from coordinates
-- 📊 **Population Density Data**: Mean, min, and max population density from Meta's 30-meter gridded data
-- 📍 **36,000+ Postal Boundaries**: Complete coverage across India
+- 📍 **19,000+ Pincode Boundaries (with 154,000 post offices)**: Complete coverage across India
 - ⚡ **Sub-100ms Response**: Cached responses with database fallback
 - 🎯 **Government-Level Precision**: Accuracy that official services don't offer
 - 🔄 **Batch Processing**: Up to 100 locations per request
+- 📊 **Population Density Data**: Mean, min, and max population density from Meta's 30-meter gridded data. [Deprecated]
 
 ### 🌟 **Core Features**
 - 🌐 **Online API Integration**: Full access to QuantaRoute Geocoding API
@@ -27,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
 
@@ -53,7 +61,6 @@ console.log(`Division: ${result.administrative_info.division}`);         // New
 console.log(`Locality: ${result.administrative_info.locality}`);         // Nirman Bhawan SO
 console.log(`District: ${result.administrative_info.district}`);         // New Delhi
 console.log(`Delivery: ${result.administrative_info.delivery}`);         // Delivery
-console.log(`Pop Density: ${result.administrative_info.mean_population_density}`); // 11234.56
 console.log(`DigiPin: ${result.digipin}`);                              // 39J-438-TJC7
 console.log(`Response Time: ${result.response_time_ms}ms`);              // <100ms
 
@@ -65,7 +72,7 @@ console.log(`Division: ${digipinResult.administrative_info.division}`);
 console.log(`Locality: ${digipinResult.administrative_info.locality}`);
 console.log(`District: ${digipinResult.administrative_info.district}`);
 
-// 📊 Get live statistics (36,000+ boundaries)
+// 📊 Get live statistics (19,000+ boundaries with 154,000 post offices)
 const stats = await client.getLocationStatistics();
 console.log(`Total Boundaries: ${stats.totalBoundaries.toLocaleString()}`);
 console.log(`Total States: ${stats.totalStates}`);
@@ -95,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
@@ -263,9 +319,6 @@ interface LocationLookupResult {
     country: string;        // "India"
     delivery?: string;      // "Delivery"
     district?: string;      // "New Delhi"
-    mean_population_density?: number;  // 11234.56
-    min_population_density?: number;   // 5678.90
-    max_population_density?: number;   // 15234.67
   };
   coordinates: {
     latitude: number;       // 28.6139
@@ -282,7 +335,7 @@ interface LocationLookupResult {
 
 🎯 **Government-Level Precision**: Access to administrative boundaries that even government APIs don't provide at this level of detail and accessibility.
 
-📍 **36,000+ Boundaries**: Complete coverage of Indian postal boundaries with sub-district level precision.
+📍 **19,000+ Boundaries (with 154,000 post offices)**: Complete coverage of Indian postal boundaries with sub-district level precision.
 
 ⚡ **Performance**: Sub-100ms cached responses, <500ms database queries.
 
@@ -404,9 +457,9 @@ const result: LocationLookupResult = await client.lookupLocationFromCoordinates(
 
 | Tier | Requests/Minute | Monthly Limit | Batch Size | Boundaries |
 |------|----------------|---------------|------------|------------|
-| Free | 20 | 2,000 | 50 | 36,000+ |
-| Paid | 200 | 20,000 | 100 | 36,000+ |
-| Enterprise | 2,000 | Unlimited | 100 | 36,000+ |
+| Free | 20 | 25,000 | 50 | 19,000+ (with 154,000 post offices) |
+| Paid | 200 | 50,000 | 100 | 19,000+ (with 154,000 post offices) |
+| Enterprise | 10,000,000 | Unlimited | 100 | 19,000+ (with 154,000 post offices) |
 
 **Performance Guarantees:**
 - ⚡ Cached responses: <100ms
@@ -438,7 +491,7 @@ Check out the `examples/` directory for more comprehensive examples:
 
 ✨ **Government-Level Precision**: Administrative boundary data that even government APIs don't provide at this level of detail and accessibility.
 
-📍 **Complete Coverage**: 36,000+ postal boundaries across India with sub-district precision.
+📍 **Complete Coverage**: 19,000+ postal boundaries (with 154,000 post offices) across India with sub-district precision.
 
 ⚡ **Blazing Performance**: Sub-100ms cached responses, guaranteed <500ms database queries.
 
@@ -450,6 +503,19 @@ Check out the `examples/` directory for more comprehensive examples:
 
 ## Changelog
 
+### [1.1.0] - 2025-11-25
+#### 🔒 Security Enhancements (Major Update)
+- 🛡️ **RASP Protection**: Runtime Application Self-Protection with anti-debugging, integrity checks, and behavior monitoring
+- 🔐 **Secure API Key Storage**: Encrypted storage with Symbol-based properties
+- 🔏 **Request Signing**: HMAC-SHA256 signatures prevent tampering
+- 🔒 **Code Obfuscation**: Production builds automatically obfuscated
+- 🚫 **Source Map Removal**: Prevents reverse engineering
+
+### [1.0.4] - 2025-11-23
+#### Added
+- Enhanced reverse geocoding with detailed address components
+- `address`, `displayName`, and `addressComponents` fields
+
 ### [1.0.3] - 2025-11-10
 #### Added
 - 🔔 **Webhook Management**: Register, list, delete, and test webhook endpoints
@@ -463,14 +529,13 @@ Check out the `examples/` directory for more comprehensive examples:
 
 ### [1.0.2] - 2025-11-01
 #### Added
-- 🎉 **Population Density Data**: Added mean, min, and max population density fields from Meta's 30-meter gridded data
+- 🎉 **Population Density Data**: Added mean, min, and max population density fields from Meta's 30-meter gridded data [Deprecated]
 - 📍 **District Information**: Added district field for Indian district division as per official records
 - ✅ **Delivery Status**: Added delivery field for pincode delivery status
 - 🌍 **Complete Geographic Data**: Added state and country fields for comprehensive location information
 
 #### Enhanced
-- Improved administrative boundary data with complete coverage (36,000+ postal boundaries)
-- All Location Lookup API responses now include population density and district information
+- Improved administrative boundary data with complete coverage (19,000+ postal boundaries with 154,000 post offices)
 
 ### [1.0.1] - Previous Release
 - Initial stable release with Location Lookup API

package/dist/client.d.ts

@@ -1,72 +1,29 @@
 import { ClientConfig, GeocodeResult, ReverseGeocodeResult, LocationLookupResult, LocationStatistics, BatchLocationRequest, BatchLocationResult, WebhookEndpoint, CreateWebhookRequest, CreateWebhookResponse, TestWebhookResponse } from './types';
-/**
- * QuantaRoute Geocoding Client
- *
- * Revolutionary Node.js SDK for QuantaRoute Geocoding API with Location Lookup
- */
+declare const CONFIG_SYMBOL: unique symbol;
+declare const KEY_STORAGE_SYMBOL: unique symbol;
 export declare class QuantaRouteClient {
     private client;
-    private config;
+    private [CONFIG_SYMBOL];
+    private [KEY_STORAGE_SYMBOL];
     constructor(config: ClientConfig);
     private setupInterceptors;
+    private setupRequestSigning;
     private makeRequest;
-    /**
-     * Geocode an address to DigiPin
-     */
     geocode(address: string): Promise<GeocodeResult>;
-    /**
-     * Convert coordinates to DigiPin
-     */
     coordinatesToDigiPin(latitude: number, longitude: number): Promise<GeocodeResult>;
-    /**
-     * Reverse geocode DigiPin to coordinates
-     */
     reverseGeocode(digipin: string): Promise<ReverseGeocodeResult>;
-    /**
-     * 🚀 REVOLUTIONARY: Get administrative boundaries from coordinates
-     */
     lookupLocationFromCoordinates(latitude: number, longitude: number): Promise<LocationLookupResult>;
-    /**
-     * 🚀 REVOLUTIONARY: Get administrative boundaries from DigiPin
-     */
     lookupLocationFromDigiPin(digipin: string): Promise<LocationLookupResult>;
-    /**
-     * 🚀 REVOLUTIONARY: Batch location lookup
-     */
     batchLocationLookup(locations: BatchLocationRequest[]): Promise<BatchLocationResult>;
-    /**
-     * 📊 Get live location statistics
-     */
     getLocationStatistics(): Promise<LocationStatistics>;
-    /**
-     * Check API usage and limits
-     */
     getUsage(): Promise<any>;
-    /**
-     * Get API health status
-     */
     getHealth(): Promise<any>;
-    /**
-     * 🔔 Register a webhook endpoint
-     */
     registerWebhook(webhook: CreateWebhookRequest): Promise<CreateWebhookResponse>;
-    /**
-     * 🔔 List all webhook endpoints
-     */
     listWebhooks(): Promise<WebhookEndpoint[]>;
-    /**
-     * 🔔 Get a specific webhook endpoint (by finding it in the list)
-     */
     getWebhook(webhookId: string): Promise<WebhookEndpoint>;
-    /**
-     * 🔔 Delete a webhook endpoint
-     */
     deleteWebhook(webhookId: string): Promise<void>;
-    /**
-     * 🔔 Test a webhook endpoint
-     */
     testWebhook(webhookId: string): Promise<TestWebhookResponse>;
     private validateCoordinates;
     private validateDigiPin;
 }
-//# sourceMappingURL=client.d.ts.map
+export {};