mapnests-browser-sdk 1.1.0 → 1.1.2

package/README.md

@@ -32,11 +32,11 @@ A secure and efficient TS SDK for the **Mapnests Platform**, enabling powerful g
     -   [Search](#search)
     -   [Reverse](#reverse)
     -   [Autocomplete](#autocomplete)
-    -   [Autocomplete Without Zone](#autocomplete-without-zone)
     -   [Search By Radius](#search-by-radius)
     -   [Multi Stop Point](#multi-stop-point)
     -   [Geocode Search](#geocode-search)
-    -   [Detailed Search By PlaceId ](#detailed-search-by-placeId)
+    -   [Detailed Search By PlaceId](#detailed-search-by-placeId)
+    -   [Snap to Road](#snap-to-road)
 
 -   [License](#license)
 -   [Contact](#contact)
@@ -416,8 +416,27 @@ console.log(revRes);
 **Example Input:**
 
 ```ts
+//Without optional value
 const autoCompleteRes = await client.autocomplete({ Query: "Gulshan Road"});
 console.log(autoCompleteRes);
+
+// Optional parameter: ActiveZone.
+// If ActiveZone is set to true, the search results will be returned within the zone. (By Default ActiveZone is true)
+// If ActiveZone is set to false, the search results will be not consider any zone data.
+const autoCompleteRes = await client.autocomplete({ Query: "Gulshan Road", ActiveZone: true });
+console.log(autoCompleteRes);
+
+// Optional parameters: Latitude, Longitude, and Radius.
+// If provided, the search results will be returned within a specified radius,
+// using the given latitude and longitude as the center point.
+const autoCompleteRes = await client.autocomplete({ Query: "Gulshan Road", Lat: 23.7806, Lon: 90.3984, Radius: 5000 });
+console.log(autoCompleteRes);
+
+// Optional parameter: Limit.
+// If provided, the search results will be returned within a specified limit.
+const autoCompleteRes = await client.autocomplete({ Query: "Gulshan Road", Limit: 1 });
+console.log(autoCompleteRes);
+
 ```
 
 **Example Output:**
@@ -444,34 +463,6 @@ console.log(autoCompleteRes);
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
-### Autocomplete Without Zone
-
-> Auto Complete suggests relevant places, streets, and landmarks as you type a partial search query.
-
-**Example Input:**
-
-```ts
-const autocompleteResWithoutZone = await client.autocompleteWithoutZone({ Query: "Uttara"});
-console.log( JSON.stringify(autocompleteResWithoutZone,));
-```
-
-**Example Output:**
-
-```json
-{
-  "data": [
-    {
-      "placeId": "7d7e8fd275bfd9be9853ada14417d104e824d1c11600599bd326fb858429d83c",
-      "name": "Uttara",
-      "address": "Uttara, House#21, Road 17, Sector 11, Uttara, Dhaka-1230",
-      "types": [
-        "amenity",
-        "restaurant",
-        "amenity"
-      ]
-    }
-}
-```
 
 ### Search By Radius
 
@@ -716,6 +707,45 @@ console.log(detailsByPlaceId);
 ```
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
+### Snap to Road
+
+<a name="snap-to-road"></a>
+
+> Returns the nearest road’s latitude and longitude for the given input coordinates.
+
+**Example Input:**
+
+```ts
+const snapToRoad = await client.snapToRoad({ 
+      mode: "walking",
+      latitude: 23.8103,
+      longitude: 90.4125
+    });
+console.log(snapToRoad);
+```
+
+**Example Output:**
+
+```json
+{
+  "data": {
+    "waypoints": [
+      {
+        "address": "Lane 11 East",
+        "location": [
+          90.412496,
+          23.810403
+        ],
+        "distance_meters": 11.41511481
+      }
+    ]
+  },
+  "message": "Success",
+  "status": true
+}
+```
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
 ---
 
 ## License

package/dist/build_url.js

@@ -17,11 +17,11 @@ function buildURLFromJSON(label, baseUrl, jsonStr) {
             const toLon = data.DestLon;
             const mode = encodeURIComponent(data.Mode);
             const path = label === 'distanceMatrixDetails' ? 'distancematrixdetails' : 'distancematrix';
-            const apiVersion = label === 'distanceMatrixDetails' ? 'v1' : 'v3';
+            const apiVersion = label === 'distanceMatrixDetails' ? 'v2' : 'v3';
             return `${baseUrl}/routemap/api/${apiVersion}/routes/${path}?fromLat=${fromLat}&fromLong=${fromLon}&toLat=${toLat}&toLong=${toLon}&mode=${mode}`;
         }
         case 'pairwiseRouteSummary': {
-            return `${baseUrl}/routemap/api/v1/routes/pairwise-summary`;
+            return `${baseUrl}/routemap/api/v2/routes/pairwise-summary`;
         }
         case 'multiSourceSummary': {
             return `${baseUrl}/routemap/api/v1/routes/multi-source-summary`;
@@ -53,14 +53,8 @@ function buildURLFromJSON(label, baseUrl, jsonStr) {
             const limit = data.Limit ? `&limit=${data.Limit}` : '';
             const lat = data.Lat ? `&lat=${data.Lat}` : '';
             const lon = data.Lon ? `&lon=${data.Lon}` : '';
-            return `${baseUrl}/geomap/api/v1/autocomplete?q=${query}${limit}${lat}${lon}`;
-        }
-        case 'autocompleteWithoutZone': {
-            const query = encodeURIComponent(data.Query);
-            const limit = data.Limit ? `&limit=${data.Limit}` : '';
-            const lat = data.Lat ? `&lat=${data.Lat}` : '';
-            const lon = data.Lon ? `&lon=${data.Lon}` : '';
-            return `${baseUrl}/geomap/api/v1/autocomplete/all?q=${query}${limit}${lat}${lon}`;
+            const zoneActiveOnly = data.ZoneActiveOnly != undefined ? `&zoneActiveOnly=${data.ZoneActiveOnly}` : "";
+            return `${baseUrl}/geomap/api/v2/autocomplete?q=${query}${zoneActiveOnly}${limit}${lat}${lon}`;
         }
         case 'searchByRadius': {
             const query = encodeURIComponent(data.Query);
@@ -72,6 +66,9 @@ function buildURLFromJSON(label, baseUrl, jsonStr) {
             const page = data.Page ? `&page=${data.Page}` : '';
             return `${baseUrl}/geomap/api/v2/search/radius?q=${query}&lat=${lat}&lon=${lon}&radius=${radius}&activeLocations=${activeLocations}${limit}${page}`;
         }
+        case 'snapToRoad': {
+            return `${exports.BASE_URL}/routemap/api/v1/nearest/road`;
+        }
         default:
             throw new Error(`unsupported label: ${label}`);
     }

package/dist/client.d.ts

@@ -10,6 +10,7 @@ import { ReverseRequest, ReverseResponse } from "./modules/reverse";
 import { SearchRequest, SearchResponse } from "./modules/search";
 import { SearchBboxRequest } from "./modules/search_bbox";
 import { SearchByRadiusRequest, SearchByRadiusResponse } from "./modules/search_by_radius";
+import { SnapToRoadRequest, SnapToRoadResponse } from "./modules/snap_to_road";
 export interface IClient {
     distanceMatrix(request: DistanceMatrixRequest): Promise<DistanceMatrixResponse>;
     pairwiseRouteSummary(request: PairwiseRouteSummaryRequest): Promise<PairwiseRouteSummaryResponse>;
@@ -21,8 +22,8 @@ export interface IClient {
     geocode(request: GeocodeRequest): Promise<GeocodeResponse>;
     multiStopPoint(request: MultiStopPointsRequest): Promise<MultiStopPointsResponse>;
     autocomplete(request: AutocompleteRequest): Promise<AutocompleteResponse>;
-    autocompleteWithoutZone(request: AutocompleteRequest): Promise<AutocompleteResponse>;
     searchByRadius(request: SearchByRadiusRequest): Promise<SearchByRadiusResponse>;
+    snapToRoad(request: SnapToRoadRequest): Promise<SnapToRoadResponse>;
     searchWithBbox(request: SearchBboxRequest): Promise<string>;
 }
 export declare class Client implements IClient {
@@ -38,10 +39,10 @@ export declare class Client implements IClient {
     reverse(request: ReverseRequest): Promise<ReverseResponse>;
     search(request: SearchRequest): Promise<SearchResponse>;
     autocomplete(request: AutocompleteRequest): Promise<AutocompleteResponse>;
-    autocompleteWithoutZone(request: AutocompleteRequest): Promise<AutocompleteResponse>;
     searchWithBbox(request: SearchBboxRequest): Promise<string>;
     searchByRadius(request: SearchByRadiusRequest): Promise<SearchByRadiusResponse>;
     geocode(request: GeocodeRequest): Promise<GeocodeResponse>;
     multiStopPoint(request: MultiStopPointsRequest): Promise<MultiStopPointsResponse>;
     details(request: DetailsRequest): Promise<DetailsResponse>;
+    snapToRoad(request: SnapToRoadRequest): Promise<SnapToRoadResponse>;
 }

package/dist/client.js

@@ -64,14 +64,6 @@ class Client {
         console.dir(response, { depth: null, colors: true });
         return response;
     }
-    async autocompleteWithoutZone(request) {
-        console.log("📍 Autocomplete Without Zone request:", request);
-        request.Query = (0, validate_query_length_1.validateAndNormalizeQuery)(request.Query);
-        const response = await this.makeRequest("autocompleteWithoutZone", request);
-        console.log("📍 Autocomplete Without Zone response:");
-        console.dir(response, { depth: null, colors: true });
-        return response;
-    }
     //Under Maintenance
     async searchWithBbox(request) {
         console.log("📍 Search Bbox request:", request);
@@ -107,5 +99,12 @@ class Client {
         console.log("📍 Details Search by Place ID response:", response);
         return response;
     }
+    async snapToRoad(request) {
+        console.log("📍 Snap to Road request:", request);
+        const response = await this.makeRequest("snapToRoad", request);
+        console.log("📍 Snap to Road response:");
+        console.dir(response, { depth: null, colors: true });
+        return response;
+    }
 }
 exports.Client = Client;

package/dist/main.js

@@ -72,7 +72,7 @@ const index_1 = require("./index");
                 },
             ],
         });
-        console.log("============================> PairwiseRouteSummary:", pairwiseRes);
+        console.log("============================> PairwiseRouteSummary:", JSON.stringify(pairwiseRes));
         // ✅ MultiSourceRouteSummaryRequest Example
         const multiSourceRes = await cl.multiSourceRouteSummary({
             sources: [
@@ -124,22 +124,21 @@ const index_1 = require("./index");
             Mode: index_1.Mode.Car,
         });
         console.log("============================> MultiStopPoint:", JSON.stringify(multiStopRes, null, 2));
-        // ✅ Details By PlaceId Example
-        const detailsRes = await cl.details({ PlaceId: "4355aad6b8eb0b4f0ee3fa972ff9ac3fdc2d7f86f634d81f79dcf396f21826a0" });
-        console.log("============================> Details by Place ID:", detailsRes);
+        // // ✅ Details By PlaceId Example
+        // const detailsRes = await cl.details({ PlaceId: "4355aad6b8eb0b4f0ee3fa972ff9ac3fdc2d7f86f634d81f79dcf396f21826a0" });
+        // console.log("============================> Details by Place ID:", detailsRes);
         // ✅ AutocompleteRequest Example
-        const autoCompleteRes = await cl.autocomplete({ Query: "Gulshan Road", limit: 1 });
+        const autoCompleteRes = await cl.autocomplete({ Query: "Mirpur", Limit: 1, ZoneActiveOnly: true });
         console.log("============================> Autocomplete:", JSON.stringify(autoCompleteRes, null, 2));
-        console.dir(autoCompleteRes, { depth: null, color: true });
-        // ✅ AutocompleteWithoutZoneRequest Example
-        const autocompleteResWithoutZone = await cl.autocompleteWithoutZone({ Query: "Uttara", limit: 2 });
-        console.log("============================> Autocomplete Without Zone:", JSON.stringify(autocompleteResWithoutZone, null, 2));
         // ✅ SearchBboxRequest Example
         const searchBboxRes = await cl.searchWithBbox({ Query: "uttara", TopLeftLat: 23.799012278864893, TopLeftLon: 90.43487817491183, BottomRightLat: 23.798243503885544, BottomRightLon: 90.43537003653393 });
         console.log("============================> Search With Boundary box:", searchBboxRes);
         // ✅ SearchByRadiusRequest Example
         const searchByRadiusRes = await cl.searchByRadius({ Query: "uttara", Lat: 23.7272064, Lon: 90.3861125, Radius: 5000, Limit: 1 });
         console.log("============================> Search By Radius:", JSON.stringify(searchByRadiusRes, null, 2));
+        // ✅ Snap to Road Example
+        const snapToRoadRes = await cl.snapToRoad({ mode: "walking", latitude: 23.8103, longitude: 90.4125 });
+        console.log("============================> Snap to Road:", JSON.stringify(snapToRoadRes, null, 2));
     }
     catch (err) {
         console.error("🔥 Error:", err);

package/dist/modules/autocomplete.d.ts

@@ -1,5 +1,6 @@
 export interface AutocompleteRequest {
     Query: string;
+    ZoneActiveOnly?: boolean;
     Lat?: number;
     Lon?: number;
     Limit?: number;

package/dist/modules/pairwise_route_summary.d.ts

@@ -1,4 +1,5 @@
 import { Mode } from './distance_matrix';
+import { Leg } from './distance_matrix_details';
 export interface Coordinate {
     lat: number;
     lon: number;
@@ -12,15 +13,21 @@ export interface PairwiseRoute {
 export interface PairwiseRouteSummaryRequest {
     pairs: PairwiseRoute[];
 }
+export interface LegWithAnnotation extends Leg {
+    annotation: Record<string, unknown>;
+}
 export interface RouteSummary {
     id: number;
     distanceInMeters?: number;
     etaInSeconds?: number;
     geometry?: string;
+    legs?: LegWithAnnotation[];
     error?: string;
 }
 export interface PairwiseRouteSummaryResponse {
     status: boolean;
     message: string;
-    data: RouteSummary[];
+    data: {
+        routeSummaries: RouteSummary[];
+    };
 }

package/dist/modules/snap_to_road.d.ts

@@ -0,0 +1,13 @@
+import { PlaceDetail } from "./details_by_place_id";
+import { Mode } from "./distance_matrix";
+export interface SnapToRoadRequest {
+    mode: Mode;
+    latitude: number;
+    longitude: number;
+    numberOfNearestRoad?: number;
+}
+export interface SnapToRoadResponse {
+    data: PlaceDetail[];
+    message: string;
+    status: boolean;
+}

package/dist/modules/snap_to_road.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/secure_request.js

@@ -15,8 +15,8 @@ const HTTP_METHOD_MAP = {
     geocode: 'GET',
     detailsByPlaceId: 'GET',
     autocomplete: 'GET',
-    autocompleteWithoutZone: 'GET',
     searchByRadius: 'GET',
+    snapToRoad: 'POST',
 };
 async function executeFetch(url, method, headers, body, timeoutMs) {
     const response = await fetch(url, {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mapnests-browser-sdk",
   "description": "TypeScript SDK for Mapnests API integration (Distance Matrix, Distance Matrix Details, Pairwise Route Summary, Multi Source Route Summary, Search, Reverse, Autocomplete, Autocomplete Without Zone, Multi Stop Points, Details By Place ID, Search By Radius, Geocode)",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {