@stadiamaps/ferrostar 0.17.0 → 0.19.0

package/ferrostar.d.ts

@@ -28,6 +28,121 @@ export function locationSimulationFromPolyline(polyline: string, precision: numb
 * @returns {any}
 */
 export function advanceLocationSimulation(state: any): any;
+export interface VisualInstruction {
+    primaryContent: VisualInstructionContent;
+    secondaryContent: VisualInstructionContent | undefined;
+    subContent: VisualInstructionContent | undefined;
+    triggerDistanceBeforeManeuver: number;
+}
+
+export interface VisualInstructionContent {
+    text: string;
+    maneuverType: ManeuverType | undefined;
+    maneuverModifier: ManeuverModifier | undefined;
+    roundaboutExitDegrees: number | undefined;
+    laneInfo: LaneInfo[] | undefined;
+}
+
+export interface LaneInfo {
+    active: boolean;
+    directions: string[];
+    activeDirection: string | undefined;
+}
+
+export type ManeuverModifier = "uturn" | "sharp right" | "right" | "slight right" | "straight" | "slight left" | "left" | "sharp left";
+
+export type ManeuverType = "turn" | "new name" | "depart" | "arrive" | "merge" | "on ramp" | "off ramp" | "fork" | "end of road" | "continue" | "roundabout" | "rotary" | "roundabout turn" | "notification" | "exit roundabout" | "exit rotary";
+
+export interface SpokenInstruction {
+    text: string;
+    ssml: string | undefined;
+    triggerDistanceBeforeManeuver: number;
+    utteranceId: string;
+}
+
+export interface RouteStep {
+    geometry: GeographicCoordinate[];
+    distance: number;
+    duration: number;
+    roadName: string | undefined;
+    instruction: string;
+    visualInstructions: VisualInstruction[];
+    spokenInstructions: SpokenInstruction[];
+    annotations: string[] | undefined;
+}
+
+export interface Route {
+    geometry: GeographicCoordinate[];
+    bbox: BoundingBox;
+    distance: number;
+    waypoints: Waypoint[];
+    steps: RouteStep[];
+}
+
+export interface UserLocation {
+    coordinates: GeographicCoordinate;
+    horizontalAccuracy: number;
+    courseOverGround: CourseOverGround | undefined;
+    timestamp: { secs_since_epoch: number; nanos_since_epoch: number };
+    speed: Speed | undefined;
+}
+
+export interface Speed {
+    value: number;
+    accuracy: number | undefined;
+}
+
+export interface CourseOverGround {
+    degrees: number;
+    accuracy: number | undefined;
+}
+
+export interface BoundingBox {
+    sw: GeographicCoordinate;
+    ne: GeographicCoordinate;
+}
+
+export type WaypointKind = "Break" | "Via";
+
+export interface Waypoint {
+    coordinate: GeographicCoordinate;
+    kind: WaypointKind;
+}
+
+export interface GeographicCoordinate {
+    lat: number;
+    lng: number;
+}
+
+export type SimulationError = { PolylineError: { error: string } } | "NotEnoughPoints";
+
+export interface LocationSimulationState {
+    current_location: UserLocation;
+    remaining_locations: GeographicCoordinate[];
+}
+
+export interface NavigationControllerConfig {
+    stepAdvance: StepAdvanceMode;
+    routeDeviationTracking: RouteDeviationTracking;
+    snappedLocationCourseFiltering: CourseFiltering;
+}
+
+export type StepAdvanceMode = "Manual" | { DistanceToEndOfStep: { distance: number; minimumHorizontalAccuracy: number } } | { RelativeLineStringDistance: { minimumHorizontalAccuracy: number; automaticAdvanceDistance: number | undefined } };
+
+export type CourseFiltering = "SnapToRoute" | "Raw";
+
+export type TripState = "Idle" | { Navigating: { currentStepGeometryIndex: number | undefined; snappedUserLocation: UserLocation; remainingSteps: RouteStep[]; remainingWaypoints: Waypoint[]; progress: TripProgress; deviation: RouteDeviation; visualInstruction: VisualInstruction | undefined; spokenInstruction: SpokenInstruction | undefined; annotationJson: string | undefined } } | "Complete";
+
+export interface TripProgress {
+    distanceToNextManeuver: number;
+    distanceRemaining: number;
+    durationRemaining: number;
+}
+
+export type RouteDeviation = "NoDeviation" | { OffRoute: { deviationFromRouteLine: number } };
+
+export type RouteDeviationTracking = "None" | { StaticThreshold: { minimumHorizontalAccuracy: number; maxAcceptableDeviation: number } };
+
 /**
 * JavaScript wrapper for `NavigationController`.
 */

package/ferrostar_bg.js

@@ -510,6 +510,12 @@ export function __wbindgen_jsval_eq(arg0, arg1) {
     return ret;
 };
 
+export function __wbindgen_boolean_get(arg0) {
+    const v = getObject(arg0);
+    const ret = typeof(v) === 'boolean' ? (v ? 1 : 0) : 2;
+    return ret;
+};
+
 export function __wbindgen_is_string(arg0) {
     const ret = typeof(getObject(arg0)) === 'string';
     return ret;
@@ -550,12 +556,6 @@ export function __wbindgen_jsval_loose_eq(arg0, arg1) {
     return ret;
 };
 
-export function __wbindgen_boolean_get(arg0) {
-    const v = getObject(arg0);
-    const ret = typeof(v) === 'boolean' ? (v ? 1 : 0) : 2;
-    return ret;
-};
-
 export function __wbindgen_as_number(arg0) {
     const ret = +getObject(arg0);
     return ret;
@@ -618,14 +618,14 @@ export function __wbg_msCrypto_eb05e62b530a1508(arg0) {
     return addHeapObject(ret);
 };
 
-export function __wbg_randomFillSync_5c9c955aa56b6049() { return handleError(function (arg0, arg1) {
-    getObject(arg0).randomFillSync(takeObject(arg1));
-}, arguments) };
-
 export function __wbg_getRandomValues_3aa56aa6edec874c() { return handleError(function (arg0, arg1) {
     getObject(arg0).getRandomValues(getObject(arg1));
 }, arguments) };
 
+export function __wbg_randomFillSync_5c9c955aa56b6049() { return handleError(function (arg0, arg1) {
+    getObject(arg0).randomFillSync(takeObject(arg1));
+}, arguments) };
+
 export function __wbg_get_3baa728f9d58d3f6(arg0, arg1) {
     const ret = getObject(arg0)[arg1 >>> 0];
     return addHeapObject(ret);

package/package.json

@@ -7,7 +7,7 @@
     "Luke Seelenbinder <luke@stadiamaps.com>"
   ],
   "description": "The core of modern turn-by-turn navigation.",
-  "version": "0.17.0",
+  "version": "0.19.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",