@tomtom-org/maps-sdk-plugin-route-dragging 0.0.0-stage → 0.0.1

package/LICENSE.txt

@@ -0,0 +1,87 @@
+TOMTOM MAPS SDK FOR JAVASCRIPT LICENSE AGREEMENT (“AGREEMENT”)
+
+Last update: October 2026
+
+By downloading or accessing the “TomTom Maps SDK for JavaScript” (the “SDK”), you are entering into a binding agreement with TomTom Global Content B.V. (“TomTom”). The SDK comprises all software, binaries and source code made available by TomTom for it, whether through the TomTom Developer Portal, package registries (e.g. npm) or otherwise. The example applications that TomTom publishes in public code repositories (e.g. GitHub) are not part of the SDK: they are licensed separately, under the license distributed with them. This Agreement with TomTom consists of the terms and conditions below together with the Data Processing Schedule. You should not use the SDK if you cannot agree to both.
+
+You may not use the SDK or accept this Agreement if you are barred from receiving it under the laws of the European Union or of any other country, including the country in which you are resident or from which you use the SDK. If you accept this Agreement on behalf of your employer or another entity, you represent and warrant that you have full legal authority to bind that employer or entity. If you do not have that authority, you may not accept this Agreement or use the SDK on their behalf.
+
+1. GRANT OF LICENSE: Subject to and conditional upon your compliance at all times with this Agreement, TomTom grants you a limited, non-exclusive, non-transferable, non-sublicensable, revocable, royalty-free license during the Term (as defined in Clause 9) to use the SDK to develop web or mobile applications that are used in connection with the TomTom APIs and, in addition, third party online APIs (“Permitted Applications”). For the avoidance of doubt, you must use the TomTom APIs in connection with the SDK. Any Permitted Application and any use of the TomTom APIs is subject to TomTom’s standard terms of use applicable to the TomTom APIs as made available on the TomTom Developer Portal, or to any other specific written agreement executed between you and TomTom regarding the use of the TomTom APIs.
+
+2. UPDATES AND CHANGES TO THE SDK AND THIS AGREEMENT: TomTom reserves the right, with or without notice and at its sole discretion, to discontinue, update, modify, upgrade and supplement the SDK or any of its features, and to modify this Agreement. You agree that future versions of the SDK may be incompatible with applications developed on previous versions.
+
+3. YOUR FURTHER OBLIGATIONS:
+
+3.1. You agree to use the SDK only for purposes permitted by (a) this Agreement and (b) any applicable law, regulation or generally accepted practice or guideline 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. Except as permitted by applicable law or this Clause 3.2, you may not copy (except for backup purposes), modify, adapt, distribute, rent, lend, publicly present, decompile, reverse engineer, disassemble or create derivative works of the SDK. Solely for your Permitted Applications and subject to Clauses 3.3 to 3.5, you may: (a) inspect the SDK, including source code in its source maps, for debugging; (b) copy the SDK as reasonably necessary to develop, build, test and deploy them, including in internal repositories, mirrors and offline build environments used only by you, your Affiliates and your contractors; (c) modify the SDK to fix errors or security vulnerabilities, to maintain compatibility, or to prepare a Contribution under Clause 11.5, but you may not alter, circumvent or disable any functionality for authentication, metering, billing, the notices in Clause 5.2 or the data collection in Clause 4; and (d) distribute the SDK only as a bundled part of a Permitted Application, and not on a standalone basis or as a library. Modified versions remain part of the SDK, and TomTom need not support them. On termination, you must delete all copies held under (b), except copies already distributed under (d). The readability of the SDK's source code does not make it open source and grants no rights beyond those in Clause 1 and this Clause 3.2.
+
+3.3. You may not use the SDK in connection with any illegal, fraudulent, dishonest or unethical activity or behaviour, and in particular not to create or develop, or help others create or develop, a product, service or library that competes, directly or indirectly, with the SDK or the TomTom APIs.
+
+3.4. You are permitted to display TomTom APIs results (“Results”) on third party content or map data, and to display results from third party content or map data on a TomTom map as a separate layer. Nothing herein entitles you to add or incorporate Results into OSM or any other open source database.
+
+3.5. The SDK may include data or software that TomTom licenses from third parties, including open-source software. Such components are made available to you under the terms and conditions of their applicable licenses, and you shall comply with all requirements and restrictions that those third parties may require TomTom to impose on you (as may be updated and amended by TomTom from time to time). It is your responsibility to check, review and comply with those terms as they apply to the SDK licensed to you under this Agreement. The applicable third party and open-source notices are set out in the accompanying THIRD_PARTY.txt file. In the event of a conflict between this Agreement and an open-source license governing a specific dependency, that open-source license shall prevail solely with respect to that dependency.
+
+4. PRIVACY: In order to improve the TomTom Developer Portal and the SDK, TomTom may collect certain usage related information from the software, including but not limited to general SDK and product identifiers, version numbers, and information on which tools and/or services in the SDK are used and how you use them. 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 is retained for a maximum period of 120 days and is maintained in accordance with our Privacy Policy (https://www.tomtom.com/privacy/).
+
+5. INTELLECTUAL PROPERTY RIGHTS AND COPYRIGHT NOTICES:
+
+5.1. All intellectual property rights related to the SDK and to the TomTom APIs are owned by TomTom and/or its licensors and suppliers. TomTom obtains no intellectual property rights under this Agreement in or to any Permitted Application that you develop using the SDK and the TomTom 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, and any goodwill arising out of such use shall inure to the benefit of TomTom. You also agree not to remove, obscure, mask or change any logo and/or copyright notice placed on, or automatically generated by, the SDK or the TomTom APIs.
+
+6. WARRANTIES:
+
+6.1. YOU ACKNOWLEDGE THAT THE SDK HAS NOT BEEN DEVELOPED TO MEET YOUR INDIVIDUAL REQUIREMENTS AND THAT IT IS THEREFORE YOUR RESPONSIBILITY TO ENSURE THAT ITS FACILITIES AND FUNCTIONS MEET YOUR REQUIREMENTS. TOMTOM DOES NOT AND CANNOT WARRANT THAT THE SDK OPERATES UNINTERRUPTED OR ERROR-FREE, OR THAT IT IS CAPABLE OF INTEROPERATING WITH ANY OTHER SYSTEM, DEVICE OR PRODUCT (EITHER SOFTWARE OR HARDWARE).
+
+6.2. YOUR USE OF THE SDK AND OF ANY MATERIAL DOWNLOADED OR OTHERWISE OBTAINED THROUGH ITS USE 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 SDK IS PROVIDED ON AN “AS IS” AND “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. THIS CLAUSE 6 DOES NOT AFFECT ANY OF YOUR LEGAL RIGHTS UNDER APPLICABLE MANDATORY NATIONAL LEGISLATION, INCLUDING BUT NOT LIMITED TO ANY MANDATORY STATUTORY WARRANTIES.
+
+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 SDK OR THE TOMTOM 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 SDK, 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 EUR 100.00.
+
+7.3. THE LIMITATIONS OF LIABILITY UNDER THIS CLAUSE 7 DO NOT: (I) AFFECT YOUR RIGHTS UNDER ANY APPLICABLE MANDATORY NATIONAL LEGISLATION; OR (II) EXCLUDE OR LIMIT ANY LIABILITY THAT CANNOT BE EXCLUDED OR LIMITED UNDER APPLICABLE LAW.
+
+8. IPR INDEMNITY: 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 SDK, (b) any application you develop on the SDK that infringes any copyright, trademark, trade secret, trade dress, patent or other intellectual property right of any person, or that 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 its terms and conditions or (b) the date you first use the SDK, and continues until terminated (jointly the “Term”) by either TomTom or you 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, and 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, (ii) the agreement governing the use of the TomTom APIs between you and TomTom has terminated, or (iii) TomTom decides to no longer provide the SDK, or certain parts of it, either entirely or in territories related to your use.
+
+9.3. You may terminate this Agreement at any time by ceasing your use of the SDK.
+
+10. GOVERNING LAW AND DISPUTE RESOLUTION:
+
+10.1. 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.
+
+10.2. If you, your employer or the entity on whose behalf you act is incorporated in the European Union, you and TomTom hereby irrevocably submit to the exclusive jurisdiction of the courts of Amsterdam, the Netherlands, in respect of any such dispute.
+
+10.3. If you, your employer or the entity on whose behalf you act is incorporated outside the European Union, all such 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 of 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.4. Notwithstanding Clauses 10.2 and 10.3, TomTom remains entitled 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 in exercising any right or remedy provided under this Agreement or by law constitutes a waiver of that or any other right or remedy, nor does 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 precludes or restricts its further exercise.
+
+11.2. If any provision of this Agreement is held invalid or unenforceable, for any reason or to any extent, that does not affect the validity or enforceability of the remaining provisions, and the provision concerned 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 APIs and the SDK are provided as “Commercial Computer Software” or “restricted computer software”. Use, duplication or disclosure by the U.S. Government or a 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.
+
+11.5. By submitting any suggestion, bug fix or code contribution (“Contribution”) to TomTom (e.g. via a GitHub issue or discussion), you grant TomTom a perpetual, irrevocable, worldwide, royalty-free and non-exclusive license to use, reproduce, modify and distribute the Contribution as part of the SDK. You represent that you have the legal right to grant this license and that the Contribution does not infringe any third-party intellectual property rights.
+
+THIRD PARTY SOFTWARE NOTICES
+
+As referred to in Clause 3.5, the third party and open-source components included in or required by this package are listed, together with their applicable license notices, in the THIRD_PARTY.txt file distributed alongside this LICENSE.txt. For the SDK bundles themselves, that file is also published at:
+
+https://github.com/tomtom-international/maps-sdk-js/blob/main/THIRD_PARTY.txt

package/README.md

@@ -1,3 +1,52 @@
-# Temporary Holding Version
+# Route Dragging Plugin
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+This plugin lets people edit a route on a [TomTom Maps SDK for JavaScript](https://docs.tomtom.com/maps-sdk-js/introduction/overview)
+map by dragging it. Grab a stop's pin to move it, or pull the route line to add a stop. The route
+re-plans while the pointer moves, so the road follows the hand.
+
+> **Public preview.** This plugin is in [Public Preview](https://docs.tomtom.com/legal/public-preview) until its 1.0.0 release.
+
+## Docs & examples
+
+- Developer guide: https://docs.tomtom.com/maps-sdk-js/guides/plugins/route-dragging
+- Example: https://docs.tomtom.com/maps-sdk-js/examples/route-dragging-plugin
+
+## Quickstart
+
+This plugin declares `@tomtom-org/maps-sdk` and `lodash-es` as peer dependencies and bundles neither. `lodash-es` is one of the SDK's own peers, so it installs with the SDK.
+
+```bash
+npm install @tomtom-org/maps-sdk maplibre-gl @tomtom-org/maps-sdk-plugin-route-dragging
+```
+
+```javascript
+import { RoutingModule } from '@tomtom-org/maps-sdk/map';
+import { RouteDragging } from '@tomtom-org/maps-sdk-plugin-route-dragging';
+
+const routing = await RoutingModule.create(map);
+const dragging = new RouteDragging(routing);
+
+await dragging.setWaypoints([
+    [4.9041, 52.3676], // Amsterdam
+    [5.1214, 52.0907], // Utrecht
+]);
+```
+
+## Features
+
+- **Move a stop** by its pin. The pin keeps the spot you grabbed it by, so it doesn't jump under the pointer.
+- **Add a stop** by pulling a route line. It goes between the two stops its detour fits best.
+- **Live re-planning**, twice a second by default and once more on the drop.
+- **Answers in order.** The requests overlap rather than cancel each other, so a slow route still
+  shows mid-drag, and an older answer never replaces a newer one.
+- **Your own planner.** Pass `plan` to route with your own options, such as a truck profile or alternatives.
+- **Your own state.** With `showOnMap: false`, it shows nothing itself: it reports each change and
+  each route, and your app shows them, as a React or Vue store would want.
+
+## License
+
+See [LICENSE.txt](./LICENSE.txt).
+
+## Security
+
+To report a security vulnerability, follow [SECURITY.md](https://github.com/tomtom-international/maps-sdk-js/blob/main/SECURITY.md), which keeps it private.

package/THIRD_PARTY.txt

@@ -0,0 +1,77 @@
+THIRD-PARTY SOFTWARE NOTICES FOR @tomtom-org/maps-sdk-plugin-route-dragging
+
+This file lists the third-party components used by this package, together with
+their licenses. It is generated from the build output — do not edit it by hand.
+
+Components marked "Bundled: false (peer dependency)" are not shipped inside it:
+your package manager installs them alongside it and your application bundles them.
+The licenses below apply to those copies, and each such component may in turn install
+its own dependencies under their own licenses.
+
+The software itself is licensed under the terms in LICENSE.txt, which is not affected
+by the licenses reproduced here.
+
+--------------------------------------------------------------------------------
+
+Name: lodash-es
+Version: 4.18.1
+License: MIT
+Bundled: false (peer dependency)
+Description: Lodash exported as ES modules.
+Repository: lodash/lodash
+Homepage: https://lodash.com/custom-builds
+Author: John-David Dalton <john.david.dalton@gmail.com>
+Contributors:
+  John-David Dalton <john.david.dalton@gmail.com>
+  Mathias Bynens <mathias@qiwi.be>
+License Text:
+===
+
+Copyright OpenJS Foundation and other contributors <https://openjsf.org/>
+
+Based on Underscore.js, copyright Jeremy Ashkenas,
+DocumentCloud and Investigative Reporters & Editors <http://underscorejs.org/>
+
+This software consists of voluntary contributions made by many
+individuals. For exact contribution history, see the revision history
+available at https://github.com/lodash/lodash
+
+The following license applies to all parts of this software except as
+documented below:
+
+====
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+====
+
+Copyright and related rights for sample code are waived via CC0. Sample
+code is defined as all source code displayed within the prose of the
+documentation.
+
+CC0: http://creativecommons.org/publicdomain/zero/1.0/
+
+====
+
+Files located in the node_modules and vendor directories are externally
+maintained libraries used by this software which have their own
+licenses; we recommend you read them, as their terms may differ from the
+terms above.
+

package/dist/THIRD_PARTY.txt

@@ -0,0 +1,66 @@
+The following third-party components are declared as peer dependencies. Their code is
+NOT bundled into this package: your package manager installs them alongside it and
+your application bundles them. The licenses below apply to those copies, and each of
+these components may in turn install its own dependencies under their own licenses.
+
+Name: lodash-es
+Version: 4.18.1
+License: MIT
+Bundled: false (peer dependency)
+Description: Lodash exported as ES modules.
+Repository: lodash/lodash
+Homepage: https://lodash.com/custom-builds
+Author: John-David Dalton <john.david.dalton@gmail.com>
+Contributors:
+  John-David Dalton <john.david.dalton@gmail.com>
+  Mathias Bynens <mathias@qiwi.be>
+License Text:
+===
+
+Copyright OpenJS Foundation and other contributors <https://openjsf.org/>
+
+Based on Underscore.js, copyright Jeremy Ashkenas,
+DocumentCloud and Investigative Reporters & Editors <http://underscorejs.org/>
+
+This software consists of voluntary contributions made by many
+individuals. For exact contribution history, see the revision history
+available at https://github.com/lodash/lodash
+
+The following license applies to all parts of this software except as
+documented below:
+
+====
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+====
+
+Copyright and related rights for sample code are waived via CC0. Sample
+code is defined as all source code displayed within the prose of the
+documentation.
+
+CC0: http://creativecommons.org/publicdomain/zero/1.0/
+
+====
+
+Files located in the node_modules and vendor directories are externally
+maintained libraries used by this software which have their own
+licenses; we recommend you read them, as their terms may differ from the
+terms above.

package/dist/index.d.ts

@@ -0,0 +1,196 @@
+import { Routes, WaypointLike } from "@tomtom-org/maps-sdk/core";
+import { DragEventType, PlanningWaypoint, RoutingModule } from "@tomtom-org/maps-sdk/map";
+//#region ../../node_modules/.pnpm/@types+geojson@7946.0.16/node_modules/@types/geojson/index.d.ts
+/**
+ * A Position is an array of coordinates.
+ * https://tools.ietf.org/html/rfc7946#section-3.1.1
+ * Array should contain between two and three elements.
+ * The previous GeoJSON specification allowed more elements (e.g., which could be used to represent M values),
+ * but the current specification only allows X, Y, and (optionally) Z to be defined.
+ *
+ * Note: the type will not be narrowed down to `[number, number] | [number, number, number]` due to
+ * marginal benefits and the large impact of breaking change.
+ *
+ * See previous discussions on the type narrowing:
+ * - {@link https://github.com/DefinitelyTyped/DefinitelyTyped/pull/21590|Nov 2017}
+ * - {@link https://github.com/DefinitelyTyped/DefinitelyTyped/discussions/67773|Dec 2023}
+ * - {@link https://github.com/DefinitelyTyped/DefinitelyTyped/discussions/71441| Dec 2024}
+ *
+ * One can use a
+ * {@link https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates|user-defined type guard that returns a type predicate}
+ * to determine if a position is a 2D or 3D position.
+ *
+ * @example
+ * import type { Position } from 'geojson';
+ *
+ * type StrictPosition = [x: number, y: number] | [x: number, y: number, z: number]
+ *
+ * function isStrictPosition(position: Position): position is StrictPosition {
+ *   return position.length === 2 || position.length === 3
+ * };
+ *
+ * let position: Position = [-116.91, 45.54];
+ *
+ * let x: number;
+ * let y: number;
+ * let z: number | undefined;
+ *
+ * if (isStrictPosition(position)) {
+ *   // `tsc` would throw an error if we tried to destructure a fourth parameter
+ * 	 [x, y, z] = position;
+ * } else {
+ * 	 throw new TypeError("Position is not a 2D or 3D point");
+ * }
+ */
+type Position = number[];
+//#endregion
+//#region src/RouteDragging.d.ts
+/**
+ * How a drag edits the waypoints.
+ *
+ * - `'move'`: A waypoint's pin is dragged to a new position.
+ * - `'insert'`: A new waypoint is pulled off a route line, then dragged like a pin.
+ *
+ * @group Route dragging
+ */
+type WaypointDragKind = 'move' | 'insert';
+/**
+ * One step of a drag, as {@link RouteDraggingOptions.onWaypointsChange} reports it.
+ *
+ * @group Route dragging
+ */
+type WaypointDrag = {
+  /** `'dragstart'` once, `'drag'` on every move, then `'dragend'` where the waypoint is dropped. */
+  type: DragEventType;
+  kind: WaypointDragKind;
+  /**
+   * The dragged waypoint's index in the waypoints, `null` placeholders included. For an
+   * `'insert'`, the index the new waypoint was inserted at.
+   */
+  waypointIndex: number;
+  /** Where the dragged waypoint is now, as `[longitude, latitude]`. */
+  position: Position;
+};
+/**
+ * Plans the routes through the given locations, cancelled when `signal` aborts.
+ *
+ * @group Route dragging
+ */
+type RouteDraggingPlanner = (locations: WaypointLike[], signal: AbortSignal) => Promise<Routes>;
+/**
+ * Options for {@link RouteDragging}.
+ *
+ * @group Route dragging
+ */
+type RouteDraggingOptions = {
+  /**
+   * Plans the routes for the waypoints, `null` placeholders left out.
+   *
+   * Pass your own to plan with your route options, or `false` to plan nothing and only get the
+   * waypoint changes.
+   *
+   * @defaultValue `calculateRoute({ locations, signal })`
+   */
+  plan?: RouteDraggingPlanner | false;
+  /**
+   * How often the routes re-plan while a drag lasts, in milliseconds. The drop always plans once more.
+   *
+   * @defaultValue `500`
+   */
+  planIntervalMS?: number;
+  /**
+   * Whether dragging a route line pulls a new waypoint off it, between the stops its detour fits best.
+   *
+   * @defaultValue `true`
+   */
+  insertFromRouteLines?: boolean;
+  /**
+   * Whether the plugin shows the dragged waypoints and the planned routes on the routing module.
+   *
+   * Set it to `false` when your app shows them itself: apply each change
+   * {@link onWaypointsChange} reports and show the routes {@link onRoutes} receives.
+   *
+   * @defaultValue `true`
+   */
+  showOnMap?: boolean;
+  /**
+   * Called on every step of a drag, with the waypoints it leaves.
+   */
+  onWaypointsChange?: (waypoints: PlanningWaypoint[], drag: WaypointDrag) => void;
+  /**
+   * Called with each planned answer, in order: an answer older than one already received is dropped.
+   *
+   * @param waypoints - The waypoints the routes were planned for
+   */
+  onRoutes?: (routes: Routes, waypoints: PlanningWaypoint[]) => void;
+  /**
+   * Called when planning fails.
+   *
+   * @defaultValue a `console.warn`
+   */
+  onError?: (error: unknown) => void;
+};
+/**
+ * Edits a route by dragging on a {@link RoutingModule}: a waypoint's pin moves its stop, and a route
+ * line pulls a new stop off it. The routes re-plan as you drag.
+ *
+ * @remarks
+ * **[Public Preview](https://docs.tomtom.com/legal/public-preview)** until the plugin's 1.0.0 release.
+ *
+ * - It edits the waypoints the routing module last showed, so its indexes are the pins' own.
+ * - While a drag lasts, the routes re-plan every {@link RouteDraggingOptions.planIntervalMS}, and once
+ *   more on the drop.
+ * - The requests overlap rather than cancel each other, so a route slower than the interval still
+ *   shows during the drag. An answer older than one already shown is dropped, through
+ *   `createLatestRequest({ supersede: 'on-answer' })`.
+ * - With `showOnMap: false`, it shows nothing itself, and your app shows what it reports.
+ *
+ * @example
+ * ```ts
+ * const routing = await RoutingModule.create(map);
+ * const dragging = new RouteDragging(routing);
+ * await dragging.setWaypoints([[4.9041, 52.3676], [5.1214, 52.0907]]);
+ * ```
+ *
+ * @group Route dragging
+ */
+export declare class RouteDragging {
+  private readonly routing;
+  private readonly plan?;
+  private readonly showOnMap;
+  private readonly onWaypointsChange;
+  private readonly onRoutes;
+  private readonly onError;
+  private readonly latestRoutes;
+  private readonly planWhileDragging;
+  private readonly unsubscribes;
+  private waypoints;
+  private plannedWaypoints?;
+  private activeDrag?;
+  constructor(routing: RoutingModule, options?: RouteDraggingOptions);
+  /**
+   * Whether a waypoint is being dragged.
+   */
+  get dragging(): boolean;
+  /**
+   * The waypoints, as the routing module last showed them or a drag left them.
+   */
+  getWaypoints(): PlanningWaypoint[];
+  /**
+   * Shows the waypoints on the routing module and plans the routes through them.
+   *
+   * @remarks
+   * With `showOnMap: false`, call `routing.showWaypoints` yourself instead: the plugin follows
+   * whatever the routing module shows.
+   */
+  setWaypoints(waypoints: PlanningWaypoint[]): Promise<void>;
+  /**
+   * Stops listening to the routing module, and drops the plans still in flight.
+   */
+  remove(): void;
+  private startMove;
+  private dragTo;
+  private planRoutes;
+}
+//#endregion
+export type { RouteDraggingOptions, RouteDraggingPlanner, WaypointDrag, WaypointDragKind };

package/dist/index.es.js

@@ -0,0 +1 @@
+import{findBestWaypointInsertionIndex,getPosition}from"@tomtom-org/maps-sdk/core";import{calculateRoute,createLatestRequest}from"@tomtom-org/maps-sdk/services";import{omit,throttle}from"lodash-es";var pinOnlyProperties=["id","index","indexType","iconID","stopDisplayIndex","stopDisplayLabel","stopDuration"],waypointAt=(t,n)=>{const o="object"!=typeof(i=n)||null===i||Array.isArray(i)||"Feature"!==i.type?void 0:n;var i;const{pauseDurationSeconds:s,legCostModel:a}=o?.properties??{};return{type:"Feature",...void 0!==o?.id&&{id:o.id},geometry:{type:"Point",coordinates:t},properties:{...void 0!==s&&{pauseDurationSeconds:s},...a&&{legCostModel:a}}}},planWithCalculateRoute=(t,n)=>calculateRoute({locations:t,signal:n}),warn=t=>console.warn("Route dragging could not plan the routes",t),RouteDragging=class{routing;plan;showOnMap;onWaypointsChange;onRoutes;onError;latestRoutes=createLatestRequest({supersede:"on-answer"});planWhileDragging;unsubscribes;waypoints;plannedWaypoints;activeDrag;constructor(t,n={}){this.routing=t,this.waypoints=(t=>{const n=[];for(const o of t.features){const{index:t}=o.properties;for(;n.length<t;)n.push(null);n[t]={...o,properties:omit(o.properties,pinOnlyProperties)}}return n})(t.getShown().waypoints),this.plan=!1===n.plan?void 0:n.plan??planWithCalculateRoute,this.showOnMap=n.showOnMap??!0,this.onWaypointsChange=n.onWaypointsChange,this.onRoutes=n.onRoutes,this.onError=n.onError??warn,this.planWhileDragging=throttle(()=>{this.planRoutes()},n.planIntervalMS??500);const{events:o}=t,i=t=>(n,o)=>this.dragTo(t,o.toArray());this.unsubscribes=[o.on("shown-features",t=>{"waypoints"in t&&(this.waypoints=Array.isArray(t.waypoints)?t.waypoints:t.waypoints.features)}),o.waypoints.on("dragstart",(t,n)=>this.startMove(t.properties.index,t.geometry.coordinates,n.toArray())),o.waypoints.on("drag",i("drag")),o.waypoints.on("dragend",i("dragend")),...n.insertFromRouteLines??!0?[o.mainLines.on("dragstart",(t,n)=>{const o=n.toArray(),i=((t,n,o)=>{const i=n.flatMap((t,n)=>t?[{waypoint:t,index:n}]:[]);if(i.length<2)return n.length;const s=findBestWaypointInsertionIndex(t,i.map(({waypoint:t})=>t),o);return i[Math.min(Math.max(s,1),i.length-1)].index})(t,this.waypoints,o);this.waypoints=[...this.waypoints.slice(0,i),waypointAt(o),...this.waypoints.slice(i)],this.activeDrag={kind:"insert",waypointIndex:i,offset:[0,0]},this.dragTo("dragstart",o)}),o.mainLines.on("drag",i("drag")),o.mainLines.on("dragend",i("dragend"))]:[]]}get dragging(){return void 0!==this.activeDrag}getWaypoints(){return this.waypoints}async setWaypoints(t){await this.routing.showWaypoints(t),this.plannedWaypoints=void 0,await this.planRoutes()}remove(){for(const t of this.unsubscribes)t();this.planWhileDragging.cancel(),this.latestRoutes.cancel(),this.activeDrag=void 0}startMove(t,n,o){const[i,s]=getPosition(this.waypoints[t]??void 0)??n;this.activeDrag={kind:"move",waypointIndex:t,offset:[i-o[0],s-o[1]]},this.dragTo("dragstart",o)}dragTo(t,n){const o=this.activeDrag;if(!o)return;const{kind:i,waypointIndex:s,offset:a}=o,e=[n[0]+a[0],n[1]+a[1]],r=getPosition(this.waypoints[s]??void 0);r?.[0]===e[0]&&r[1]===e[1]||(this.waypoints=this.waypoints.map((t,n)=>n===s?waypointAt(e,t):t)),"dragend"===t&&(this.activeDrag=void 0),this.showOnMap&&this.routing.showWaypoints(this.waypoints).catch(this.onError),this.onWaypointsChange?.(this.waypoints,{type:t,kind:i,waypointIndex:s,position:e}),"dragend"===t?(this.planWhileDragging.cancel(),this.planRoutes()):"drag"===t&&this.planWhileDragging()}async planRoutes(){const{plan:t,waypoints:n}=this;if(!t||n===this.plannedWaypoints)return;this.plannedWaypoints=n;const o=n.filter(t=>null!==t);if(o.length<2)this.showOnMap&&await this.routing.clearRoutes();else try{const i=await this.latestRoutes.run(n=>t(o,n));if(!i.current)return;this.showOnMap&&await this.routing.showRoutes(i.value),this.onRoutes?.(i.value,n)}catch(i){this.onError(i)}}};export{RouteDragging};

package/dist/third-party.json

@@ -0,0 +1,17 @@
+[
+  {
+    "name": "lodash-es",
+    "version": "4.18.1",
+    "license": "MIT",
+    "bundled": false,
+    "description": "Lodash exported as ES modules.",
+    "repository": "lodash/lodash",
+    "homepage": "https://lodash.com/custom-builds",
+    "author": "John-David Dalton <john.david.dalton@gmail.com>",
+    "contributors": [
+      "John-David Dalton <john.david.dalton@gmail.com>",
+      "Mathias Bynens <mathias@qiwi.be>"
+    ],
+    "licenseText": "Copyright OpenJS Foundation and other contributors <https://openjsf.org/>\n\nBased on Underscore.js, copyright Jeremy Ashkenas,\nDocumentCloud and Investigative Reporters & Editors <http://underscorejs.org/>\n\nThis software consists of voluntary contributions made by many\nindividuals. For exact contribution history, see the revision history\navailable at https://github.com/lodash/lodash\n\nThe following license applies to all parts of this software except as\ndocumented below:\n\n====\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\nLIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\nOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\nWITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n\n====\n\nCopyright and related rights for sample code are waived via CC0. Sample\ncode is defined as all source code displayed within the prose of the\ndocumentation.\n\nCC0: http://creativecommons.org/publicdomain/zero/1.0/\n\n====\n\nFiles located in the node_modules and vendor directories are externally\nmaintained libraries used by this software which have their own\nlicenses; we recommend you read them, as their terms may differ from the\nterms above."
+  }
+]

package/package.json

@@ -1,6 +1,48 @@
 {
   "name": "@tomtom-org/maps-sdk-plugin-route-dragging",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "author": "TomTom International B.V.",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "version": "0.0.1",
+  "type": "module",
+  "description": "Edit a route on a TomTomMap by dragging: move a waypoint's pin or pull a new stop off the route line, and the route re-plans as you drag, its answers shown in order",
+  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "peerDependencies": {
+    "@tomtom-org/maps-sdk": "^1.0.0-rc.4",
+    "lodash-es": "^4.18.1"
+  },
+  "devDependencies": {
+    "@tsconfig/recommended": "^1.0.13",
+    "@types/geojson": "^7946.0.16",
+    "@types/lodash-es": "^4.17.12",
+    "@types/node": "^26.6.5",
+    "@vitest/coverage-v8": "^5.0.5",
+    "lodash-es": "^4.18.1",
+    "rolldown": "^1.2.14",
+    "typescript": "^6.0.3",
+    "vite": "^8.3.4",
+    "vitest": "^5.0.5",
+    "@tomtom-org/maps-sdk": "1.0.0-rc.4"
+  },
+  "files": [
+    "dist",
+    "package.json",
+    "README.md",
+    "LICENSE.txt",
+    "THIRD_PARTY.txt",
+    "!**/*.map"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.es.js"
+    }
+  },
+  "scripts": {
+    "build": "vite build --config ../plugin-vite-config.ts",
+    "build:watch": "vite build --watch --config ../plugin-vite-config.ts",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "type-check": "tsc --noEmit"
+  }
 }