feat: add locationBias and locationRestriction for geographic filtering

Author: amitpdev

README.md

@@ -251,6 +251,8 @@ const CustomizedExample = () => {
 | proxyHeaders | object | No | - | Headers to pass to the proxy (ex. { Authorization: 'Bearer AUTHTOKEN' } ) |
 | languageCode | string | No | - | Language code (e.g., 'en', 'fr') |
 | includedRegionCodes | string[] | No | - | Array of region codes to filter results |
+| locationBias | Record<string, any> | No | - | Bias search results by location (circle or rectangle). [Details](#location-filtering) |
+| locationRestriction | Record<string, any> | No | - | Restrict search results to location (circle or rectangle). [Details](#location-filtering) |
 | types | string[] | No | [] | Array of place types to filter |
 | biasPrefixText | (text: string) => string | No | - | Optional function to modify the input text before sending to the Places API |
 | minCharsToFetch | number | No | 1 | Minimum characters before triggering search |
@@ -276,6 +278,58 @@ const CustomizedExample = () => {
 | onError | (error: any) => void | No | - | Callback when API errors occur |
 | enableDebug | boolean | No | false | Enable detailed console logging for troubleshooting |
 
+## Location Filtering
+
+You can filter or bias search results based on geographic location using `locationBias` or `locationRestriction`.
+
+### Location Bias (Soft Filter)
+
+**Biases** results towards a location but can still return results outside the area if they're highly relevant:
+
+```javascript
+<GooglePlacesTextInput
+  apiKey="YOUR_GOOGLE_PLACES_API_KEY"
+  onPlaceSelect={handlePlaceSelect}
+  locationBias={{
+    circle: {
+      center: {
+        latitude: 37.7937,
+        longitude: -122.3965
+      },
+      radius: 500.0  // meters
+    }
+  }}
+/>
+```
+
+### Location Restriction (Hard Filter)
+
+**Restricts** results to only those within the specified area:
+
+```javascript
+<GooglePlacesTextInput
+  apiKey="YOUR_GOOGLE_PLACES_API_KEY"
+  onPlaceSelect={handlePlaceSelect}
+  locationRestriction={{
+    rectangle: {
+      low: { latitude: 37.7749, longitude: -122.4194 },
+      high: { latitude: 37.8049, longitude: -122.3894 }
+    }
+  }}
+/>
+```
+
+**Supported shapes:**
+- **Circle**: Define center (lat/lng) and radius in meters
+- **Rectangle**: Define southwest and northeast corners (low/high)
+
+**Use cases:**
+- Show places near user's current GPS location
+- Limit results to delivery radius
+- Search within a specific neighborhood or city bounds
+
+For more details, see [Google Places API Location Biasing](https://developers.google.com/maps/documentation/places/web-service/autocomplete#location_biasing).
+
 ## Place Details Fetching
 
 You can automatically fetch detailed place information when a user selects a place suggestion by enabling the `fetchDetails` prop:

src/GooglePlacesTextInput.tsx

@@ -128,6 +128,8 @@ interface GooglePlacesTextInputProps
   proxyHeaders?: Record<string, string>;
   languageCode?: string;
   includedRegionCodes?: string[];
+  locationBias?: Record<string, any>;
+  locationRestriction?: Record<string, any>;
   types?: string[];
   biasPrefixText?: (text: string) => string;
   minCharsToFetch?: number;
@@ -176,6 +178,8 @@ const GooglePlacesTextInput = forwardRef<
       proxyHeaders = null,
       languageCode,
       includedRegionCodes,
+      locationBias,
+      locationRestriction,
       types = [],
       biasPrefixText,
       minCharsToFetch = 1,
@@ -307,6 +311,8 @@ const GooglePlacesTextInput = forwardRef<
         sessionToken,
         languageCode,
         includedRegionCodes,
+        locationBias,
+        locationRestriction,
         types,
         minCharsToFetch,
       });
@@ -331,6 +337,8 @@ const GooglePlacesTextInput = forwardRef<
           sessionToken,
           languageCode,
           includedRegionCodes,
+          locationBias,
+          locationRestriction,
           types,
           biasPrefixText,
         });

src/services/googlePlacesApi.ts

@@ -10,6 +10,8 @@ interface FetchPredictionsParams {
   sessionToken?: string | null;
   languageCode?: string;
   includedRegionCodes?: string[];
+  locationBias?: Record<string, any>;
+  locationRestriction?: Record<string, any>;
   types?: string[];
   biasPrefixText?: (text: string) => string;
 }
@@ -45,6 +47,8 @@ export const fetchPredictions = async ({
   sessionToken,
   languageCode,
   includedRegionCodes,
+  locationBias,
+  locationRestriction,
   types = [],
   biasPrefixText,
 }: FetchPredictionsParams): Promise<PredictionResult> => {
@@ -76,6 +80,8 @@ export const fetchPredictions = async ({
       ...(sessionToken && { sessionToken }),
       ...(includedRegionCodes &&
         includedRegionCodes.length > 0 && { includedRegionCodes }),
+      ...(locationBias && { locationBias }),
+      ...(locationRestriction && { locationRestriction }),
       ...(types.length > 0 && { includedPrimaryTypes: types }),
     };