@tomtom-org/maps-sdk-plugin-agent-toolkit 0.12.0 → 0.13.0

package/dist/index.d.ts

@@ -4148,7 +4148,7 @@ export type EntryDataKind = 'places' | 'routes' | 'incidents' | 'customGeometrie
  * function createMyTool(state: ToolState) {
  *   return tool({
  *     execute: async () => {
- *       const pins = await state.places.getPinPlacesModule();
+ *       const places = await state.places.getEntryPlacesModule('places-0', 'pin');
  *       state.routing.currentRoutes;  // most recent routes
  *       state.baseMap.mapLibreMap;    // MapLibre instance
  *     }
@@ -4214,7 +4214,7 @@ export type ToolState = {
  * @group Agent Toolkit
  */
 export type CodeExecutionConfig = {
-  /** Wall-clock budget per isolated (browser) run, in ms. Default: 5000. */
+  /** Wall-clock budget per isolated (browser) run, in ms. Default: 10000. */
   timeoutMs?: number;
   /**
    * Optional override of the worker's library source. By default the SDK loads its own
@@ -4516,7 +4516,8 @@ export type MapAgentOptions<CS extends ToolState = ToolState> = {
   includeDefaultTools?: boolean;
   /**
    * Tool overrides merged with default tools.
-   * - `ToolEntry` values add a new tool or replace a default.
+   * - {@link ToolDefinition} values (a `ToolEntry`, a builder, or a `DEFAULT_TOOLS` value) add a new
+   *   tool or replace a default.
    * - `false` values exclude a default tool.
    *
    * When omitted, all default tools are used as-is.
@@ -4536,7 +4537,7 @@ export type MapAgentOptions<CS extends ToolState = ToolState> = {
    * });
    * ```
    */
-  tools?: { [K in ToolNameHint]?: ToolEntry<CS> | false | undefined; };
+  tools?: { [K in ToolNameHint]?: ToolDefinition<CS> | false | undefined; };
   /**
    * Custom state slices merged alongside built-in state.
    * Only custom slices need to be provided — built-in slices are created automatically.
@@ -4547,9 +4548,9 @@ export type MapAgentOptions<CS extends ToolState = ToolState> = {
    * Per-kind data-entry configuration. Each {@link DataEntryKind} accepts
    * `{ enabled?, entryMode? }`. Setting `enabled: false` removes the kind from the
    * agent's tool surface entirely — it disappears from `analyseData` / `processData`
-   * scope and input fields, and the slice-specific recall / display / fetch tools
-   * are dropped from the registry. `entryMode` is applied to the underlying slice
-   * right after the agent state is built — before any tool runs.
+   * scope and input fields, and its slice-specific display / fetch tools
+   * ({@link TOOLS_BY_DATA_ENTRY_KIND}) are dropped from the registry; `recallState` stays.
+   * `entryMode` is applied to the underlying slice right after the agent state is built — before any tool runs.
    *
    * Keys are LLM-facing kind names (`routes`, `incidents`) — not slice names
    * (`routing`, `trafficIncidents`). The slice mapping is internal.
@@ -4561,8 +4562,8 @@ export type MapAgentOptions<CS extends ToolState = ToolState> = {
    *     dataEntries: {
    *         routes: { entryMode: 'single' },
    *         incidents: { entryMode: 'single' },
-   *         byod: { enabled: false }, // disables recallState, addByodSource, setByodLayers, updateByodDisplay + byod scope on analyse/process
-   *         ranges: { enabled: false }, // disables findReachableAreas + recallState
+   *         byod: { enabled: false }, // drops addByodSource, setByodLayers, updateByodDisplay + byod scope on analyse/process
+   *         ranges: { enabled: false }, // drops findReachableAreas
    *     },
    * });
    * ```
@@ -4750,7 +4751,7 @@ export declare const createMapAgent: <CS extends ToolState = ToolState>(map: Tom
  *
  * @group Agent Toolkit
  */
-export declare const resolveTools: <S extends ToolState>(defaults: Record<string, ToolDefinition<S>>, overrides?: { [K in ToolNameHint]?: ToolEntry<S> | false | undefined; }) => Record<string, ToolDefinition<S>>;
+export declare const resolveTools: <S extends ToolState>(defaults: Record<string, ToolDefinition<S>>, overrides?: MapAgentOptions<S>["tools"]) => Record<string, ToolDefinition<S>>;
 //#endregion
 //#region src/tools/utilities/clarify-user-intent.d.ts
 /** A single clarification question shown to the user. Exported so a host can type its form state. */