@tomtom-org/maps-sdk-plugin-viewport-places 0.5.2 → 0.5.4

package/README.md

@@ -1,6 +1,6 @@
 # Viewport Places Plugin
 
-Lightweight plugin for the [TomTom Maps SDK for Javascript](https://docs.tomtom.com/maps-sdk-js/introduction/overview) that keeps places in sync with the current map viewport by creating and managing "place modules" that refresh as the map moves.
+Plugin for the [TomTom Maps SDK for JavaScript](https://docs.tomtom.com/maps-sdk-js/introduction/overview) that keeps places in sync with the current map viewport: each search you add gets its own place module, which searches again whenever the map moves.
 
 ## Docs & examples
 
@@ -9,13 +9,13 @@ Lightweight plugin for the [TomTom Maps SDK for Javascript](https://docs.tomtom.
 
 ## Quickstart
 
-Note: SDK plugins `@tomtom-org/maps-sdk` as a peer dependency — ensure the SDK is installed in your project.
+Note: this plugin declares `@tomtom-org/maps-sdk` as a peer dependency — ensure the SDK is installed in your project.
 
 ```bash
 npm install @tomtom-org/maps-sdk maplibre-gl @tomtom-org/maps-sdk-plugin-viewport-places
 ```
 
-1. Follow the SDK [Project setup](https://docs.tomtom.com/maps-sdk-js/guides/introduction/project-setup) or the Map [quickstart](https://docs.tomtom.com/maps-sdk-js/guides/map/quickstart) to create and initialize a `TomTomMap`.
+1. Follow the SDK [Project setup](https://docs.tomtom.com/maps-sdk-js/introduction/project-setup) or the Map [quickstart](https://docs.tomtom.com/maps-sdk-js/guides/map/quickstart) to create and initialize a `TomTomMap`.
 
 2. Import and use the plugin (plugin-specific steps only):
 
@@ -25,11 +25,22 @@ import { ViewportPlaces } from '@tomtom-org/maps-sdk-plugin-viewport-places';
 // assume `map` is your initialized TomTomMap instance
 const viewportPlaces = new ViewportPlaces(map);
 
+// a text search
 await viewportPlaces.add({
   id: 'restaurants',
   searchOptions: { query: 'restaurant', limit: 40 },
   minZoom: 12,
 });
+
+// a POI category search
+await viewportPlaces.addPOICategories({
+  id: 'parking',
+  categories: ['PARKING_GARAGE', 'CHARGING_LOCATION'],
+});
+
+// change or drop a place module by its id
+await viewportPlaces.update({ id: 'restaurants', searchOptions: { query: 'pizza' } });
+viewportPlaces.remove('parking');
 ```
 
 Place modules are rendered bottom-up in the order they are added: the first added module appears at the bottom and later modules are stacked on top.

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tomtom-org/maps-sdk-plugin-viewport-places",
   "author": "TomTom International B.V.",
   "license": "See in LICENSE.txt",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "type": "module",
   "description": "Plugin to leverage search to show places on the current viewport that refresh as the map moves",
   "types": "dist/index.d.ts",
@@ -17,7 +17,7 @@
     "typescript": "^6.0.3",
     "vite": "^8.3.2",
     "vitest": "^4.1.11",
-    "@tomtom-org/maps-sdk": "1.0.0-rc.0"
+    "@tomtom-org/maps-sdk": "1.0.0-rc.1"
   },
   "files": [
     "dist",