@tomtom-org/maps-sdk-plugin-viewport-places 0.1.4

package/LICENSE.txt

@@ -0,0 +1,164 @@
+TOMTOM MAPS SDK FOR JAVASCRIPT LICENSE AGREEMENT (“AGREEMENT”)
+
+
+
+By downloading, accessing this the “TomTom Maps SDK for JavaScript, you are entering into a binding agreement with TomTom Global Content B.V. (“TomTom”). Your agreement with TomTom includes the following terms and conditions and the Privacy Policy (https://www.tomtom.com/privacy/ ). You should not use the TomTom Maps SDK for JavaScript if you cannot agree to this Agreement and the Privacy Policy.
+
+
+
+You may not use the TomTom Maps SDK for JavaScript and may not accept the Agreement if you are a person barred from receiving the TomTom Maps SDK for JavaScript under the laws of the European Union or other countries, including the country in which you are resident or from which you use the TomTom Maps SDK for JavaScript. If you agree to be bound by the Agreement on behalf of your employer or other entity, you represent and warrant that you have full legal authority to bind your employer or such entity to the Agreement. If you do not have the requisite authority, you may not accept the Agreement or use the TomTom Maps SDK for JavaScript on behalf of your employer or other entity.
+
+
+
+1. GRANT OF LICENSE: Subject to and conditional upon your compliance at all times with this Agreement, TomTom grants to you a limited, non-exclusive, non-transferable and non-sublicensable, revocable, royalty-free license during the Term (as defined in Clause 9) to use the TomTom Maps SDK for JavaScript in connection with the development of web based applications or mobile applications to be used in connection with the TomTom Maps APIs and, in addition, third party online APIs (“Permitted Applications”). For the avoidance of doubt, you must use the TomTom Maps APIs in connection with the TomTom Maps SDK for JavaScript. Any such Permitted Application and use of the TomTom Maps APIs shall be subject to TomTom's standard terms of use applicable to the TomTom Maps APIs as made available on the TomTom developer portal or any other specific written agreement that you and TomTom have executed regarding the use of the TomTom Maps APIs.
+
+
+
+2. UPDATES AND CHANGES TO THE TOMTOM MAPS SDK FOR JAVASCRIPT AND THIS AGREEMENT: TomTom reserves the right, with or without notice and at its sole discretion, to discontinue, update, modify, upgrade and supplement any of the TomTom Maps SDK for JavaScript or any features within the TomTom Maps SDK for JavaScript and to modify this Agreement. You agree that future versions of the TomTom Maps SDK for JavaScript may be incompatible with applications that were developed on previous versions of the TomTom Maps SDK for JavaScript.
+
+
+
+3. YOUR FURTHER OBLIGATIONS:
+
+
+
+3.1. You agree to use the TomTom Maps SDK for JavaScript only for purposes that are permitted by (a) this Agreement and (b) any applicable law, regulation or generally accepted practices or guidelines in the relevant jurisdictions (including any laws regarding the export of data or software to and from the United States or other relevant countries).
+
+
+
+3.2. Other than as permitted by applicable legislation, you are prohibited from copying (except for backup purposes), modifying, adapting, (re)distributing, renting, lending, publicly presenting, decompiling, reverse engineering, disassembling, or creating derivative works of the TomTom Maps SDK for JavaScript or any part of the TomTom Maps SDK for JavaScript.
+
+
+
+3.3. You may not use the TomTom Maps SDK for JavaScript in connection with any illegal, fraudulent, dishonest or unethical activity or behaviour.
+
+
+
+3.4. You shall be permitted to display TomTom Maps APIs results (“Results”) on third party content or map data provided that nothing shall entitle you to add or incorporate Results into the OSM or any other open source database. You shall also be permitted to display Results from third party content or map data on a TomTom map as a separate layer.
+
+
+
+3.5. The TomTom Maps SDK for JavaScript may include data which TomTom licenses from third parties or open source software. You shall comply with all requirements and restrictions which such third parties may require TomTom to impose on you (and as may be updated and amended by TomTom from time to time). All applicable ODbL Licenses are included within the TomTom Maps SDK for JavaScript download package. It shall be your responsibility to check, review and comply with any updated or amended terms that would apply to the TomTom Maps SDK for JavaScript licensed to you under this Agreement. For the avoidance of doubt, any such software is made available to you under the terms and conditions of the applicable licenses.
+
+
+
+
+
+4. PRIVACY: In order to improve the TomTom Developer Portal and TomTom Maps SDK for JavaScript, TomTom may collect certain usage related information from the software including but not limited to the general SDK and product identifiers, version numbers, and information on which tools and/or services in the TomTom Maps SDK for JavaScript are being used and how they are being used by you. In addition, TomTom may collect your unique identifier and associated IP address for legitimate business reasons (such as without limitation the processing of invoices). This data will be retained for a maximum period of 120 days. The information collected is maintained in accordance with our Privacy Policy.
+
+
+
+5. INTELLECTUAL PROPERTY RIGHTS AND COPYRIGHT NOTICES:
+
+
+
+5.1. All intellectual property rights related to the TomTom Maps SDK for JavaScript and to the TomTom Maps APIs are owned by TomTom and/or its licensors and suppliers. However, TomTom agrees that it obtains no intellectual property rights under this Agreement in or to any Permitted Application that you develop using the TomTom Maps SDK for JavaScript and the TomTom Maps APIs.
+
+
+
+5.2. Your use of any trade names, logos, trademarks, service marks and other marks of TomTom is subject to TomTom’s prior written approval. Any goodwill arising out of the use thereof shall inure to the benefit of TomTom. In addition, you agree not to remove, obscure, mask or change any logo and/or copyright notice placed on or automatically generated by the TomTom Maps SDK for JavaScript or the TomTom Maps APIs.
+
+
+
+
+
+6. WARRANTIES:
+
+
+
+6.1. YOU ACKNOWLEDGE THAT THE TOMTOM MAPS SDK FOR JAVASCRIPT HAS NOT BEEN DEVELOPED TO MEET YOUR INDIVIDUAL REQUIREMENTS AND THAT IT IS THEREFORE YOUR RESPONSIBILITY TO ENSURE THAT THE FACILITIES AND FUNCTIONS OF THE TOMTOM MAPS SDK FOR JAVASCRIPT MEET YOUR REQUIREMENTS. TOMTOM DOES NOT AND CANNOT WARRANT THAT THE TOMTOM MAPS SDK FOR JAVASCRIPT OPERATES UNINTERRUPTED OR ERROR-FREE. TOMTOM DOES NOT WARRANT THAT THE TOMTOM MAPS SDK FOR JAVASCRIPT IS CAPABLE OF INTEROPERATING WITH ANY OTHER SYSTEM, DEVICE OR PRODUCT (EITHER SOFTWARE OR HARDWARE).
+
+
+
+6.2. YOUR USE OF THE TOMTOM MAPS SDK FOR JAVASCRIPT AND ANY MATERIAL DOWNLOADED OR OTHERWISE OBTAINED THROUGH THE USE OF THE TOMTOM MAPS SDK FOR JAVASCRIPT IS AT YOUR OWN DISCRETION AND RISK AND YOU ARE SOLELY RESPONSIBLE FOR ANY DAMAGE TO YOUR COMPUTER SYSTEM OR OTHER DEVICES OR ANY LOSS OF DATA THAT RESULTS FROM SUCH USE.
+
+
+
+6.3. WITHOUT LIMITING CLAUSES 6.1 AND 6.2 ABOVE, THE TOMTOM MAPS SDK FOR JAVASCRIPT IS PROVIDED ON AN “AS IS” AND WITH “ALL FAULTS BASIS” AND TOMTOM EXPRESSLY DISCLAIMS ALL OTHER WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, SATISFACTORY QUALITY, ACCURACY, TITLE AND FITNESS FOR A PARTICULAR PURPOSE.
+
+
+
+6.4. THE PROVISIONS OF THIS CLAUSE DO NOT AFFECT ANY OF YOUR LEGAL RIGHTS UNDER APPLICABLE MANDATORY NATIONAL LEGISLATION, INCLUDING BUT NOT LIMITED TO ANY MANDATORY STATUTORY WARRANTIES. IF ANY PART OF THIS LIMITED WARRANTY IS HELD TO BE INVALID OR UNENFORCEABLE, THE REMAINDER OF THE LIMITED WARRANTY SHALL NONETHELESS REMAIN IN FULL FORCE AND EFFECT.
+
+
+
+
+
+7. LIMITATION OF LIABILITY:
+
+
+
+7.1. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, NEITHER TOMTOM NOR ITS LICENSORS, SUPPLIERS, OFFICERS, DIRECTORS OR EMPLOYEES SHALL BE LIABLE TO YOU OR TO ANY THIRD PARTY FOR ANY DAMAGES, WHETHER DIRECT, SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL (INCLUDING BUT NOT LIMITED TO DAMAGES FOR THE INABILITY TO USE OR ACCESS THE TOMTOM MAPS SDK FOR JAVASCRIPT OR TOMTOM MAPS APIS, LOSS OF DATA, LOSS OF BUSINESS, LOSS OF PROFITS, BUSINESS INTERRUPTION OR THE LIKE) ARISING OUT OF OR RELATED TO THE USE OF, THE INABILITY TO USE OR ACCESS, OR OTHERWISE THE PERFORMANCE OF THE TOMTOM MAPS SDK FOR JAVASCRIPT, EVEN IF TOMTOM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+
+
+7.2. TO THE EXTENT TOMTOM IS NOT PERMITTED UNDER APPLICABLE LAW TO EXCLUDE ITS LIABILITY PURSUANT TO CLAUSE 7.1 ABOVE, TOMTOM’S TOTAL AGGREGATE LIABILITY TO YOU SHALL BE LIMITED TO THE AMOUNT OF US $100.00.
+
+
+
+7.3. THE ABOVE LIMITATIONS OF LIABILITY UNDER THIS CLAUSE 7 DO NOT: (I) AFFECT YOUR RIGHTS UNDER ANY APPLICABLE MANDATORY NATIONAL LEGISLATION; (II) EXCLUDE OR LIMIT ANY LIABILITY THAT CANNOT BE EXCLUDED OR LIMITED UNDER APPLICABLE LAW.
+
+
+
+
+
+8. IPR INDMENITY: To the maximum extent permitted by law, you agree to defend, indemnify and hold TomTom and its respective directors, officers, employees, affiliates, agents and suppliers harmless from and against any and all claims, actions, suits or proceedings, as well as any and all losses, liabilities, damages, costs and expenses (including reasonable attorney’s fees) arising out of or accruing from (a) your use of the TomTom Maps SDK for JavaScript, (b) any application you develop on the TomTom Maps SDK for JavaScript that infringes any copyright, trademark, trade secret, trade dress, patent or other intellectual property right of any person or defames any person or violates their rights of publicity or privacy, and (c) any non-compliance by you with this Agreement.
+
+
+
+9. TERM AND TERMINATION AND DIRECT ENFORCEMENT:
+
+
+
+9.1. This Agreement begins on either (a) the date you demonstrate your acceptance of the terms and conditions of this Agreement or (b) when you first use the TomTom Maps SDK for JavaScript and shall continue until terminated (jointly the “Term”) by either TomTom or you subject to and in accordance with this Agreement. The provisions of this Agreement, which by their nature are intended to survive termination, will remain in effect after termination of this Agreement. Furthermore, you agree that TomTom may directly enforce these provisions against you.
+
+
+
+9.2. Without prejudice to any other rights, TomTom may immediately terminate this Agreement if (i) you fail to comply with any of its terms and conditions, or (ii) the agreement governing the use of TomTom Maps APIs between you and TomTom you has terminated, or (iii) TomTom decides to no longer provide the TomTom Maps SDK for JavaScript or certain parts of the TomTom Maps SDK for JavaScript either entirely or in certain territories related to your use.
+
+
+
+9.3. You may terminate this Agreement by ceasing your use of the TomTom Maps SDK for JavaScript at any time.
+
+
+
+
+
+10. GOVERNING LAW AND DISPUTE RESOLUTION:
+
+
+
+10.1. If you, your employer or the entity on whose behalf you act is incorporated in the European Union then this Agreement and any dispute arising under or in connection with it, including any non-contractual claims and disputes, shall be governed by and construed in accordance with the laws of the Netherlands. The applicability of the United Nations Convention on Contracts for the International Sale of Goods is explicitly excluded. You and TomTom hereby irrevocably submit to the exclusive jurisdiction of the courts of Amsterdam, the Netherlands in respect of any dispute arising under or in connection with this Agreement, including any non-contractual claims or disputes.
+
+
+
+10.2. If you, your employer or the entity on whose behalf you act is incorporated outside of European Union, then this Agreement and any dispute arising under or in connection with it, including any non-contractual claims and disputes, shall be governed by and construed in accordance with the laws of the Netherlands. All disputes arising in connection with the Agreement, including any non-contractual claims or disputes, shall be settled in accordance with the Arbitration Rules of the Netherlands Arbitration Institute. The arbitral tribunal shall be composed of three (3) arbitrators. The place or arbitration shall be Amsterdam and the language of the arbitration shall be English. Consolidation of the arbitral proceedings with other arbitral proceedings, as provided for in Article 1046 of the Dutch Code of Civil Procedure and Article 39 of the Arbitration Rules of the Netherlands Arbitration Institute, is excluded.
+
+
+
+10.3. Notwithstanding this, TomTom shall still be allowed to apply for injunctive remedies (or an equivalent type of urgent legal relief) in any jurisdiction.
+
+--
+
+
+
+11. OTHER LEGAL TERMS:
+
+
+
+11.1. No failure or delay by TomTom to exercise any right or remedy provided under this Agreement or by law shall constitute a waiver of that or any other right or remedy, nor shall it preclude or restrict the further exercise of that or any other right or remedy. No single or partial exercise of such right or remedy shall preclude or restrict the further exercise of that or any other right or remedy.
+
+
+
+11.2. Should for any reason, or to any extent, any provision of this Agreement be held invalid or unenforceable, such invalidity or enforceability shall not affect or render invalid or unenforceable the remaining provisions of this Agreement and the application of that provision shall be enforced to the extent permitted by law.
+
+
+
+11.3. The rights granted to you in this Agreement may not be assigned or transferred by you without TomTom’s prior written approval.
+
+
+
+11.4. The TomTom Maps APIs and TomTom Maps SDK for JavaScript are provided as “Commercial Computer Software” or “restricted computer software”. Use, duplication, or disclosure by the U.S. Government or U.S. Government subcontractor is subject to the restrictions set forth in 48.C.F.R. Section 12.212 or 48 C.F.R.227.2702, as applicable or successor provisions. In respect of the Map API and Search API, the manufacturer is  TomTom Global Content B.V.
+
+
+

package/README.md

@@ -0,0 +1,39 @@
+# 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.
+
+## Docs & examples
+
+- Developer guide: https://docs.tomtom.com/maps-sdk-js/guides/plugins/viewport-places
+- Example: https://docs.tomtom.com/maps-sdk-js/examples/viewport-places-plugin
+
+## Quickstart
+
+Note: SDK plugins `@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`.
+
+2. Import and use the plugin (plugin-specific steps only):
+
+```ts
+import { ViewportPlaces } from '@tomtom-org/maps-sdk-plugin-viewport-places';
+
+// assume `map` is your initialized TomTomMap instance
+const viewportPlaces = new ViewportPlaces(map);
+
+await viewportPlaces.add({
+  id: 'restaurants',
+  searchOptions: { query: 'restaurant', limit: 40 },
+  minZoom: 12,
+});
+```
+
+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.
+
+## License
+
+See `LICENSE.txt`.

package/dist/THIRD_PARTY.txt

@@ -0,0 +1 @@
+No third parties dependencies

package/dist/index.d.ts

@@ -0,0 +1,132 @@
+import { FuzzySearchParams } from '../../services/dist';
+import { PlacesModule } from '../../map/dist';
+import { PlacesModuleConfig } from '../../map/dist';
+import { POICategory } from '../../core/dist';
+import { TomTomMap } from '../../map/dist';
+
+/**
+ * A class for managing dynamic searched place modules on a TomTom map.
+ * It leverages the SDK search service to maintain place modules that automatically update and stay current as the map moves.
+ * @group Viewport Places
+ */
+export declare class ViewportPlaces {
+    private readonly map;
+    /**
+     * Internal map of registered place modules, keyed by their `id`.
+     * @private
+     */
+    private registeredModules;
+    private readonly mapLibreMap;
+    /**
+     * Creates an instance of ViewportPlaces bound to a TomTom map.
+     * @param map - The TomTom map instance to attach place modules to.
+     */
+    constructor(map: TomTomMap);
+    /**
+     * Performs the update logic for a PlacesModule with given options.
+     * @param placesModule - The PlacesModule to update.
+     * @param options - The options containing search parameters and zoom constraints.
+     */
+    private searchAndDisplay;
+    /**
+     * Adds a PlacesModule that displays places based on fuzzy search parameters and automatically updates as the map moves.
+     *
+     * @remarks
+     * * Each call to "add" creates a new place module and places it above previously added modules.
+     * * Place modules are rendered bottom-up in the order they are added: the first added module is displayed at the bottom, and later modules are stacked on top of earlier ones.
+     * * The default places module theme is 'base-map' unless overridden in the options.
+     *
+     * @param options - The options for the place module.
+     * @returns A promise that resolves to the PlacesModule instance managing the module.
+     */
+    add(options: ViewportPlacesAddOptions): Promise<PlacesModule>;
+    /**
+     * Adds a PlacesModule for specific POI categories that updates automatically as the map moves.
+     * The POIs are shown in the same style as the base map.
+     *
+     * @remarks
+     * * This is a convenience wrapper over `add` that configures a category-based search for a PlacesModule.
+     * * Each call creates a new place module that will be stacked on top of previously added modules.
+     *
+     * @param options - The options for the category-based place module.
+     * @returns A promise that resolves to the PlacesModule instance managing the module.
+     */
+    addPOICategories(options: ViewportPlacesAddCommonOptions & {
+        categories: POICategory[];
+    }): Promise<PlacesModule>;
+    /**
+     * Removes a specific place module by its ID, stopping its updates and clearing the displayed places.
+     * @remarks
+     * If the id does not exist, an error is logged into console.
+     *
+     * @param id - The unique identifier of the PlacesModule to remove.
+     */
+    remove(id: string): void;
+    /**
+     * Removes all registered place modules, stopping their updates and clearing all displayed places.
+     */
+    removeAll(): void;
+    /**
+     * Updates the search and display options for an existing place module identified by its ID.
+     * This will immediately apply the new options and refresh the place module accordingly.
+     * @param newOptions - The new options to apply.
+     * @throws Error if the place module with the given ID does not exist.
+     */
+    update(newOptions: ViewportPlacesOptions): Promise<void>;
+}
+
+/**
+ * Common Options when adding a viewport places module.
+ *
+ * @group Viewport Places
+ */
+export declare type ViewportPlacesAddCommonOptions = {
+    /**
+     * Optional unique identifier for the viewport places module.
+     *
+     * @remarks
+     * * If not provided, a random ID will be generated.
+     * * If you need to keep updating or removing this place module later, provide a fixed ID.
+     */
+    id?: string;
+    /**
+     * Minimum zoom level at which the place module is visible.
+     */
+    minZoom?: number;
+    /**
+     * Maximum zoom level at which the place module is visible.
+     */
+    maxZoom?: number;
+};
+
+/**
+ * Full Options when adding a viewport places module.
+ *
+ * @group Viewport Places
+ */
+export declare type ViewportPlacesAddOptions = ViewportPlacesAddCommonOptions & {
+    /**
+     * The search parameters to query places for this place module.
+     */
+    searchOptions: FuzzySearchParams;
+    /**
+     * Optional configuration for the places module, such as styling.
+     */
+    placesModuleConfig?: PlacesModuleConfig;
+};
+
+/**
+ * Options when updating a viewport places module.
+ *
+ * @group Viewport Places
+ */
+export declare type ViewportPlacesOptions = Omit<ViewportPlacesAddOptions, 'id'> & {
+    /**
+     * The unique identifier of the place module to update.
+     * @remarks
+     * * This ID must correspond to an existing place module added via an "add" method.
+     */
+    id: string;
+};
+
+export { }

package/dist/index.es.js.js

@@ -0,0 +1,2 @@
+import{generateId as e}from"@tomtom-org/maps-sdk/core";import{PlacesModule as o}from"@tomtom-org/maps-sdk/map";import{search as s}from"@tomtom-org/maps-sdk/services";class i{constructor(e){this.map=e,this.mapLibreMap=e.mapLibreMap}registeredModules={};mapLibreMap;async searchAndDisplay(e,o){const i=this.mapLibreMap.getZoom();o.minZoom&&i<o.minZoom||o.maxZoom&&i>o.maxZoom?await e.clear():await e.show(await s({boundingBox:this.map.getBBox(),limit:100,...o.searchOptions}))}async add(s){const i=s.id??e(),t={...s,placesModuleConfig:{theme:"base-map",...s.placesModuleConfig}},a=await o.get(this.map,t.placesModuleConfig),r=async()=>{const e=this.registeredModules[i];await this.searchAndDisplay(e.placesModule,e.options)},p=this.mapLibreMap.on("moveend",r);return this.registeredModules[i]={placesModule:a,subscription:p,options:t},await r(),a}async addPOICategories(e){return this.add({...e,searchOptions:{query:"",poiCategories:e.categories}})}remove(e){const o=this.registeredModules[e];o?(o.placesModule.clear(),o.subscription.unsubscribe(),delete this.registeredModules[e]):console.error(`Viewport places module ${e} not found`)}removeAll(){Object.keys(this.registeredModules).forEach(e=>this.remove(e))}async update(e){const o=this.registeredModules[e.id];if(!o)throw new Error(`Place module with id ${e.id} not found`);const s=o.options;o.options={...s,...e,searchOptions:{...s.searchOptions,...e.searchOptions},placesModuleConfig:{...s.placesModuleConfig,...e.placesModuleConfig}},o.placesModule.applyConfig(o.options.placesModuleConfig),await this.searchAndDisplay(o.placesModule,o.options)}}export{i as ViewportPlaces};
+//# sourceMappingURL=index.es.js.js.map

package/dist/index.es.js.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.es.js.js","sources":["../src/viewportPlaces.ts"],"sourcesContent":["import { generateId, POICategory } from '@tomtom-org/maps-sdk/core';\nimport { PlacesModule, type PlacesModuleConfig, TomTomMap } from '@tomtom-org/maps-sdk/map';\nimport { type FuzzySearchParams, search } from '@tomtom-org/maps-sdk/services';\n\n/**\n * Common Options when adding a viewport places module.\n *\n * @group Viewport Places\n */\nexport type ViewportPlacesAddCommonOptions = {\n    /**\n     * Optional unique identifier for the viewport places module.\n     *\n     * @remarks\n     * * If not provided, a random ID will be generated.\n     * * If you need to keep updating or removing this place module later, provide a fixed ID.\n     */\n    id?: string;\n    /**\n     * Minimum zoom level at which the place module is visible.\n     */\n    minZoom?: number;\n    /**\n     * Maximum zoom level at which the place module is visible.\n     */\n    maxZoom?: number;\n};\n\n/**\n * Full Options when adding a viewport places module.\n *\n * @group Viewport Places\n */\nexport type ViewportPlacesAddOptions = ViewportPlacesAddCommonOptions & {\n    /**\n     * The search parameters to query places for this place module.\n     */\n    searchOptions: FuzzySearchParams;\n    /**\n     * Optional configuration for the places module, such as styling.\n     */\n    placesModuleConfig?: PlacesModuleConfig;\n};\n\n/**\n * Options when updating a viewport places module.\n *\n * @group Viewport Places\n */\nexport type ViewportPlacesOptions = Omit<ViewportPlacesAddOptions, 'id'> & {\n    /**\n     * The unique identifier of the place module to update.\n     * @remarks\n     * * This ID must correspond to an existing place module added via an \"add\" method.\n     */\n    id: string;\n};\n\n/**\n * A class for managing dynamic searched place modules on a TomTom map.\n * It leverages the SDK search service to maintain place modules that automatically update and stay current as the map moves.\n * @group Viewport Places\n */\nexport class ViewportPlaces {\n    /**\n     * Internal map of registered place modules, keyed by their `id`.\n     * @private\n     */\n    private registeredModules: Record<\n        string,\n        { options: ViewportPlacesAddOptions; placesModule: PlacesModule; subscription: any }\n    > = {};\n    private readonly mapLibreMap;\n\n    /**\n     * Creates an instance of ViewportPlaces bound to a TomTom map.\n     * @param map - The TomTom map instance to attach place modules to.\n     */\n    constructor(private readonly map: TomTomMap) {\n        this.mapLibreMap = map.mapLibreMap;\n    }\n\n    /**\n     * Performs the update logic for a PlacesModule with given options.\n     * @param placesModule - The PlacesModule to update.\n     * @param options - The options containing search parameters and zoom constraints.\n     */\n    private async searchAndDisplay(placesModule: PlacesModule, options: ViewportPlacesAddOptions): Promise<void> {\n        const zoom = this.mapLibreMap.getZoom();\n        if ((options.minZoom && zoom < options.minZoom) || (options.maxZoom && zoom > options.maxZoom)) {\n            await placesModule.clear();\n            return;\n        }\n        await placesModule.show(\n            await search({\n                boundingBox: this.map.getBBox(),\n                limit: 100,\n                ...options.searchOptions,\n            }),\n        );\n    }\n\n    /**\n     * Adds a PlacesModule that displays places based on fuzzy search parameters and automatically updates as the map moves.\n     *\n     * @remarks\n     * * Each call to \"add\" creates a new place module and places it above previously added modules.\n     * * Place modules are rendered bottom-up in the order they are added: the first added module is displayed at the bottom, and later modules are stacked on top of earlier ones.\n     * * The default places module theme is 'base-map' unless overridden in the options.\n     *\n     * @param options - The options for the place module.\n     * @returns A promise that resolves to the PlacesModule instance managing the module.\n     */\n    async add(options: ViewportPlacesAddOptions): Promise<PlacesModule> {\n        const id = options.id ?? generateId();\n        const effectiveOptions = {\n            ...options,\n            placesModuleConfig: { theme: 'base-map', ...options.placesModuleConfig } as PlacesModuleConfig,\n        };\n\n        const placesModule = await PlacesModule.get(this.map, effectiveOptions.placesModuleConfig);\n        const searchAndDisplay = async () => {\n            const entry = this.registeredModules[id];\n            await this.searchAndDisplay(entry.placesModule, entry.options);\n        };\n\n        const subscription = this.mapLibreMap.on('moveend', searchAndDisplay);\n        this.registeredModules[id] = { placesModule, subscription, options: effectiveOptions };\n        await searchAndDisplay();\n        return placesModule;\n    }\n\n    /**\n     * Adds a PlacesModule for specific POI categories that updates automatically as the map moves.\n     * The POIs are shown in the same style as the base map.\n     *\n     * @remarks\n     * * This is a convenience wrapper over `add` that configures a category-based search for a PlacesModule.\n     * * Each call creates a new place module that will be stacked on top of previously added modules.\n     *\n     * @param options - The options for the category-based place module.\n     * @returns A promise that resolves to the PlacesModule instance managing the module.\n     */\n    async addPOICategories(\n        options: ViewportPlacesAddCommonOptions & { categories: POICategory[] },\n    ): Promise<PlacesModule> {\n        return this.add({\n            ...options,\n            searchOptions: { query: '', poiCategories: options.categories },\n        });\n    }\n\n    /**\n     * Removes a specific place module by its ID, stopping its updates and clearing the displayed places.\n     * @remarks\n     * If the id does not exist, an error is logged into console.\n     *\n     * @param id - The unique identifier of the PlacesModule to remove.\n     */\n    remove(id: string): void {\n        const entry = this.registeredModules[id];\n        if (entry) {\n            entry.placesModule.clear();\n            entry.subscription.unsubscribe();\n            delete this.registeredModules[id];\n        } else {\n            console.error(`Viewport places module ${id} not found`);\n        }\n    }\n\n    /**\n     * Removes all registered place modules, stopping their updates and clearing all displayed places.\n     */\n    removeAll(): void {\n        Object.keys(this.registeredModules).forEach((key) => this.remove(key));\n    }\n\n    /**\n     * Updates the search and display options for an existing place module identified by its ID.\n     * This will immediately apply the new options and refresh the place module accordingly.\n     * @param newOptions - The new options to apply.\n     * @throws Error if the place module with the given ID does not exist.\n     */\n    async update(newOptions: ViewportPlacesOptions): Promise<void> {\n        const entry = this.registeredModules[newOptions.id];\n        if (!entry) {\n            throw new Error(`Place module with id ${newOptions.id} not found`);\n        }\n        const currentOptions = entry.options;\n\n        // Update the options by merging current and new options:\n        entry.options = {\n            ...currentOptions,\n            ...newOptions,\n            // search and places display options are merged incrementally:\n            searchOptions: { ...currentOptions.searchOptions, ...newOptions.searchOptions },\n            placesModuleConfig: { ...currentOptions.placesModuleConfig, ...newOptions.placesModuleConfig },\n        };\n        // Update the places module configuration and refresh the display:\n        entry.placesModule.applyConfig(entry.options.placesModuleConfig);\n        await this.searchAndDisplay(entry.placesModule, entry.options);\n    }\n}\n"],"names":["ViewportPlaces","constructor","map","this","mapLibreMap","registeredModules","searchAndDisplay","placesModule","options","zoom","getZoom","minZoom","maxZoom","clear","show","search","boundingBox","getBBox","limit","searchOptions","add","id","generateId","effectiveOptions","placesModuleConfig","theme","PlacesModule","get","async","entry","subscription","on","addPOICategories","query","poiCategories","categories","remove","unsubscribe","console","error","removeAll","Object","keys","forEach","key","update","newOptions","Error","currentOptions","applyConfig"],"mappings":"sKA+DO,MAAMA,EAeT,WAAAC,CAA6BC,GAAAC,KAAAD,IAAAA,EACzBC,KAAKC,YAAcF,EAAIE,WAC3B,CAZQC,kBAGJ,CAAA,EACaD,YAejB,sBAAcE,CAAiBC,EAA4BC,GACvD,MAAMC,EAAON,KAAKC,YAAYM,UACzBF,EAAQG,SAAWF,EAAOD,EAAQG,SAAaH,EAAQI,SAAWH,EAAOD,EAAQI,cAC5EL,EAAaM,cAGjBN,EAAaO,WACTC,EAAO,CACTC,YAAab,KAAKD,IAAIe,UACtBC,MAAO,OACJV,EAAQW,gBAGvB,CAaA,SAAMC,CAAIZ,GACN,MAAMa,EAAKb,EAAQa,IAAMC,IACnBC,EAAmB,IAClBf,EACHgB,mBAAoB,CAAEC,MAAO,cAAejB,EAAQgB,qBAGlDjB,QAAqBmB,EAAaC,IAAIxB,KAAKD,IAAKqB,EAAiBC,oBACjElB,EAAmBsB,UACrB,MAAMC,EAAQ1B,KAAKE,kBAAkBgB,SAC/BlB,KAAKG,iBAAiBuB,EAAMtB,aAAcsB,EAAMrB,UAGpDsB,EAAe3B,KAAKC,YAAY2B,GAAG,UAAWzB,GAGpD,OAFAH,KAAKE,kBAAkBgB,GAAM,CAAEd,eAAcuB,eAActB,QAASe,SAC9DjB,IACCC,CACX,CAaA,sBAAMyB,CACFxB,GAEA,OAAOL,KAAKiB,IAAI,IACTZ,EACHW,cAAe,CAAEc,MAAO,GAAIC,cAAe1B,EAAQ2B,aAE3D,CASA,MAAAC,CAAOf,GACH,MAAMQ,EAAQ1B,KAAKE,kBAAkBgB,GACjCQ,GACAA,EAAMtB,aAAaM,QACnBgB,EAAMC,aAAaO,qBACZlC,KAAKE,kBAAkBgB,IAE9BiB,QAAQC,MAAM,0BAA0BlB,cAEhD,CAKA,SAAAmB,GACIC,OAAOC,KAAKvC,KAAKE,mBAAmBsC,QAASC,GAAQzC,KAAKiC,OAAOQ,GACrE,CAQA,YAAMC,CAAOC,GACT,MAAMjB,EAAQ1B,KAAKE,kBAAkByC,EAAWzB,IAChD,IAAKQ,EACD,MAAM,IAAIkB,MAAM,wBAAwBD,EAAWzB,gBAEvD,MAAM2B,EAAiBnB,EAAMrB,QAG7BqB,EAAMrB,QAAU,IACTwC,KACAF,EAEH3B,cAAe,IAAK6B,EAAe7B,iBAAkB2B,EAAW3B,eAChEK,mBAAoB,IAAKwB,EAAexB,sBAAuBsB,EAAWtB,qBAG9EK,EAAMtB,aAAa0C,YAAYpB,EAAMrB,QAAQgB,0BACvCrB,KAAKG,iBAAiBuB,EAAMtB,aAAcsB,EAAMrB,QAC1D"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@tomtom-org/maps-sdk-plugin-viewport-places",
+  "version": "0.1.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",
+  "scripts": {
+    "build": "vite build --config ../plugin-vite-config.ts",
+    "build:watch": "vite build --watch --config ../plugin-vite-config.ts",
+    "type-check": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "@tomtom-org/maps-sdk": "workspace:*"
+  },
+  "devDependencies": {
+    "@microsoft/api-extractor": "catalog:",
+    "@tsconfig/recommended": "catalog:",
+    "@types/node": "catalog:",
+    "ts-node": "catalog:",
+    "typescript": "catalog:",
+    "vite": "catalog:",
+    "vite-plugin-dts": "catalog:"
+  },
+  "files": [
+    "dist",
+    "package.json",
+    "README.md",
+    "LICENSE.txt"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.es.js"
+    }
+  }
+}