@stadiamaps/ferrostar-webcomponents 0.38.0 → 0.40.0

package/dist/ferrostar-core.d.ts

@@ -0,0 +1,36 @@
+import { ReactiveElement, PropertyValues } from 'lit';
+import { SerializableNavState, NavigationController, RouteAdapter, TripState } from '@stadiamaps/ferrostar';
+import { StateProvider } from './types';
+/**
+ * A core navigation component that handles navigation logic without UI.
+ */
+export declare class FerrostarCore extends ReactiveElement implements StateProvider {
+    valhallaEndpointUrl: string;
+    profile: string;
+    httpClient?: Function;
+    locationProvider: any;
+    options: object;
+    protected _navState: SerializableNavState | null;
+    onNavigationStart?: () => void;
+    onNavigationStop?: () => void;
+    onTripStateChange?: (newState: TripState | null) => void;
+    /**
+     * Enables voice guidance via the web speech synthesis API.
+     * Defaults to false.
+     */
+    useVoiceGuidance: boolean;
+    shouldRecord: boolean;
+    routeAdapter: RouteAdapter | null;
+    navigationController: NavigationController | null;
+    lastSpokenUtteranceId: string | null;
+    constructor();
+    updated(changedProperties: PropertyValues<this>): void;
+    getRoutes(initialLocation: any, waypoints: any): Promise<any>;
+    startNavigation(route: any, config: any): void;
+    private saveRecording;
+    stopNavigation(): Promise<void>;
+    provideState(tripState: TripState): void;
+    private navStateUpdate;
+    private onLocationUpdated;
+}
+//# sourceMappingURL=ferrostar-core.d.ts.map

package/dist/ferrostar-core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ferrostar-core.d.ts","sourceRoot":"","sources":["../src/ferrostar-core.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,KAAK,CAAC;AAEtD,OAAO,EACL,oBAAoB,EACpB,oBAAoB,EACpB,YAAY,EACZ,SAAS,EACV,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC;;GAEG;AACH,qBACa,aAAc,SAAQ,eAAgB,YAAW,aAAa;IAEzE,mBAAmB,EAAE,MAAM,CAAM;IAGjC,OAAO,EAAE,MAAM,CAAM;IAGrB,UAAU,CAAC,EAAE,QAAQ,CAAS;IAI9B,gBAAgB,EAAG,GAAG,CAAC;IAIvB,OAAO,EAAE,MAAM,CAAM;IAGrB,SAAS,CAAC,SAAS,EAAE,oBAAoB,GAAG,IAAI,CAAQ;IAGxD,iBAAiB,CAAC,EAAE,MAAM,IAAI,CAAC;IAG/B,gBAAgB,CAAC,EAAE,MAAM,IAAI,CAAC;IAG9B,iBAAiB,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,GAAG,IAAI,KAAK,IAAI,CAAC;IAEzD;;;OAGG;IAEH,gBAAgB,EAAE,OAAO,CAAS;IAGlC,YAAY,EAAE,OAAO,CAAS;IAE9B,YAAY,EAAE,YAAY,GAAG,IAAI,CAAQ;IACzC,oBAAoB,EAAE,oBAAoB,GAAG,IAAI,CAAQ;IACzD,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAQ;;IAW5C,OAAO,CAAC,iBAAiB,EAAE,cAAc,CAAC,IAAI,CAAC;IAOzC,SAAS,CAAC,eAAe,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG;IAoCpD,eAAe,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG;IA4BvC,OAAO,CAAC,aAAa;IAaf,cAAc;IAWpB,YAAY,CAAC,SAAS,EAAE,SAAS;IAUjC,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,iBAAiB;CAoC1B"}

package/dist/ferrostar-map.d.ts

@@ -1,28 +1,35 @@
 import { LitElement, PropertyValues } from 'lit';
-import { default as maplibregl, GeolocateControl, Map } from 'maplibre-gl';
-import { NavigationController, RouteAdapter, TripState } from '@stadiamaps/ferrostar';
+import { default as maplibregl, GeolocateControl } from 'maplibre-gl';
+import { TripState } from '@stadiamaps/ferrostar';
+import { StateProvider as StateProvider } from './types';
 /**
- * A MapLibre-based map component specialized for navigation.
+ * A MapLibre-based map component.
  */
 export declare class FerrostarMap extends LitElement {
-    valhallaEndpointUrl: string;
-    profile: string;
-    httpClient?: Function;
-    locationProvider: any;
-    options: object;
-    protected _tripState: TripState | null;
-    onNavigationStart?: (map: Map) => void;
-    onNavigationStop?: (map: Map) => void;
-    onTripStateChange?: (newState: TripState | null) => void;
+    /**
+     * The MapLibre map instance.
+     *
+     * You have to explicitly set this value when initializing
+     * the web component to provide your own map instance.
+     *
+     */
+    map: maplibregl.Map;
+    stateProvider: StateProvider | null;
     /**
      *  Styles to load which will apply inside the component
      */
-    customStyles?: object | null;
+    customStyles?: object;
+    tripState: TripState | null;
+    route: any;
+    /**
+     * Determines whether the navigation user interface is displayed.
+     */
+    showNavigationUI: boolean;
     /**
-     * Enables voice guidance via the web speech synthesis API.
-     * Defaults to false.
+     * Should the user marker be shown on the map.
+     * This is optional and defaults to false.
      */
-    useVoiceGuidance: boolean;
+    showUserMarker: boolean;
     /**
      * Automatically geolocates the user on map load.
      *
@@ -37,29 +44,59 @@ export declare class FerrostarMap extends LitElement {
      * Set this to false if you want to disable the geolocation control or bring your own.
      */
     addGeolocateControl: boolean;
-    routeAdapter: RouteAdapter | null;
     /**
-     * The MapLibre map instance.
-     *
-     * You have to explicitly set this value when initializing
-     * the web component to provide your own map instance.
-     *
+     * A callback function that is invoked when navigation is stopped.
+     * Optional: This function can be provided by the StateProvider.
+     */
+    onStopNavigation?: () => void;
+    /**
+     * The geolocate control instance.
      */
-    map: maplibregl.Map;
     geolocateControl: GeolocateControl | null;
-    navigationController: NavigationController | null;
-    simulatedLocationMarker: maplibregl.Marker | null;
-    lastSpokenUtteranceId: string | null;
+    private userLocationMarker;
     static styles: import('lit').CSSResult[];
     constructor();
-    updated(changedProperties: PropertyValues<this>): void;
     firstUpdated(): void;
-    getRoutes(initialLocation: any, waypoints: any): Promise<any>;
-    startNavigation(route: any, config: any): void;
-    stopNavigation(): Promise<void>;
-    private tripStateUpdate;
-    private onLocationUpdated;
-    private clearMap;
+    updated(changedProperties: PropertyValues<this>): void;
+    linkWith(stateProvider: StateProvider, showUserMarker?: boolean): void;
+    /**
+     * Renders the current tripState on the map.
+     */
+    private renderTripState;
+    /**
+     * Renders a route on the map.
+     * If a route already exists, it clears the previous route before rendering a new one.
+     * This method adds two layers to the map: the primary route layer and a border layer.
+     */
+    private renderRoute;
+    /**
+     * Renders or updates the user's location marker on the map. If a marker already exists, its position is updated.
+     * Otherwise, a new marker is created and added to the map.
+     */
+    private renderUserLocationMarker;
+    /**
+     * Updates the camera position and orientation on the map based on the navState.
+     * Adjusts the center of the map to the user's current location and sets the bearing
+     * based on the user's course over ground, if available.
+     */
+    private updateCamera;
+    /**
+     * Clears the route layers and source from the map if they exist.
+     */
+    private clearRoute;
+    /**
+     * Removes the user's location marker from the map if it exists and clears the reference.
+     */
+    private clearUserLocationMarker;
+    /**
+     * Clears the current navigation state, including route, user location marker, and navigation-related data.
+     */
+    clearNavigation(): void;
+    /**
+     * Handles the logic for stopping the navigation process. It clears the navigation state,
+     * resets the simulation flag, and invokes the optional onStopNavigation callback if provided.
+     */
+    private handleStopNavigation;
     render(): import('lit-html').TemplateResult<1>;
 }
 //# sourceMappingURL=ferrostar-map.d.ts.map

package/dist/ferrostar-map.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ferrostar-map.d.ts","sourceRoot":"","sources":["../src/ferrostar-map.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAE,cAAc,EAAE,MAAM,KAAK,CAAC;AAE5D,OAAO,UAAU,EAAE,EAAE,gBAAgB,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EACL,oBAAoB,EACpB,YAAY,EACZ,SAAS,EACV,MAAM,uBAAuB,CAAC;AAC/B,OAAO,qBAAqB,CAAC;AAC7B,OAAO,sBAAsB,CAAC;AAI9B;;GAEG;AACH,qBACa,YAAa,SAAQ,UAAU;IAE1C,mBAAmB,EAAE,MAAM,CAAM;IAGjC,OAAO,EAAE,MAAM,CAAM;IAGrB,UAAU,CAAC,EAAE,QAAQ,CAAS;IAI9B,gBAAgB,EAAG,GAAG,CAAC;IAIvB,OAAO,EAAE,MAAM,CAAM;IAGrB,SAAS,CAAC,UAAU,EAAE,SAAS,GAAG,IAAI,CAAQ;IAG9C,iBAAiB,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC;IAGvC,gBAAgB,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC;IAGtC,iBAAiB,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,GAAG,IAAI,KAAK,IAAI,CAAC;IAEzD;;OAEG;IAEH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IAEH,gBAAgB,EAAE,OAAO,CAAS;IAElC;;;;;OAKG;IAEH,eAAe,EAAE,OAAO,CAAQ;IAEhC;;;;;OAKG;IAEH,mBAAmB,EAAE,OAAO,CAAQ;IAEpC,YAAY,EAAE,YAAY,GAAG,IAAI,CAAQ;IAEzC;;;;;;OAMG;IAEH,GAAG,EAAG,UAAU,CAAC,GAAG,CAAC;IAErB,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAQ;IACjD,oBAAoB,EAAE,oBAAoB,GAAG,IAAI,CAAQ;IACzD,uBAAuB,EAAE,UAAU,CAAC,MAAM,GAAG,IAAI,CAAQ;IACzD,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAQ;IAE5C,MAAM,CAAC,MAAM,4BAwEX;;IAWF,OAAO,CAAC,iBAAiB,EAAE,cAAc,CAAC,IAAI,CAAC;IAM/C,YAAY;IAoBN,SAAS,CAAC,eAAe,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG;IAoCpD,eAAe,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG;IAqFjC,cAAc;IAYpB,OAAO,CAAC,eAAe;IAKvB,OAAO,CAAC,iBAAiB;IA+CzB,OAAO,CAAC,QAAQ;IAOhB,MAAM;CA8BP"}
+{"version":3,"file":"ferrostar-map.d.ts","sourceRoot":"","sources":["../src/ferrostar-map.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAE,cAAc,EAAE,MAAM,KAAK,CAAC;AAE5D,OAAO,UAAU,EAAE,EAAE,gBAAgB,EAAU,MAAM,aAAa,CAAC;AAEnE,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,qBAAqB,CAAC;AAC7B,OAAO,sBAAsB,CAAC;AAC9B,OAAO,EAAE,aAAa,IAAI,aAAa,EAAE,MAAM,SAAS,CAAC;AAEzD;;GAEG;AACH,qBACa,YAAa,SAAQ,UAAU;IAC1C;;;;;;OAMG;IAEH,GAAG,EAAG,UAAU,CAAC,GAAG,CAAC;IAGrB,aAAa,EAAE,aAAa,GAAG,IAAI,CAAQ;IAE3C;;OAEG;IAEH,YAAY,CAAC,EAAE,MAAM,CAAC;IAGtB,SAAS,EAAE,SAAS,GAAG,IAAI,CAAQ;IAGnC,KAAK,EAAE,GAAG,CAAQ;IAElB;;OAEG;IAEH,gBAAgB,EAAE,OAAO,CAAS;IAElC;;;OAGG;IAEH,cAAc,EAAE,OAAO,CAAS;IAEhC;;;;;OAKG;IAEH,eAAe,EAAE,OAAO,CAAQ;IAEhC;;;;;OAKG;IAEH,mBAAmB,EAAE,OAAO,CAAQ;IAEpC;;;OAGG;IAEH,gBAAgB,CAAC,EAAE,MAAM,IAAI,CAAC;IAE9B;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAQ;IAEjD,OAAO,CAAC,kBAAkB,CAAuB;IAEjD,MAAM,CAAC,MAAM,4BAyEX;;IAMF,YAAY;IAmBZ,OAAO,CAAC,iBAAiB,EAAE,cAAc,CAAC,IAAI,CAAC;IAgB/C,QAAQ,CAAC,aAAa,EAAE,aAAa,EAAE,cAAc,GAAE,OAAe;IA8BtE;;OAEG;IACH,OAAO,CAAC,eAAe;IASvB;;;;OAIG;IACH,OAAO,CAAC,WAAW;IAqDnB;;;OAGG;IACH,OAAO,CAAC,wBAAwB;IAsBhC;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAapB;;OAEG;IACH,OAAO,CAAC,UAAU;IAMlB;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAO/B;;OAEG;IACH,eAAe;IAOf;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAU5B,MAAM;CAgCP"}