@tomtom-org/maps-sdk-plugin-agent-toolkit 0.3.1 → 0.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -7
- package/dist/THIRD_PARTY.txt +266 -1
- package/dist/index.d.ts +2388 -22304
- package/dist/index.es.js +1 -1
- package/dist/index.es.js.map +1 -1
- package/dist/worker-libs-B7wP94lp.js +2 -0
- package/dist/worker-libs-B7wP94lp.js.map +1 -0
- package/package.json +20 -14
package/README.md
CHANGED
|
@@ -140,7 +140,18 @@ The plugin ships a `DEFAULT_TOOLS` registry covering search, routing, traffic, r
|
|
|
140
140
|
| `processData` | Transform entries into new `places`, `placeConnections`, `geometries`, `byod`, or a `fitOnMap` camera move via dynamic JS |
|
|
141
141
|
| `executeMaplibreCode` | Execute arbitrary MapLibre JS against the live `Map` instance — escape hatch for custom layers, animations, raster overlays |
|
|
142
142
|
|
|
143
|
-
> See [Code generation](https://docs.tomtom.com/maps-sdk-js/guides/plugins/agent-toolkit/code-generation) for the injected identifiers, output contracts, and threat model
|
|
143
|
+
> See [Code generation](https://docs.tomtom.com/maps-sdk-js/guides/plugins/agent-toolkit/code-generation) for the injected identifiers, output contracts, and threat model, and [Scope-aware data tools](https://docs.tomtom.com/maps-sdk-js/guides/plugins/agent-toolkit/scope-aware-data-tools) for how the per-turn classifier scope keeps the prompt small.
|
|
144
|
+
|
|
145
|
+
`analyseData` / `processData` code is **always isolated in the browser** — a Web Worker in a sandboxed, opaque-origin iframe (no DOM/network; terminable on timeout), zero-config (the SDK lazily loads its own bundled turf/h3 for the worker). Where the code runs is chosen by environment, not configured: the browser always isolates; Node / SSR always run on the main thread (where that boundary has no equivalent — defense-in-depth only). The optional `codeExecution` only tunes the isolated browser run:
|
|
146
|
+
|
|
147
|
+
```typescript
|
|
148
|
+
const agent = createMapAgent(map, {
|
|
149
|
+
model,
|
|
150
|
+
codeExecution: { timeoutMs: 5000 }, // wall-clock budget per isolated run (default 5000)
|
|
151
|
+
});
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
> **Experimental** — the isolation boundary is verified by the `e2e-tests/` suite (CSP egress-block, worker termination, opaque-origin isolation), which runs in CI as a dedicated job; if the iframe can't initialise it falls back to the main thread (with a warning). `turf` / `h3` / `routeUtils` are all bundled into the worker, so `analyseData` and `processData` (including route-slicing) run fully in the browser. See the [code-generation guide](https://docs.tomtom.com/maps-sdk-js/guides/plugins/agent-toolkit/code-generation#data-tool-execution-isolation-experimental).
|
|
144
155
|
|
|
145
156
|
### Map display
|
|
146
157
|
|
|
@@ -402,18 +413,50 @@ The classifier prompt is built dynamically from each tool's `classificationPromp
|
|
|
402
413
|
|
|
403
414
|
## System prompt
|
|
404
415
|
|
|
405
|
-
The built-in `BASE_SYSTEM_PROMPT`
|
|
416
|
+
The built-in `BASE_SYSTEM_PROMPT` covers identity, a capability summary, scope/rejection rules, response formatting, data-confidence rules, tool-execution guidance, and session-state conventions. Per-tool mechanics (coordinate order, location-reference routing, etc.) live in the tool descriptions and the classifier prompt, not here.
|
|
406
417
|
|
|
407
|
-
|
|
408
|
-
import { createMapAgent, BASE_SYSTEM_PROMPT } from '@tomtom-org/maps-sdk-plugin-agent-toolkit';
|
|
418
|
+
`systemPrompt` accepts **either** a full replacement string **or** a section-overrides object (`Partial<Record<SystemPromptSection, string>>`) — omitted sections keep their defaults, and you supply only the section body (the heading is added for you):
|
|
409
419
|
|
|
410
|
-
|
|
420
|
+
```typescript
|
|
421
|
+
import {
|
|
422
|
+
createMapAgent,
|
|
423
|
+
BASE_SYSTEM_PROMPT,
|
|
424
|
+
composeSystemPrompt,
|
|
425
|
+
SYSTEM_PROMPT_SECTIONS,
|
|
426
|
+
} from '@tomtom-org/maps-sdk-plugin-agent-toolkit';
|
|
427
|
+
|
|
428
|
+
// Override individual sections — pass the overrides object straight to systemPrompt
|
|
411
429
|
const agent = createMapAgent(map, {
|
|
412
430
|
model,
|
|
413
|
-
|
|
431
|
+
systemPrompt: {
|
|
432
|
+
identity: 'You are a delivery fleet dispatcher built on the TomTom map.',
|
|
433
|
+
responseFormatting: 'Reply in Dutch, metric units, one short paragraph.',
|
|
434
|
+
// every other section falls back to its default
|
|
435
|
+
},
|
|
436
|
+
// Section overrides still honor the prefix and suffix (a full string replacement does not).
|
|
437
|
+
// The prefix is prepended above the whole prompt as a heading-less preamble; the suffix is
|
|
438
|
+
// appended under an "ADDITIONAL INSTRUCTIONS" heading.
|
|
439
|
+
systemPromptPrefix: 'You work for Acme Logistics.',
|
|
440
|
+
systemPromptSuffix: 'Never expose internal entry ids to the user.',
|
|
441
|
+
});
|
|
442
|
+
|
|
443
|
+
// Append-only: keep the whole base prompt, add instructions
|
|
444
|
+
const agent = createMapAgent(map, { model, systemPromptSuffix: 'Always use metric units.' });
|
|
445
|
+
|
|
446
|
+
// composeSystemPrompt() does the same composition explicitly, if you need the string elsewhere
|
|
447
|
+
const prompt = composeSystemPrompt({ responseFormatting: 'Reply in Dutch.' });
|
|
448
|
+
|
|
449
|
+
// Extend a default section instead of replacing it: read its default body from
|
|
450
|
+
// SYSTEM_PROMPT_SECTIONS, derive a new value, and override with the result. Handy for
|
|
451
|
+
// handing a default to a coding agent to rewrite under some criteria.
|
|
452
|
+
const agentWithExtraRule = createMapAgent(map, {
|
|
453
|
+
model,
|
|
454
|
+
systemPrompt: {
|
|
455
|
+
rejectionRules: `${SYSTEM_PROMPT_SECTIONS.rejectionRules}\n- Decline weather questions.`,
|
|
456
|
+
},
|
|
414
457
|
});
|
|
415
458
|
|
|
416
|
-
// Full replacement
|
|
459
|
+
// Full replacement (systemPromptPrefix and systemPromptSuffix are ignored)
|
|
417
460
|
const agent = createMapAgent(map, {
|
|
418
461
|
model,
|
|
419
462
|
systemPrompt: BASE_SYSTEM_PROMPT + '\n\nYou are a delivery fleet dispatcher...',
|
package/dist/THIRD_PARTY.txt
CHANGED
|
@@ -1 +1,266 @@
|
|
|
1
|
-
|
|
1
|
+
Name: h3-js
|
|
2
|
+
Version: 4.4.0
|
|
3
|
+
License: Apache-2.0
|
|
4
|
+
Private: false
|
|
5
|
+
Description: Pure-Javascript version of the H3 library, a hexagon-based geographic grid system
|
|
6
|
+
Repository: https://github.com/uber/h3-js.git
|
|
7
|
+
Author: Nick Rabinowitz <nickr@uber.com>
|
|
8
|
+
Contributors:
|
|
9
|
+
David Ellis <isv.damocles@gmail.com>
|
|
10
|
+
Isaac Brodsky <isaac@isaacbrodsky.com>
|
|
11
|
+
License Text:
|
|
12
|
+
===
|
|
13
|
+
|
|
14
|
+
Apache License
|
|
15
|
+
Version 2.0, January 2004
|
|
16
|
+
http://www.apache.org/licenses/
|
|
17
|
+
|
|
18
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
19
|
+
|
|
20
|
+
1. Definitions.
|
|
21
|
+
|
|
22
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
23
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
24
|
+
|
|
25
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
26
|
+
the copyright owner that is granting the License.
|
|
27
|
+
|
|
28
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
29
|
+
other entities that control, are controlled by, or are under common
|
|
30
|
+
control with that entity. For the purposes of this definition,
|
|
31
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
32
|
+
direction or management of such entity, whether by contract or
|
|
33
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
34
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
35
|
+
|
|
36
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
37
|
+
exercising permissions granted by this License.
|
|
38
|
+
|
|
39
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
40
|
+
including but not limited to software source code, documentation
|
|
41
|
+
source, and configuration files.
|
|
42
|
+
|
|
43
|
+
"Object" form shall mean any form resulting from mechanical
|
|
44
|
+
transformation or translation of a Source form, including but
|
|
45
|
+
not limited to compiled object code, generated documentation,
|
|
46
|
+
and conversions to other media types.
|
|
47
|
+
|
|
48
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
49
|
+
Object form, made available under the License, as indicated by a
|
|
50
|
+
copyright notice that is included in or attached to the work
|
|
51
|
+
(an example is provided in the Appendix below).
|
|
52
|
+
|
|
53
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
54
|
+
form, that is based on (or derived from) the Work and for which the
|
|
55
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
56
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
57
|
+
of this License, Derivative Works shall not include works that remain
|
|
58
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
59
|
+
the Work and Derivative Works thereof.
|
|
60
|
+
|
|
61
|
+
"Contribution" shall mean any work of authorship, including
|
|
62
|
+
the original version of the Work and any modifications or additions
|
|
63
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
64
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
65
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
66
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
67
|
+
means any form of electronic, verbal, or written communication sent
|
|
68
|
+
to the Licensor or its representatives, including but not limited to
|
|
69
|
+
communication on electronic mailing lists, source code control systems,
|
|
70
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
71
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
72
|
+
excluding communication that is conspicuously marked or otherwise
|
|
73
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
74
|
+
|
|
75
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
76
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
77
|
+
subsequently incorporated within the Work.
|
|
78
|
+
|
|
79
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
80
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
81
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
82
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
83
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
84
|
+
Work and such Derivative Works in Source or Object form.
|
|
85
|
+
|
|
86
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
87
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
88
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
89
|
+
(except as stated in this section) patent license to make, have made,
|
|
90
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
91
|
+
where such license applies only to those patent claims licensable
|
|
92
|
+
by such Contributor that are necessarily infringed by their
|
|
93
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
94
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
95
|
+
institute patent litigation against any entity (including a
|
|
96
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
97
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
98
|
+
or contributory patent infringement, then any patent licenses
|
|
99
|
+
granted to You under this License for that Work shall terminate
|
|
100
|
+
as of the date such litigation is filed.
|
|
101
|
+
|
|
102
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
103
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
104
|
+
modifications, and in Source or Object form, provided that You
|
|
105
|
+
meet the following conditions:
|
|
106
|
+
|
|
107
|
+
(a) You must give any other recipients of the Work or
|
|
108
|
+
Derivative Works a copy of this License; and
|
|
109
|
+
|
|
110
|
+
(b) You must cause any modified files to carry prominent notices
|
|
111
|
+
stating that You changed the files; and
|
|
112
|
+
|
|
113
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
114
|
+
that You distribute, all copyright, patent, trademark, and
|
|
115
|
+
attribution notices from the Source form of the Work,
|
|
116
|
+
excluding those notices that do not pertain to any part of
|
|
117
|
+
the Derivative Works; and
|
|
118
|
+
|
|
119
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
120
|
+
distribution, then any Derivative Works that You distribute must
|
|
121
|
+
include a readable copy of the attribution notices contained
|
|
122
|
+
within such NOTICE file, excluding those notices that do not
|
|
123
|
+
pertain to any part of the Derivative Works, in at least one
|
|
124
|
+
of the following places: within a NOTICE text file distributed
|
|
125
|
+
as part of the Derivative Works; within the Source form or
|
|
126
|
+
documentation, if provided along with the Derivative Works; or,
|
|
127
|
+
within a display generated by the Derivative Works, if and
|
|
128
|
+
wherever such third-party notices normally appear. The contents
|
|
129
|
+
of the NOTICE file are for informational purposes only and
|
|
130
|
+
do not modify the License. You may add Your own attribution
|
|
131
|
+
notices within Derivative Works that You distribute, alongside
|
|
132
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
133
|
+
that such additional attribution notices cannot be construed
|
|
134
|
+
as modifying the License.
|
|
135
|
+
|
|
136
|
+
You may add Your own copyright statement to Your modifications and
|
|
137
|
+
may provide additional or different license terms and conditions
|
|
138
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
139
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
140
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
141
|
+
the conditions stated in this License.
|
|
142
|
+
|
|
143
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
144
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
145
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
146
|
+
this License, without any additional terms or conditions.
|
|
147
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
148
|
+
the terms of any separate license agreement you may have executed
|
|
149
|
+
with Licensor regarding such Contributions.
|
|
150
|
+
|
|
151
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
152
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
153
|
+
except as required for reasonable and customary use in describing the
|
|
154
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
155
|
+
|
|
156
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
157
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
158
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
159
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
160
|
+
implied, including, without limitation, any warranties or conditions
|
|
161
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
162
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
163
|
+
appropriateness of using or redistributing the Work and assume any
|
|
164
|
+
risks associated with Your exercise of permissions under this License.
|
|
165
|
+
|
|
166
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
167
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
168
|
+
unless required by applicable law (such as deliberate and grossly
|
|
169
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
170
|
+
liable to You for damages, including any direct, indirect, special,
|
|
171
|
+
incidental, or consequential damages of any character arising as a
|
|
172
|
+
result of this License or out of the use or inability to use the
|
|
173
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
174
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
175
|
+
other commercial damages or losses), even if such Contributor
|
|
176
|
+
has been advised of the possibility of such damages.
|
|
177
|
+
|
|
178
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
179
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
180
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
181
|
+
or other liability obligations and/or rights consistent with this
|
|
182
|
+
License. However, in accepting such obligations, You may act only
|
|
183
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
184
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
185
|
+
defend, and hold each Contributor harmless for any liability
|
|
186
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
187
|
+
of your accepting any such warranty or additional liability.
|
|
188
|
+
|
|
189
|
+
END OF TERMS AND CONDITIONS
|
|
190
|
+
|
|
191
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
192
|
+
|
|
193
|
+
To apply the Apache License to your work, attach the following
|
|
194
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
195
|
+
replaced with your own identifying information. (Don't include
|
|
196
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
197
|
+
comment syntax for the file format. We also recommend that a
|
|
198
|
+
file or class name and description of purpose be included on the
|
|
199
|
+
same "printed page" as the copyright notice for easier
|
|
200
|
+
identification within third-party archives.
|
|
201
|
+
|
|
202
|
+
Copyright [yyyy] [name of copyright owner]
|
|
203
|
+
|
|
204
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
205
|
+
you may not use this file except in compliance with the License.
|
|
206
|
+
You may obtain a copy of the License at
|
|
207
|
+
|
|
208
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
209
|
+
|
|
210
|
+
Unless required by applicable law or agreed to in writing, software
|
|
211
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
212
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
213
|
+
See the License for the specific language governing permissions and
|
|
214
|
+
limitations under the License.
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
Notice:
|
|
218
|
+
===
|
|
219
|
+
|
|
220
|
+
Copyright 2017-2021 Uber Technologies, Inc.
|
|
221
|
+
|
|
222
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
223
|
+
you may not use this file except in compliance with the License.
|
|
224
|
+
You may obtain a copy of the License at
|
|
225
|
+
|
|
226
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
227
|
+
|
|
228
|
+
Unless required by applicable law or agreed to in writing, software
|
|
229
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
230
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
231
|
+
See the License for the specific language governing permissions and
|
|
232
|
+
limitations under the License.
|
|
233
|
+
|
|
234
|
+
---
|
|
235
|
+
|
|
236
|
+
Name: @turf/turf
|
|
237
|
+
Version: 7.3.5
|
|
238
|
+
License: MIT
|
|
239
|
+
Private: false
|
|
240
|
+
Description: a JavaScript library for performing geospatial operations with GeoJSON
|
|
241
|
+
Repository: git://github.com/Turfjs/turf.git
|
|
242
|
+
Homepage: https://github.com/Turfjs/turf
|
|
243
|
+
Author: Turf Authors
|
|
244
|
+
License Text:
|
|
245
|
+
===
|
|
246
|
+
|
|
247
|
+
The MIT License (MIT)
|
|
248
|
+
|
|
249
|
+
Copyright (c) 2017 TurfJS
|
|
250
|
+
|
|
251
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
252
|
+
this software and associated documentation files (the "Software"), to deal in
|
|
253
|
+
the Software without restriction, including without limitation the rights to
|
|
254
|
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
255
|
+
the Software, and to permit persons to whom the Software is furnished to do so,
|
|
256
|
+
subject to the following conditions:
|
|
257
|
+
|
|
258
|
+
The above copyright notice and this permission notice shall be included in all
|
|
259
|
+
copies or substantial portions of the Software.
|
|
260
|
+
|
|
261
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
262
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
263
|
+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
264
|
+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
265
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
266
|
+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|