@tomtom-org/maps-sdk-plugin-viewport-places 0.5.9 → 0.5.10

package/CHANGELOG.md

@@ -0,0 +1,193 @@
+# Changelog
+
+## 0.5.10
+
+### Patch Changes
+
+- [#2823](https://github.com/tomtom-internal/maps-sdk-js/pull/2823) [`d1b906f`](https://github.com/tomtom-internal/maps-sdk-js/commit/d1b906f460c33607bf9789475ad85bff339b7c3b) Thanks [@DanielForniessoria-TomTom](https://github.com/DanielForniessoria-TomTom)! - The package ships its `CHANGELOG.md`, as the SDK does, so you can read what changed between two releases from `node_modules`
+
+- [#2813](https://github.com/tomtom-internal/maps-sdk-js/pull/2813) [`c186703`](https://github.com/tomtom-internal/maps-sdk-js/commit/c1867038e9a38e300ea72e8812419204bf008e73) Thanks [@DanielForniessoria-TomTom](https://github.com/DanielForniessoria-TomTom)! - A `maxZoom` of 0 is honoured, and `update()` rebuilds the places layers only when it is given a places config
+
+- [#2811](https://github.com/tomtom-internal/maps-sdk-js/pull/2811) [`e77a737`](https://github.com/tomtom-internal/maps-sdk-js/commit/e77a737112b1e1cbf8115d86ebfcbd2d487e78c0) Thanks [@DanielForniessoria-TomTom](https://github.com/DanielForniessoria-TomTom)! - `new ViewportPlaces(map, { onError })` hands you a refresh on map move that fails, as the search's `SDKError` or the map's `TomTomMapError`, instead of only logging it
+
+## 0.5.9
+
+### Patch Changes
+
+- [#2803](https://github.com/tomtom-internal/maps-sdk-js/pull/2803) [`1a62c72`](https://github.com/tomtom-internal/maps-sdk-js/commit/1a62c72eb372d037397bb88485ea731763f3e554) Thanks [@DanielForniessoria-TomTom](https://github.com/DanielForniessoria-TomTom)! - The README links the repository's security policy page, which sends a vulnerability report to TomTom's HackerOne program
+
+## 0.5.8
+
+### Patch Changes
+
+- [#2742](https://github.com/tomtom-internal/maps-sdk-js/pull/2742) [`2fcc1ab`](https://github.com/tomtom-internal/maps-sdk-js/commit/2fcc1abc07bcdf89aff3942ff1207637ed00f419) Thanks [@DanielForniessoria-TomTom](https://github.com/DanielForniessoria-TomTom)! - The `license` field reads `SEE LICENSE IN LICENSE.txt`, the form npm and license scanners recognise, so they point to the package's own `LICENSE.txt` instead of reporting an unknown license
+
+- [#2734](https://github.com/tomtom-internal/maps-sdk-js/pull/2734) [`9a12d95`](https://github.com/tomtom-internal/maps-sdk-js/commit/9a12d95c22e60e69fb1891237344ca259aa236a5) Thanks [@DanielForniessoria-TomTom](https://github.com/DanielForniessoria-TomTom)! - Installs beside `@tomtom-org/maps-sdk` 1.0.0 and every later 1.x release: the peer range on the SDK runs up to `<2.0.0` instead of stopping below 1.0.0
+
+- [#2697](https://github.com/tomtom-internal/maps-sdk-js/pull/2697) [`3d9c9a3`](https://github.com/tomtom-internal/maps-sdk-js/commit/3d9c9a34b897cf8eb791096620ed3e18dead1966) Thanks [@DanielForniessoria-TomTom](https://github.com/DanielForniessoria-TomTom)! - The package page on npm and the API reference of its entry points say the plugin is in Public Preview until its 1.0.0 release, as its guides already do
+
+- [#2726](https://github.com/tomtom-internal/maps-sdk-js/pull/2726) [`eae0ebd`](https://github.com/tomtom-internal/maps-sdk-js/commit/eae0ebd9ca51c18ad9b4d3edeb3cd8d062834189) Thanks [@DanielForniessoria-TomTom](https://github.com/DanielForniessoria-TomTom)! - A refresh on map move, or the clear on `remove`, that fails is logged as a warning instead of leaving an unhandled rejection, for example while the map's style failed to load
+
+## 0.5.7
+
+### Patch Changes
+
+- [#2693](https://github.com/tomtom-internal/maps-sdk-js/pull/2693) [`db69794`](https://github.com/tomtom-internal/maps-sdk-js/commit/db69794e00011a820e2046a161e5390d07b8bb7a) Thanks [@DanielForniessoria-TomTom](https://github.com/DanielForniessoria-TomTom)! - Plugins are side-effect free, so your bundler drops every part of a plugin your app doesn't use
+  
+  - Each plugin declares `"sideEffects": false`, and its knob catalogue and other module-level tables are dropped when nothing reads them
+  - flyover takes `@turf/turf` as a peer dependency, the copy the SDK already requires, instead of bundling its own
+  - The plugins' bundles keep their module-level names, as the SDK's do, so Sandpack and builds that transpile `node_modules` with Babel run their loops correctly
+
+## 0.5.6
+
+### Patch Changes
+
+- [#2590](https://github.com/tomtom-internal/maps-sdk-js/pull/2590) [`75fb3ea`](https://github.com/tomtom-internal/maps-sdk-js/commit/75fb3eab4d38b2aad8f4f671c3fd84f78ffc19f3) Thanks [@DanielForniessoria-TomTom](https://github.com/DanielForniessoria-TomTom)! - license: the privacy clause of `LICENSE.txt` now links the TomTom Privacy Policy, https://www.tomtom.com/privacy/
+
+- [#2614](https://github.com/tomtom-internal/maps-sdk-js/pull/2614) [`fe596fc`](https://github.com/tomtom-internal/maps-sdk-js/commit/fe596fcb2d1c5a05dddb77547f48debc1b856a12) Thanks [@JulianChinAFoeng-TomTom](https://github.com/JulianChinAFoeng-TomTom)! - tests: each package's unit test run now fails when its coverage drops below the goals in `TESTING.md`
+
+## 0.5.5
+
+### Patch Changes
+
+- [#2522](https://github.com/tomtom-internal/maps-sdk-js/pull/2522) [`9f01f52`](https://github.com/tomtom-internal/maps-sdk-js/commit/9f01f52ee6f5a4ca23a2a44586c6cfac3595937f) Thanks [@AlvaroGraca-TomTom](https://github.com/AlvaroGraca-TomTom)! - No code change: this version is on the `latest` npm tag, which the previous one missed
+
+## 0.5.4
+
+### Patch Changes
+
+- [#2519](https://github.com/tomtom-internal/maps-sdk-js/pull/2519) [`7b854b3`](https://github.com/tomtom-internal/maps-sdk-js/commit/7b854b30bc25fdac5d9afe1975d6961a0bb137f5) Thanks [@AlvaroGraca-TomTom](https://github.com/AlvaroGraca-TomTom)! - No code change: this version is on the `latest` npm tag, which the previous one missed
+
+## 0.5.3
+
+### Patch Changes
+
+- [#2517](https://github.com/tomtom-internal/maps-sdk-js/pull/2517) [`49611d0`](https://github.com/tomtom-internal/maps-sdk-js/commit/49611d0ac91dc0b584e3d059d1f654208bdead6c) Thanks [@DanielForniessoria-TomTom](https://github.com/DanielForniessoria-TomTom)! - The README's Project setup link opens the page again, and its quickstart shows a POI category search and updating or removing a place module
+
+## 0.5.2
+
+### Patch Changes
+
+- [#2506](https://github.com/tomtom-internal/maps-sdk-js/pull/2506) [`12099bd`](https://github.com/tomtom-internal/maps-sdk-js/commit/12099bdc040f3ce2d3990266bfb42024cda7956c) Thanks [@DanielForniessoria-TomTom](https://github.com/DanielForniessoria-TomTom)! - The package ships without source maps, so a stack trace through the plugin points into its minified bundle
+  - An app's own source maps still lead a trace to the plugin's frames (`dist/index.es.js:1:2345`); share such a trace in a report and TomTom maps it back to the source
+
+## 0.5.1
+
+### Patch Changes
+
+- [#2338](https://github.com/tomtom-internal/maps-sdk-js/pull/2338) [`9095b5d`](https://github.com/tomtom-internal/maps-sdk-js/commit/9095b5d952788eed8f0c2610a300fafc90b12bba) Thanks [@DanielForniessoria-TomTom](https://github.com/DanielForniessoria-TomTom)! - Modules keep the `base-map` marker type under the renamed `markerType`, which needs `@tomtom-org/maps-sdk` `>=0.61.0`.
+  
+  - Modules keep drawing as `base-map` by default under the renamed `markerType`
+  - The peer dependency on `@tomtom-org/maps-sdk` is the range `>=0.61.0 <1.0.0`, the first release with `markerType`
+- Updated dependencies:
+  - @tomtom-org/maps-sdk@0.61.0
+
+## 0.5.0
+
+### Minor Changes
+
+- [#2279](https://github.com/tomtom-internal/maps-sdk-js/pull/2279) [`0574709`](https://github.com/tomtom-internal/maps-sdk-js/commit/0574709de2be181fe2ed64c6b16e1ec69bec269b) Thanks [@DanielForniessoria-TomTom](https://github.com/DanielForniessoria-TomTom)! - Requires `@tomtom-org/maps-sdk` `>=0.59.0 <1.0.0`: each module's viewport searches run through the SDK's new `createLatestRequest`, with no change to what the plugin shows or cancels
+
+- [#2193](https://github.com/tomtom-internal/maps-sdk-js/pull/2193) [`c324ff0`](https://github.com/tomtom-internal/maps-sdk-js/commit/c324ff04afb892a600eda5ca9e6576d380ccc9c7) Thanks [@JulianChinAFoeng-TomTom](https://github.com/JulianChinAFoeng-TomTom)! - **Breaking:** `searchOptions` takes the SDK's grouped `filters` — `searchOptions: { filters: { poiCategories } }` — and `update()` merges `filters` member by member, like the rest of `searchOptions`. It takes no `cursor`: every module searches the first page of the current viewport
+
+## 0.4.0
+
+### Minor Changes
+
+- [#2216](https://github.com/tomtom-internal/maps-sdk-js/pull/2216) [`5bfbe75`](https://github.com/tomtom-internal/maps-sdk-js/commit/5bfbe75ec9517789c8624fd2ede1034590e51d48) Thanks [@DanielForniessoria-TomTom](https://github.com/DanielForniessoria-TomTom)! - **Breaking:** `ViewportPlaces.remove` throws for an unknown ID, as `update` does, instead of logging to the console
+
+### Patch Changes
+
+- [#2217](https://github.com/tomtom-internal/maps-sdk-js/pull/2217) [`8eff899`](https://github.com/tomtom-internal/maps-sdk-js/commit/8eff899c713586296529fb22a4c84f3663fa0859) Thanks [@DanielForniessoria-TomTom](https://github.com/DanielForniessoria-TomTom)! - Built with the latest minor releases of the plugin build toolchain; no change to the plugin's API or peer dependencies
+
+- [#2189](https://github.com/tomtom-internal/maps-sdk-js/pull/2189) [`834257b`](https://github.com/tomtom-internal/maps-sdk-js/commit/834257b27bee5c60e1cc1782a466d7f6a6f5f8d8) Thanks [@JulianChinAFoeng-TomTom](https://github.com/JulianChinAFoeng-TomTom)! - Viewport searches call `discoverPlaces`, following the SDK renaming `search` ([#2189](https://github.com/tomtom-internal/maps-sdk-js/issues/2189))
+- Updated dependencies:
+  - @tomtom-org/maps-sdk@0.58.0
+
+## 0.3.0
+
+### Minor Changes
+
+- [#2188](https://github.com/tomtom-internal/maps-sdk-js/pull/2188) [`9e1d080`](https://github.com/tomtom-internal/maps-sdk-js/commit/9e1d080397ee2d16b6185873661890e5a81f7b65) Thanks [@AlvaroGraca-TomTom](https://github.com/AlvaroGraca-TomTom)!
+  
+  - **Breaking:** `searchOptions` no longer accepts `geoBias`; each module always searches the current viewport
+  - A new viewport cancels the search a module still has in flight
+  - Accept every SDK release below 1.0: the peer dependency on `@tomtom-org/maps-sdk` is the range `>=0.55.1 <1.0.0` instead of an exact version
+
+### Patch Changes
+
+- Updated dependencies:
+  - @tomtom-org/maps-sdk@0.56.0
+
+## [0.2.1](https://github.com/tomtom-internal/maps-sdk-js/compare/maps-sdk-plugin-viewport-places-v0.2.0...maps-sdk-plugin-viewport-places-v0.2.1) (2026-04-30)
+
+
+### Features
+
+* improve api reference types, adjust syntax for agent toolkit plugin, and improve agents.md ([9428902](https://github.com/tomtom-internal/maps-sdk-js/commit/9428902605299302fdbb206f22a514e6761d0716))
+
+## [0.2.0](https://github.com/tomtom-internal/maps-sdk-js/compare/maps-sdk-plugin-viewport-places-v0.1.8...maps-sdk-plugin-viewport-places-v0.2.0) (2026-03-16)
+
+
+### ⚠ BREAKING CHANGES
+
+* improve poi categories relationship with search
+
+### Features
+
+* improve poi categories relationship with search ([52f5a26](https://github.com/tomtom-internal/maps-sdk-js/commit/52f5a265dbe0ae4cbb3386de3740cb887ed1a11c))
+* incident details service improvements and added agent tools ([9f3058d](https://github.com/tomtom-internal/maps-sdk-js/commit/9f3058dd55fde278ea8d8b58ddb223c354dd9ada))
+
+## [0.1.8](https://github.com/tomtom-internal/maps-sdk-js/compare/maps-sdk-plugin-viewport-places-v0.1.7...maps-sdk-plugin-viewport-places-v0.1.8) (2026-02-16)
+
+
+### Bug Fixes
+
+* omit bounding box and position from search options in viewport places plugin since they should be automatically set ([a2ffd50](https://github.com/tomtom-internal/maps-sdk-js/commit/a2ffd503c58cbf0c17c678b54cf6f83d8074936f))
+
+## [0.1.6](https://github.com/tomtom-internal/maps-sdk-js/compare/maps-sdk-plugin-viewport-places-v0.1.5...maps-sdk-plugin-viewport-places-v0.1.6) (2026-01-30)
+
+
+### Features
+
+* **viewport-places:** improve types ([817678e](https://github.com/tomtom-internal/maps-sdk-js/commit/817678e6d280560307bfb445bf183136aca69a41))
+
+
+### Bug Fixes
+
+* improve release workflow and update documentation ([905a7ed](https://github.com/tomtom-internal/maps-sdk-js/commit/905a7ed0f3770ce51ac2937a948ef4ad6b8bfcaa))
+
+## [0.1.5](https://github.com/tomtom-internal/maps-sdk-js/compare/maps-sdk-plugin-viewport-places-v0.1.4...maps-sdk-plugin-viewport-places-v0.1.5) (2026-01-30)
+
+
+### Bug Fixes
+
+* improve release workflow and update documentation ([905a7ed](https://github.com/tomtom-internal/maps-sdk-js/commit/905a7ed0f3770ce51ac2937a948ef4ad6b8bfcaa))
+
+## [0.1.4](https://github.com/tomtom-internal/maps-sdk-js/compare/maps-sdk-plugin-viewport-places-v0.1.3...maps-sdk-plugin-viewport-places-v0.1.4) (2026-01-30)
+
+
+### Features
+
+* **viewport-places:** improve types ([817678e](https://github.com/tomtom-internal/maps-sdk-js/commit/817678e6d280560307bfb445bf183136aca69a41))
+
+## [0.1.3](https://github.com/tomtom-internal/maps-sdk-js/compare/maps-sdk-plugin-viewport-places-v0.1.2...maps-sdk-plugin-viewport-places-v0.1.3) (2026-01-30)
+
+
+### Features
+
+* **viewport-places:** improve TSDocs ([01ced36](https://github.com/tomtom-internal/maps-sdk-js/commit/01ced36e895f679e0f92f2241d9442c9415e0eb2))
+
+## [0.1.2](https://github.com/tomtom-internal/maps-sdk-js/compare/maps-sdk-plugin-viewport-places-v0.1.1...maps-sdk-plugin-viewport-places-v0.1.2) (2026-01-29)
+
+
+### Features
+
+* simplify viewport places method name, and improve api reference docs ([46c7de1](https://github.com/tomtom-internal/maps-sdk-js/commit/46c7de1f504839a796d8052567069b5d87ccdb0b))
+
+## [0.1.1](https://github.com/tomtom-internal/maps-sdk-js/compare/maps-sdk-plugin-viewport-places-v0.1.0...maps-sdk-plugin-viewport-places-v0.1.1) (2026-01-29)
+
+
+### Features
+
+* add plugins workspace with first plugin to easily display search-powered layers of places on the map ([eac82a2](https://github.com/tomtom-internal/maps-sdk-js/commit/eac82a2ebe731e87463564eb5e1331089ca1cc70))

package/dist/index.d.ts

@@ -58,6 +58,20 @@ export type ViewportPlacesOptions = Omit<ViewportPlacesAddOptions, 'id'> & {
    */
   id: string;
 };
+/**
+ * The options for creating a {@link ViewportPlaces}.
+ *
+ * @group Viewport Places
+ */
+export type ViewportPlacesConstructorOptions = {
+  /**
+   * Called when a refresh on map move, or the clear of a removed module, fails: with the `SDKError` of the
+   * search, or the `TomTomMapError` of the map.
+   *
+   * @defaultValue a `console.warn`
+   */
+  onError?: (error: unknown) => void;
+};
 /**
  * A class for managing dynamic searched place modules on a TomTom map.
  *
@@ -77,11 +91,12 @@ export declare class ViewportPlaces {
    */
   private registeredModules;
   private readonly mapLibreMap;
+  private readonly onError;
   /**
    * Creates an instance of ViewportPlaces bound to a TomTom map.
    * @param map - The TomTom map instance to attach place modules to.
    */
-  constructor(map: TomTomMap);
+  constructor(map: TomTomMap, { onError }?: ViewportPlacesConstructorOptions);
   private getRegisteredModule;
   /**
    * Performs the update logic for a registered PlacesModule, cancelling whatever search that

package/dist/index.es.js

@@ -1 +1 @@
-import{generateId}from"@tomtom-org/maps-sdk/core";import{PlacesModule}from"@tomtom-org/maps-sdk/map";import{createLatestRequest,discoverPlaces}from"@tomtom-org/maps-sdk/services";var ViewportPlaces=class{map;registeredModules={};mapLibreMap;constructor(e){this.map=e,this.mapLibreMap=e.mapLibreMap}getRegisteredModule(e){const s=this.registeredModules[e];if(!s)throw new Error(`Place module with id ${e} not found`);return s}async searchAndDisplay(e){const s=this.registeredModules[e];if(!s)return;const{placesModule:o,options:t,latestSearch:a}=s,i=this.mapLibreMap.getZoom();if(t.minZoom&&i<t.minZoom||t.maxZoom&&i>t.maxZoom)return a.cancel(),void(await o.clear());const r=await a.run(e=>discoverPlaces({geoBias:{boundingBox:this.map.getBBox()},limit:100,...t.searchOptions,signal:e}));r.current&&await o.show(r.value)}async add(e){const s=e.id??generateId(),o={...e,placesModuleConfig:{markerType:"base-map",...e.placesModuleConfig}},t=await PlacesModule.create(this.map,o.placesModuleConfig),a=this.mapLibreMap.on("moveend",()=>{this.searchAndDisplay(s).catch(e=>console.warn("Viewport places could not refresh",e))});return this.registeredModules[s]={placesModule:t,subscription:a,options:o,latestSearch:createLatestRequest()},await this.searchAndDisplay(s),t}async addPOICategories(e){return this.add({...e,searchOptions:{filters:{poiCategories:e.categories}}})}remove(e){const s=this.getRegisteredModule(e);s.latestSearch.cancel(),s.placesModule.clear().catch(e=>console.warn("Viewport places could not clear",e)),s.subscription.unsubscribe(),delete this.registeredModules[e]}removeAll(){Object.keys(this.registeredModules).forEach(e=>this.remove(e))}async update(e){const s=this.getRegisteredModule(e.id),o=s.options;s.options={...o,...e,searchOptions:{...o.searchOptions,...e.searchOptions,filters:{...o.searchOptions.filters,...e.searchOptions.filters}},placesModuleConfig:{...o.placesModuleConfig,...e.placesModuleConfig}},s.placesModule.applyConfig(s.options.placesModuleConfig),await this.searchAndDisplay(e.id)}};export{ViewportPlaces};
+import{generateId}from"@tomtom-org/maps-sdk/core";import{PlacesModule}from"@tomtom-org/maps-sdk/map";import{createLatestRequest,discoverPlaces}from"@tomtom-org/maps-sdk/services";var warn=e=>console.warn("Viewport places could not refresh or clear",e),ViewportPlaces=class{map;registeredModules={};mapLibreMap;onError;constructor(e,{onError:s=warn}={}){this.map=e,this.mapLibreMap=e.mapLibreMap,this.onError=s}getRegisteredModule(e){const s=this.registeredModules[e];if(!s)throw new Error(`Place module with id ${e} not found`);return s}async searchAndDisplay(e){const s=this.registeredModules[e];if(!s)return;const{placesModule:o,options:r,latestSearch:t}=s,a=this.mapLibreMap.getZoom(),{minZoom:i=0,maxZoom:c=Number.POSITIVE_INFINITY}=r;if(a<i||a>c)return t.cancel(),void(await o.clear());const l=await t.run(e=>discoverPlaces({geoBias:{boundingBox:this.map.getBBox()},limit:100,...r.searchOptions,signal:e}));l.current&&await o.show(l.value)}async add(e){const s=e.id??generateId(),o={...e,placesModuleConfig:{markerType:"base-map",...e.placesModuleConfig}},r=await PlacesModule.create(this.map,o.placesModuleConfig),t=this.mapLibreMap.on("moveend",()=>{this.searchAndDisplay(s).catch(this.onError)});return this.registeredModules[s]={placesModule:r,subscription:t,options:o,latestSearch:createLatestRequest()},await this.searchAndDisplay(s),r}async addPOICategories(e){return this.add({...e,searchOptions:{filters:{poiCategories:e.categories}}})}remove(e){const s=this.getRegisteredModule(e);s.latestSearch.cancel(),s.placesModule.clear().catch(this.onError),s.subscription.unsubscribe(),delete this.registeredModules[e]}removeAll(){Object.keys(this.registeredModules).forEach(e=>this.remove(e))}async update(e){const s=this.getRegisteredModule(e.id),o=s.options;s.options={...o,...e,searchOptions:{...o.searchOptions,...e.searchOptions,filters:{...o.searchOptions.filters,...e.searchOptions.filters}},placesModuleConfig:{...o.placesModuleConfig,...e.placesModuleConfig}},e.placesModuleConfig&&s.placesModule.applyConfig(s.options.placesModuleConfig),await this.searchAndDisplay(e.id)}};export{ViewportPlaces};

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tomtom-org/maps-sdk-plugin-viewport-places",
   "author": "TomTom International B.V.",
   "license": "SEE LICENSE IN LICENSE.txt",
-  "version": "0.5.9",
+  "version": "0.5.10",
   "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",
@@ -18,12 +18,13 @@
     "typescript": "^6.0.3",
     "vite": "^8.3.4",
     "vitest": "^5.0.5",
-    "@tomtom-org/maps-sdk": "1.0.0-rc.5"
+    "@tomtom-org/maps-sdk": "1.0.0-rc.6"
   },
   "files": [
     "dist",
     "package.json",
     "README.md",
+    "CHANGELOG.md",
     "LICENSE.txt",
     "THIRD_PARTY.txt",
     "!**/*.map"