@tomtom-org/maps-sdk-plugin-agent-toolkit 0.8.0 → 0.10.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { BaseMapModule, CustomGeoJSONLayerSpec, CustomGeoJSONModule, GeometriesModule, GeometryTheme, POIsModule, PlaceConnectionDisplay, PlacesModule, PlanningWaypoint, RoutingModule, StylingModule, TomTomMap, TrafficAreaAnalyticsModule, TrafficAreaAnalyticsModuleConfig, TrafficFlowModule, TrafficIncidentOverlayModule, TrafficIncidentsModule } from "@tomtom-org/maps-sdk/map";
+import { BaseMapModule, CustomGeoJSONLayerSpec, CustomGeoJSONModule, GeometriesModule, GeometryFillStyle, POIsModule, PlaceConnectionDisplay, PlacesModule, PlanningWaypoint, RoutingModule, StylingModule, TomTomMap, TrafficAreaAnalyticsModule, TrafficAreaAnalyticsModuleConfig, TrafficFlowModule, TrafficIncidentOverlayModule, TrafficIncidentsModule } from "@tomtom-org/maps-sdk/map";
 import { BBox, CommonPlaceProps, GeographyType, POICategory, Place, Places, PolygonFeature, PolygonFeatures, Route, Routes, TrafficAreaAnalytics, TrafficIncident, WaypointLike } from "@tomtom-org/maps-sdk/core";
 import { ChartConfiguration } from "chart.js";
 import { Map as Map$1 } from "maplibre-gl";
@@ -1211,9 +1211,9 @@ declare class PlacesState implements StateSlice {
   getEntryPlacesModule(entryId: string, markerType: PlacesMarkerType): Promise<PlacesModule>;
   /**
    * Lazy-init and return the entry's place-geometries module (for POI footprints, municipality
-   * outlines). Re-applies themed config when the theme changes. Throws on unknown entry id.
+   * outlines). Re-applies the config when the fill style changes. Throws on unknown entry id.
    */
-  getEntryGeometriesModule(entryId: string, theme?: GeometryTheme): Promise<GeometriesModule>;
+  getEntryGeometriesModule(entryId: string, fillStyle?: GeometryFillStyle): Promise<GeometriesModule>;
   private _requireEntry;
   get entries(): readonly PlacesEntry[];
   /**
@@ -1259,7 +1259,7 @@ declare class PlacesState implements StateSlice {
    * `entryId` defaults to the latest entry that owns geometries — handy when callers only ever
    * render the most-recently produced footprints. Pass an explicit id to target an older one.
    */
-  showPlaceGeometries(features: PolygonFeature<CommonPlaceProps>[], theme?: GeometryTheme, mode?: 'add' | 'replace', entryId?: string): Promise<void>;
+  showPlaceGeometries(features: PolygonFeature<CommonPlaceProps>[], fillStyle?: GeometryFillStyle, mode?: 'add' | 'replace', entryId?: string): Promise<void>;
   private _latestGeometriesEntryId;
   private _buildGeometryIndex;
   /** IDs of all entries currently shown on the map. */
@@ -1386,8 +1386,8 @@ type RangesEntry = BaseEntry<ReachableRange[]> & {
     geometries?: GeometriesModule;
     places?: PlacesModule;
   };
-  /** Theme that the geometries module is currently configured with. */
-  _shownTheme?: 'filled' | 'outline' | 'inverted';
+  /** Fill style that the geometries module is currently configured with. */
+  _shownFillStyle?: GeometryFillStyle;
   /** True while any of this entry's modules are rendering on the map. */
   _shown?: boolean;
 };
@@ -1445,9 +1445,9 @@ declare class RangeState implements ShownEntriesSlice {
   setEntryMode(mode: EntryMode): Promise<void>;
   /**
    * Lazy-init the entry's GeometriesModule (for the isochrone/isodistance polygons),
-   * applying the requested theme. Throws on unknown id.
+   * applying the requested fill style. Throws on unknown id.
    */
-  getEntryGeometriesModule(entryId: string, theme?: GeometryTheme): Promise<GeometriesModule>;
+  getEntryGeometriesModule(entryId: string, fillStyle?: GeometryFillStyle): Promise<GeometriesModule>;
   /**
    * Lazy-init the entry's origin-pin PlacesModule. Each entry maintains its own pin module
    * so multiple ranges entries can be on the map simultaneously without the pins of one
@@ -1697,11 +1697,11 @@ declare class RoutingState implements ShownEntriesSlice {
   private _params;
   private _entryMode;
   /**
-   * Slice-level "main color" applied to every RoutingModule on first show / re-show. Sticky
+   * Slice-level route colour applied to every RoutingModule on first show / re-show. Sticky
    * across entry swaps so the rendered route always uses the most recently requested color.
-   * Set via {@link setMainColor}; persists for the lifetime of the slice (cleared on `reset`).
+   * Set via {@link setColor}; persists for the lifetime of the slice (cleared on `reset`).
    */
-  private _mainColor?;
+  private _color?;
   /**
    * The most recently `.showEntry`-ed id. Tracks "who was last brought up" so tools that
    * operate on the focused module have a single pointer to read; the authoritative shown
@@ -1745,15 +1745,15 @@ declare class RoutingState implements ShownEntriesSlice {
     showWaypoints?: boolean;
     showSummaryBubbles?: boolean;
   }): Promise<void>;
-  /** Slice-level main color persisted across entry swaps. Undefined when no theme has been set. */
-  get mainColor(): string | undefined;
+  /** Slice-level route colour persisted across entry swaps. Undefined when none has been set. */
+  get color(): string | undefined;
   /**
-   * Set the slice-level main color. The colour is applied immediately to every currently-shown
+   * Set the slice-level route colour. The colour is applied immediately to every currently-shown
    * entry's RoutingModule and remembered so that subsequent {@link showEntry} calls apply it
-   * automatically. Pass `undefined` to clear the sticky theme — currently-shown modules keep
+   * automatically. Pass `undefined` to clear the sticky colour — currently-shown modules keep
    * their last paint until they're re-shown (MapLibre style restore handles full revert).
    */
-  setMainColor(color: string | undefined): void;
+  setColor(color: string | undefined): void;
   /**
    * Hide the entry's routes + waypoints on its module (clear; the module stays cached).
    * No-op when the entry is unknown or already hidden.
@@ -2974,6 +2974,16 @@ export declare const showModeSchema: z.ZodOptional<z.ZodEnum<{
   add: "add";
   replace: "replace";
 }>>;
+/**
+ * How rendered polygons are filled — the SDK's `GeometryFillStyle`.
+ *
+ * @ignore
+ */
+export declare const geometryFillStyleSchema: z.ZodEnum<{
+  filled: "filled";
+  outline: "outline";
+  inverted: "inverted";
+}>;
 /**
  * Shared schema for the geometry-rendering option on tools that produce a places entry
  * (discoverPlaces, locatePlace, ...). When provided, the tool batch-fetches boundary
@@ -2987,7 +2997,7 @@ export declare const showPlaceGeometriesSchema: z.ZodOptional<z.ZodObject<{
     add: "add";
     replace: "replace";
   }>>;
-  theme: z.ZodOptional<z.ZodEnum<{
+  fillStyle: z.ZodOptional<z.ZodEnum<{
     filled: "filled";
     outline: "outline";
     inverted: "inverted";
@@ -3002,7 +3012,7 @@ export declare const showPlaceGeometriesSchema: z.ZodOptional<z.ZodObject<{
  * @ignore
  */
 export declare const geometryDisplayConfigSchema: z.ZodObject<{
-  theme: z.ZodOptional<z.ZodEnum<{
+  fillStyle: z.ZodOptional<z.ZodEnum<{
     filled: "filled";
     outline: "outline";
     inverted: "inverted";
@@ -3356,12 +3366,12 @@ type CustomGeometriesEntry = BaseEntry<PolygonFeature[]> & {
   provenance: GeometryProvenance;
   /**
    * Per-entry GeometriesModule. Each entry owns its own module so display state
-   * (theme, current features) lives on the entry instead of a shared slice-level
+   * (fill style, current features) lives on the entry instead of a shared slice-level
    * module. Lazy-initialised via CustomGeometriesState helpers.
    */
   _module?: GeometriesModule;
-  /** Theme that the geometries module is currently configured with. */
-  _shownTheme?: 'filled' | 'outline' | 'inverted';
+  /** Fill style that the geometries module is currently configured with. */
+  _shownFillStyle?: GeometryFillStyle;
   /** True while this entry's `_module` is rendering on the map. */
   _shown?: boolean;
 };
@@ -3422,8 +3432,8 @@ declare class CustomGeometriesState implements ShownEntriesSlice, StateSlice {
    * Returns the assigned id. Under `single` mode the new entry replaces every older one.
    */
   addEntry(features: PolygonFeature<CommonPlaceProps>[], provenance: CustomGeometriesEntry['provenance'], label: string, explicitId?: string): Promise<string>;
-  /** Lazy-init the entry's GeometriesModule, applying / re-applying the requested theme. */
-  getEntryGeometriesModule(entryId: string, theme?: GeometryTheme): Promise<GeometriesModule>;
+  /** Lazy-init the entry's GeometriesModule, applying / re-applying the requested fill style. */
+  getEntryGeometriesModule(entryId: string, fillStyle?: GeometryFillStyle): Promise<GeometriesModule>;
   /**
    * Render this entry's polygons. `mode` is scoped to this entry's own layer:
    * - `'replace'` (default) — show exactly `entry.data`, clearing whatever the
@@ -3435,7 +3445,7 @@ declare class CustomGeometriesState implements ShownEntriesSlice, StateSlice {
    * shown entries are hidden first; otherwise the caller uses `hideEntry` / the
    * tools' `hidePreviousEntries` option.
    */
-  showEntry(entryId: string, theme?: GeometryTheme, mode?: 'add' | 'replace'): Promise<void>;
+  showEntry(entryId: string, fillStyle?: GeometryFillStyle, mode?: 'add' | 'replace'): Promise<void>;
   private _hideOthersUnderSingleMode;
   hideEntry(entryId: string): Promise<void>;
   /** Drop a single entry from history (clears its module first). No-op when unknown. */