@mapvx/web-js 1.0.0

package/dist/es/domain/models/route.d.ts

@@ -0,0 +1,199 @@
+import { type Position } from "geojson";
+import { type RouteLegResponse, type RoutePolylineResponse, type RouteResponse, type RouteStepResponse } from "../../interfaces/routeResponse";
+import { type LatLng } from "./latLng";
+/**
+ * Represents a complete route in MapVX that can contain multiple legs.
+ * Each route is composed of a series of legs that connect different points.
+ * @group Routes
+ */
+export declare class MVXRoute {
+    /**
+     * Unique identifier for the route generated automatically
+     */
+    id: string;
+    /**
+     * List of legs that compose the complete route
+     */
+    legs: MVXRouteLeg[];
+    /**
+     * Creates a new route instance from API response data
+     * @hidden
+     * @param data API response data containing route information
+     */
+    constructor(data: RouteResponse);
+    /**
+     * Gets all steps of the route by combining steps from all legs
+     * @returns Array with all route steps
+     */
+    get steps(): MVXRouteStep[];
+    /**
+     * Gets the total duration of the route.
+     * This property calculates the sum of the duration of all legs in the route.
+     *
+     * @returns {number} The total duration of the route, in seconds.
+     */
+    get duration(): number;
+    /**
+     * Gets the total length of the route.
+     * This property calculates the sum of the length of all legs in the route.
+     *
+     * @returns {number} The total length of the route, in meters.
+     */
+    get length(): number;
+}
+/**
+ * Represents a route leg that connects two specific points.
+ * Each leg contains information about distance, duration, and detailed steps.
+ * @group Routes
+ */
+export declare class MVXRouteLeg {
+    /**
+     * Total distance of the leg in meters
+     */
+    distance: number;
+    /**
+     * Estimated duration of the leg in seconds
+     */
+    duration: number;
+    /**
+     * Starting location of the leg
+     */
+    startLocation: LatLng;
+    /**
+     * Ending location of the leg
+     */
+    endLocation: LatLng;
+    /**
+     * List of detailed steps that compose this leg
+     */
+    steps: MVXRouteStep[];
+    /**
+     * Creates a new route leg instance from response data
+     * @hidden
+     * @param data API response data containing leg information
+     */
+    constructor(data: RouteLegResponse);
+}
+/**
+ * Represents an individual step within a route leg.
+ * Each step contains specific instructions and coordinates for navigation.
+ * @group Routes
+ */
+export declare class MVXRouteStep {
+    /**
+     * Distance of the step in meters
+     */
+    distance: number;
+    /**
+     * Estimated duration of the step in seconds
+     */
+    duration: number;
+    /**
+     * Starting location of the step
+     */
+    startLocation: LatLng;
+    /**
+     * Identifier of the floor where the step begins (if applicable)
+     */
+    startInsideFloor?: string;
+    /**
+     * Identifier of the place where the step begins (if applicable)
+     */
+    startInsidePlace?: string;
+    /**
+     * Ending location of the step
+     */
+    endLocation: LatLng;
+    /**
+     * Identifier of the floor where the step ends (if applicable)
+     */
+    endInsideFloor?: string;
+    /**
+     * Identifier of the place where the step ends (if applicable)
+     */
+    endInsidePlace?: string;
+    /**
+     * HTML formatted instructions to display to the user
+     */
+    htmlInstruction: string;
+    /**
+     * Plain text instructions to display to the user
+     */
+    plainInstruction: string;
+    /**
+     * Type of maneuver the user should perform (e.g., "turn-left", "straight")
+     */
+    maneuver: string;
+    /**
+     * Indicates if a popup with additional information should be shown
+     */
+    showPopup?: boolean;
+    /**
+     * Icon prefix to display for this step
+     */
+    iconPrefix?: string;
+    /**
+     * Indicates if this step involves using an elevator
+     */
+    elevatorStep: boolean;
+    /**
+     * Object containing the polyline information for the step
+     * @hidden
+     */
+    polyline: Polyline;
+    /**
+     * Creates a new route step instance from response data
+     * @hidden
+     * @param data API response data containing step information
+     */
+    constructor(data: RouteStepResponse);
+    /**
+     * Gets the polyline coordinates in GeoJSON format
+     * @returns Array of coordinates in [longitude, latitude] format
+     */
+    get geoJsonCoordinates(): Position[];
+    /**
+     * Gets the polyline coordinates in LatLng format
+     * @returns Array of LatLng coordinates
+     */
+    get coordinates(): LatLng[];
+}
+/**
+ * Internal class that handles polyline decoding and management.
+ * A polyline is an encoded representation of a series of coordinates.
+ */
+declare class Polyline {
+    /**
+     * Encoded string of polyline points
+     */
+    points: string;
+    /**
+     * Polyline points in LatLng format (optional)
+     */
+    pointsLatLng?: LatLng[];
+    /**
+     * Overview points of the polyline (optional)
+     */
+    overviewPoints?: LatLng[];
+    /**
+     * Decoded points of the polyline
+     */
+    private decodedPoints;
+    /**
+     * Creates a new polyline instance from response data
+     * @param data Response data containing polyline information
+     */
+    constructor(data: RoutePolylineResponse);
+    /**
+     * Gets coordinates in GeoJSON format
+     * @returns Array of coordinates in [longitude, latitude] format
+     */
+    get geoJsonCoordinates(): Position[];
+    /**
+     * Gets coordinates in LatLng format
+     * @returns Array of LatLng coordinates
+     */
+    get coordinates(): LatLng[];
+}
+export {};
+//# sourceMappingURL=route.d.ts.map

package/dist/es/domain/models/route.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"route.d.ts","sourceRoot":"","sources":["../../../../src/domain/models/route.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,SAAS,CAAA;AAEvC,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACvB,MAAM,gCAAgC,CAAA;AACvC,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAA;AAEtC;;;;GAIG;AACH,qBAAa,QAAQ;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,WAAW,EAAE,CAAA;IAEnB;;;;OAIG;gBACS,IAAI,EAAE,aAAa;IAS/B;;;OAGG;IACH,IAAI,KAAK,IAAI,YAAY,EAAE,CAE1B;IAED;;;;;OAKG;IACH,IAAI,QAAQ,IAAI,MAAM,CAIrB;IAED;;;;;OAKG;IACH,IAAI,MAAM,IAAI,MAAM,CAInB;CACF;AAED;;;;GAIG;AACH,qBAAa,WAAW;IACtB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,KAAK,EAAE,YAAY,EAAE,CAAA;IAErB;;;;OAIG;gBACS,IAAI,EAAE,gBAAgB;CAWnC;AAED;;;;GAIG;AACH,qBAAa,YAAY;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAA;IAErB;;;OAGG;IACH,QAAQ,EAAE,QAAQ,CAAA;IAElB;;;;OAIG;gBACS,IAAI,EAAE,iBAAiB;IAkBnC;;;OAGG;IACH,IAAI,kBAAkB,IAAI,QAAQ,EAAE,CAEnC;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,MAAM,EAAE,CAE1B;CACF;AAED;;;GAGG;AACH,cAAM,QAAQ;IACZ;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAA;IAEzB;;OAEG;IACH,OAAO,CAAC,aAAa,CAAU;IAE/B;;;OAGG;gBACS,IAAI,EAAE,qBAAqB;IASvC;;;OAGG;IACH,IAAI,kBAAkB,IAAI,QAAQ,EAAE,CAMnC;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,MAAM,EAAE,CAM1B;CACF"}

package/dist/es/domain/models/route.js

@@ -0,0 +1,160 @@
+import { decode } from "@googlemaps/polyline-codec";
+import { v4 as uuid } from "uuid";
+/**
+ * Represents a complete route in MapVX that can contain multiple legs.
+ * Each route is composed of a series of legs that connect different points.
+ * @group Routes
+ */
+export class MVXRoute {
+    /**
+     * Creates a new route instance from API response data
+     * @hidden
+     * @param data API response data containing route information
+     */
+    constructor(data) {
+        this.id = uuid();
+        this.legs = [];
+        data.legs.forEach((legData) => {
+            const leg = new MVXRouteLeg(legData);
+            this.legs.push(leg);
+        });
+    }
+    /**
+     * Gets all steps of the route by combining steps from all legs
+     * @returns Array with all route steps
+     */
+    get steps() {
+        return this.legs.flatMap((leg) => leg.steps);
+    }
+    /**
+     * Gets the total duration of the route.
+     * This property calculates the sum of the duration of all legs in the route.
+     *
+     * @returns {number} The total duration of the route, in seconds.
+     */
+    get duration() {
+        return this.legs
+            .map((leg) => leg.duration)
+            .reduce((accumulator, currentValue) => accumulator + currentValue, 0);
+    }
+    /**
+     * Gets the total length of the route.
+     * This property calculates the sum of the length of all legs in the route.
+     *
+     * @returns {number} The total length of the route, in meters.
+     */
+    get length() {
+        return this.legs
+            .map((leg) => leg.distance)
+            .reduce((accumulator, currentValue) => accumulator + currentValue, 0);
+    }
+}
+/**
+ * Represents a route leg that connects two specific points.
+ * Each leg contains information about distance, duration, and detailed steps.
+ * @group Routes
+ */
+export class MVXRouteLeg {
+    /**
+     * Creates a new route leg instance from response data
+     * @hidden
+     * @param data API response data containing leg information
+     */
+    constructor(data) {
+        this.distance = data.distance.value;
+        this.duration = data.duration.value;
+        this.startLocation = data.start_location;
+        this.endLocation = data.end_location;
+        this.steps = [];
+        data.steps.forEach((stepData) => {
+            const step = new MVXRouteStep(stepData);
+            this.steps.push(step);
+        });
+    }
+}
+/**
+ * Represents an individual step within a route leg.
+ * Each step contains specific instructions and coordinates for navigation.
+ * @group Routes
+ */
+export class MVXRouteStep {
+    /**
+     * Creates a new route step instance from response data
+     * @hidden
+     * @param data API response data containing step information
+     */
+    constructor(data) {
+        this.distance = data.distance.value;
+        this.duration = data.duration.value;
+        this.startLocation = data.start_location;
+        this.startInsideFloor = data.start_inside_floor;
+        this.startInsidePlace = data.start_inside_place;
+        this.endLocation = data.end_location;
+        this.endInsideFloor = data.end_inside_floor;
+        this.endInsidePlace = data.end_inside_place;
+        this.htmlInstruction = data.html_instructions;
+        this.plainInstruction = data.plain_instructions;
+        this.maneuver = data.maneuver;
+        this.elevatorStep = data.elevator_step;
+        this.showPopup = data.show_popup;
+        this.iconPrefix = data.icon_prefix;
+        this.polyline = new Polyline(data.polyline);
+    }
+    /**
+     * Gets the polyline coordinates in GeoJSON format
+     * @returns Array of coordinates in [longitude, latitude] format
+     */
+    get geoJsonCoordinates() {
+        return this.polyline.geoJsonCoordinates;
+    }
+    /**
+     * Gets the polyline coordinates in LatLng format
+     * @returns Array of LatLng coordinates
+     */
+    get coordinates() {
+        return this.polyline.coordinates;
+    }
+}
+/**
+ * Internal class that handles polyline decoding and management.
+ * A polyline is an encoded representation of a series of coordinates.
+ */
+class Polyline {
+    /**
+     * Creates a new polyline instance from response data
+     * @param data Response data containing polyline information
+     */
+    constructor(data) {
+        this.points = data.points;
+        this.pointsLatLng = data.points_lat_lng;
+        this.overviewPoints = data.overview_points;
+        this.decodedPoints = decode(data.points).map((point) => {
+            return { lat: point[0], lng: point[1] };
+        });
+    }
+    /**
+     * Gets coordinates in GeoJSON format
+     * @returns Array of coordinates in [longitude, latitude] format
+     */
+    get geoJsonCoordinates() {
+        if (this.overviewPoints != null) {
+            return this.overviewPoints.map((point) => [point.lng, point.lat]);
+        }
+        else {
+            return this.decodedPoints.map((point) => [point.lng, point.lat]);
+        }
+    }
+    /**
+     * Gets coordinates in LatLng format
+     * @returns Array of LatLng coordinates
+     */
+    get coordinates() {
+        if (this.overviewPoints != null) {
+            return this.overviewPoints;
+        }
+        else {
+            return this.decodedPoints;
+        }
+    }
+}
+//# sourceMappingURL=route.js.map

package/dist/es/domain/models/route.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"route.js","sourceRoot":"","sources":["../../../../src/domain/models/route.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAEnD,OAAO,EAAE,EAAE,IAAI,IAAI,EAAE,MAAM,MAAM,CAAA;AASjC;;;;GAIG;AACH,MAAM,OAAO,QAAQ;IAWnB;;;;OAIG;IACH,YAAY,IAAmB;QAC7B,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,CAAA;QAChB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;QACd,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC5B,MAAM,GAAG,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAA;YACpC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACrB,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IAC9C,CAAC;IAED;;;;;OAKG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,IAAI;aACb,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC;aAC1B,MAAM,CAAC,CAAC,WAAW,EAAE,YAAY,EAAE,EAAE,CAAC,WAAW,GAAG,YAAY,EAAE,CAAC,CAAC,CAAA;IACzE,CAAC;IAED;;;;;OAKG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,IAAI;aACb,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC;aAC1B,MAAM,CAAC,CAAC,WAAW,EAAE,YAAY,EAAE,EAAE,CAAC,WAAW,GAAG,YAAY,EAAE,CAAC,CAAC,CAAA;IACzE,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,WAAW;IA0BtB;;;;OAIG;IACH,YAAY,IAAsB;QAChC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAA;QACnC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAA;QACnC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,cAAc,CAAA;QACxC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAA;QACpC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;QACf,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC9B,MAAM,IAAI,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,CAAA;YACvC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,YAAY;IA6EvB;;;;OAIG;IACH,YAAY,IAAuB;QACjC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAA;QACnC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAA;QACnC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,cAAc,CAAA;QACxC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAA;QAC/C,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAA;QAC/C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAA;QACpC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAA;QAC3C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAA;QAC3C,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAA;QAC7C,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAA;QAC/C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;QAC7B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,aAAa,CAAA;QACtC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,UAAU,CAAA;QAChC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,WAAW,CAAA;QAClC,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC7C,CAAC;IAED;;;OAGG;IACH,IAAI,kBAAkB;QACpB,OAAO,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAA;IACzC,CAAC;IAED;;;OAGG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAA;IAClC,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,QAAQ;IAqBZ;;;OAGG;IACH,YAAY,IAA2B;QACrC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;QACzB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,CAAA;QACvC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,eAAe,CAAA;QAC1C,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACrD,OAAO,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;QACzC,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;OAGG;IACH,IAAI,kBAAkB;QACpB,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,EAAE;YAC/B,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;SAClE;aAAM;YACL,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;SACjE;IACH,CAAC;IAED;;;OAGG;IACH,IAAI,WAAW;QACb,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,EAAE;YAC/B,OAAO,IAAI,CAAC,cAAc,CAAA;SAC3B;aAAM;YACL,OAAO,IAAI,CAAC,aAAa,CAAA;SAC1B;IACH,CAAC;CACF"}

package/dist/es/domain/models/routeConfiguration.d.ts

@@ -0,0 +1,140 @@
+import type { MVXLocation } from "./location";
+import type { RouteStyle } from "./routeStyle";
+/**
+ * Represents the announce format for the route.
+ * @group Routes
+ */
+export declare enum AnnounceFormat {
+    cardinal = "CARDINAL",
+    clock = "CLOCK",
+    relative = "RELATIVE"
+}
+/**
+ * Represents the unit system for the route.
+ * @group Routes
+ */
+export declare enum UnitSystem {
+    metric = "METRIC",
+    imperial = "IMPERIAL",
+    steps = "STEPS"
+}
+/**
+ * Represents the transportation mode for the route.
+ * @group Routes
+ */
+export declare enum TransportationMode {
+    walking = "WALKING",
+    driving = "DRIVING",
+    bicycling = "BICYCLING",
+    transit = "TRANSIT"
+}
+/**
+ * The parameters to get a route.
+ * @group Routes
+ */
+export interface GetRouteConfiguration {
+    /**
+     * The initial location for the route.
+     */
+    initialLocation: RouteLocation;
+    /**
+     * The final location for the route.
+     */
+    finalLocation: RouteLocation;
+    /**
+     * The option to generate a route (if available) for people with mobility disabilities.
+     * @defaultValue `false`.
+     */
+    preferAccessibleRoute?: boolean;
+    /**
+     * The language for the instructions.
+     * Default to `en`.
+     */
+    language?: string;
+    /**
+     * The unit system used for the distance.
+     * Default to `METRIC`.
+     */
+    unitSystem?: UnitSystem;
+    /**
+     * The format used to announce directions in the instructions.
+     * Default to `RELATIVE`.
+     */
+    announceFormat?: AnnounceFormat;
+}
+/**
+ * Class representing the configuration of a route.
+ * @hidden
+ */
+export declare class InternalGetRouteConfiguration implements GetRouteConfiguration {
+    initialLocation: RouteLocation;
+    finalLocation: RouteLocation;
+    preferAccessibleRoute: boolean;
+    language: string;
+    unitSystem: UnitSystem;
+    announceFormat: AnnounceFormat;
+    /**
+     * Create a new route configuration.
+     * @param initialLocation The initial location for the route.
+     * @param finalLocation The final location for the route.
+     * @param preferAccessibleRoute The option to generate a route (if available) for people with mobility disabilities.
+     * @param language The language for the instructions.
+     * @param unitSystem The unit system used for the distance.
+     * @param announceFormat The format used to announce directions in the instructions.
+     */
+    constructor(config: GetRouteConfiguration);
+}
+/**
+ * Parameters to configure how to draw the route on the map.
+ * @group Routes
+ */
+export interface DrawRouteConfiguration {
+    /**
+     * The width in pixels of the route line on the map.
+     * @defaultValue `10`
+     */
+    polylineWidth?: number;
+    /**
+     * The style for the steps ahead of the user.
+     * If omitted, default to `{ type: "Solid", color: "#1257ED",  }`.
+     * @defaultValue `{ type: "Solid", color: "#1257ED" }`
+     */
+    routeStyle?: RouteStyle;
+}
+/**
+ * Internal class for the configuration to draw the route on a map.
+ * @hidden
+ */
+export declare class InternalDrawRouteConfiguration implements DrawRouteConfiguration {
+    polylineWidth: number;
+    routeStyle: RouteStyle;
+    /**
+     * Create a new configuration to draw a route in the map.
+     * @param polylineWidth The width of the route line in the map. If omitted, default to `10`.
+     * @param routeStyle The style for the steps on the route. If omitted, default to `{ color: "#33B5E5" }`.
+     */
+    constructor(config: DrawRouteConfiguration);
+}
+/**
+ * Interface that represent a place with their id.
+ * @group Routes
+ */
+export interface IdLocation {
+    /**
+     * The ID of the place.
+     */
+    id: string;
+    /**
+     * The level of the floor in the parent place where the place is found.
+     * This is only necessary if the place represented by the ID exists on multiple floors.
+     * If omitted and the place ID represents a place found on multiple floors,
+     * the first floor where this place is present will be used.
+     */
+    level?: number;
+}
+/**
+ * Type that represent a location to be used in the generation of a route.
+ * @group Routes
+ */
+export type RouteLocation = IdLocation | MVXLocation;
+//# sourceMappingURL=routeConfiguration.d.ts.map

package/dist/es/domain/models/routeConfiguration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routeConfiguration.d.ts","sourceRoot":"","sources":["../../../../src/domain/models/routeConfiguration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAC7C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAE9C;;;GAGG;AACH,oBAAY,cAAc;IACxB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,QAAQ,aAAa;CACtB;AAED;;;GAGG;AACH,oBAAY,UAAU;IACpB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,KAAK,UAAU;CAChB;AAED;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,OAAO,YAAY;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,eAAe,EAAE,aAAa,CAAA;IAE9B;;OAEG;IACH,aAAa,EAAE,aAAa,CAAA;IAE5B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAE/B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;OAGG;IACH,UAAU,CAAC,EAAE,UAAU,CAAA;IAEvB;;;OAGG;IACH,cAAc,CAAC,EAAE,cAAc,CAAA;CAChC;AACD;;;GAGG;AACH,qBAAa,6BAA8B,YAAW,qBAAqB;IACzE,eAAe,EAAE,aAAa,CAAA;IAC9B,aAAa,EAAE,aAAa,CAAA;IAC5B,qBAAqB,EAAE,OAAO,CAAA;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,UAAU,CAAA;IACtB,cAAc,EAAE,cAAc,CAAA;IAE9B;;;;;;;;OAQG;gBACS,MAAM,EAAE,qBAAqB;CAQ1C;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,UAAU,CAAA;CACxB;AAED;;;GAGG;AACH,qBAAa,8BAA+B,YAAW,sBAAsB;IAC3E,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,UAAU,CAAA;IACtB;;;;OAIG;gBACS,MAAM,EAAE,sBAAsB;CAO3C;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,WAAW,CAAA"}

package/dist/es/domain/models/routeConfiguration.js

@@ -0,0 +1,75 @@
+/**
+ * Represents the announce format for the route.
+ * @group Routes
+ */
+export var AnnounceFormat;
+(function (AnnounceFormat) {
+    AnnounceFormat["cardinal"] = "CARDINAL";
+    AnnounceFormat["clock"] = "CLOCK";
+    AnnounceFormat["relative"] = "RELATIVE";
+})(AnnounceFormat || (AnnounceFormat = {}));
+/**
+ * Represents the unit system for the route.
+ * @group Routes
+ */
+export var UnitSystem;
+(function (UnitSystem) {
+    UnitSystem["metric"] = "METRIC";
+    UnitSystem["imperial"] = "IMPERIAL";
+    UnitSystem["steps"] = "STEPS";
+})(UnitSystem || (UnitSystem = {}));
+/**
+ * Represents the transportation mode for the route.
+ * @group Routes
+ */
+export var TransportationMode;
+(function (TransportationMode) {
+    TransportationMode["walking"] = "WALKING";
+    TransportationMode["driving"] = "DRIVING";
+    TransportationMode["bicycling"] = "BICYCLING";
+    TransportationMode["transit"] = "TRANSIT";
+})(TransportationMode || (TransportationMode = {}));
+/**
+ * Class representing the configuration of a route.
+ * @hidden
+ */
+export class InternalGetRouteConfiguration {
+    /**
+     * Create a new route configuration.
+     * @param initialLocation The initial location for the route.
+     * @param finalLocation The final location for the route.
+     * @param preferAccessibleRoute The option to generate a route (if available) for people with mobility disabilities.
+     * @param language The language for the instructions.
+     * @param unitSystem The unit system used for the distance.
+     * @param announceFormat The format used to announce directions in the instructions.
+     */
+    constructor(config) {
+        var _a, _b, _c, _d;
+        this.initialLocation = config.initialLocation;
+        this.finalLocation = config.finalLocation;
+        this.preferAccessibleRoute = (_a = config.preferAccessibleRoute) !== null && _a !== void 0 ? _a : false;
+        this.language = (_b = config.language) !== null && _b !== void 0 ? _b : "en";
+        this.unitSystem = (_c = config.unitSystem) !== null && _c !== void 0 ? _c : UnitSystem.metric;
+        this.announceFormat = (_d = config.announceFormat) !== null && _d !== void 0 ? _d : AnnounceFormat.relative;
+    }
+}
+/**
+ * Internal class for the configuration to draw the route on a map.
+ * @hidden
+ */
+export class InternalDrawRouteConfiguration {
+    /**
+     * Create a new configuration to draw a route in the map.
+     * @param polylineWidth The width of the route line in the map. If omitted, default to `10`.
+     * @param routeStyle The style for the steps on the route. If omitted, default to `{ color: "#33B5E5" }`.
+     */
+    constructor(config) {
+        var _a, _b;
+        this.polylineWidth = (_a = config.polylineWidth) !== null && _a !== void 0 ? _a : 10;
+        this.routeStyle = (_b = config.routeStyle) !== null && _b !== void 0 ? _b : {
+            type: "Solid",
+            color: "#1257ED",
+        };
+    }
+}
+//# sourceMappingURL=routeConfiguration.js.map

package/dist/es/domain/models/routeConfiguration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"routeConfiguration.js","sourceRoot":"","sources":["../../../../src/domain/models/routeConfiguration.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,MAAM,CAAN,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,uCAAqB,CAAA;IACrB,iCAAe,CAAA;IACf,uCAAqB,CAAA;AACvB,CAAC,EAJW,cAAc,KAAd,cAAc,QAIzB;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,UAIX;AAJD,WAAY,UAAU;IACpB,+BAAiB,CAAA;IACjB,mCAAqB,CAAA;IACrB,6BAAe,CAAA;AACjB,CAAC,EAJW,UAAU,KAAV,UAAU,QAIrB;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,yCAAmB,CAAA;IACnB,6CAAuB,CAAA;IACvB,yCAAmB,CAAA;AACrB,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AAyCD;;;GAGG;AACH,MAAM,OAAO,6BAA6B;IAQxC;;;;;;;;OAQG;IACH,YAAY,MAA6B;;QACvC,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAA;QAC7C,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAA;QACzC,IAAI,CAAC,qBAAqB,GAAG,MAAA,MAAM,CAAC,qBAAqB,mCAAI,KAAK,CAAA;QAClE,IAAI,CAAC,QAAQ,GAAG,MAAA,MAAM,CAAC,QAAQ,mCAAI,IAAI,CAAA;QACvC,IAAI,CAAC,UAAU,GAAG,MAAA,MAAM,CAAC,UAAU,mCAAI,UAAU,CAAC,MAAM,CAAA;QACxD,IAAI,CAAC,cAAc,GAAG,MAAA,MAAM,CAAC,cAAc,mCAAI,cAAc,CAAC,QAAQ,CAAA;IACxE,CAAC;CACF;AAqBD;;;GAGG;AACH,MAAM,OAAO,8BAA8B;IAGzC;;;;OAIG;IACH,YAAY,MAA8B;;QACxC,IAAI,CAAC,aAAa,GAAG,MAAA,MAAM,CAAC,aAAa,mCAAI,EAAE,CAAA;QAC/C,IAAI,CAAC,UAAU,GAAG,MAAA,MAAM,CAAC,UAAU,mCAAI;YACrC,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,SAAS;SACjB,CAAA;IACH,CAAC;CACF"}

package/dist/es/domain/models/routeInstance.d.ts

@@ -0,0 +1,52 @@
+import { type Feature, type FeatureCollection, type LineString } from "geojson";
+import { type InternalAnimationConfig } from "./animation";
+import { type MarkerAttribute } from "./marker";
+import { type MVXRoute } from "./route";
+/**
+ * Represents the conditions for the step animation.
+ * @group Routes
+ */
+export interface StepAnimationConditions {
+    index: number;
+    coordinatesIndex: number;
+    iconRotation: number;
+    rotatingIcon: boolean;
+    startTime: number | undefined;
+    progress: number;
+    resetTime: boolean;
+    waitStartTime: number | undefined;
+    animationId: number;
+    onFinish?: (timestamp: number) => void;
+    isStepByStep?: boolean;
+    nextFloorFirstStepIndex?: number;
+}
+/**
+ * Represents a single route instance on the map with its own
+ * MapLibre sources/layers, GeoJSON data, animation state, and marker.
+ * @group Routes
+ */
+export interface RouteInstance {
+    readonly id: string;
+    route: MVXRoute;
+    readonly aheadId: string;
+    readonly behindId: string;
+    readonly currentId: string;
+    aheadSourceData: FeatureCollection;
+    behindSourceData: FeatureCollection;
+    currentSourceData: Feature<LineString>;
+    animationStatus: "STARTED" | "PAUSED" | "FINISHED" | "NO_ROUTE";
+    stepAnimationStatus: "NO_ROUTE" | "ANIMATING" | "WAITING";
+    conditions?: StepAnimationConditions;
+    animationConfig?: InternalAnimationConfig;
+    routeMarker?: MarkerAttribute;
+    currentPlaceId?: string;
+}
+/**
+ * Creates a new RouteInstance from a route.
+ * Each instance gets unique MapLibre source/layer IDs based on the route's UUID.
+ * @param route The route to create an instance for.
+ * @returns A new RouteInstance with initialized GeoJSON data structures.
+ * @group Routes
+ */
+export declare function createRouteInstance(route: MVXRoute): RouteInstance;
+//# sourceMappingURL=routeInstance.d.ts.map

package/dist/es/domain/models/routeInstance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routeInstance.d.ts","sourceRoot":"","sources":["../../../../src/domain/models/routeInstance.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,iBAAiB,EAAE,KAAK,UAAU,EAAE,MAAM,SAAS,CAAA;AAC/E,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,aAAa,CAAA;AAC1D,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,UAAU,CAAA;AAC/C,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,SAAS,CAAA;AAEvC;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,MAAM,CAAA;IACb,gBAAgB,EAAE,MAAM,CAAA;IACxB,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,OAAO,CAAA;IACrB,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,OAAO,CAAA;IAClB,aAAa,EAAE,MAAM,GAAG,SAAS,CAAA;IACjC,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAA;IACtC,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,uBAAuB,CAAC,EAAE,MAAM,CAAA;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,QAAQ,CAAA;IACf,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,eAAe,EAAE,iBAAiB,CAAA;IAClC,gBAAgB,EAAE,iBAAiB,CAAA;IACnC,iBAAiB,EAAE,OAAO,CAAC,UAAU,CAAC,CAAA;IACtC,eAAe,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAA;IAC/D,mBAAmB,EAAE,UAAU,GAAG,WAAW,GAAG,SAAS,CAAA;IACzD,UAAU,CAAC,EAAE,uBAAuB,CAAA;IACpC,eAAe,CAAC,EAAE,uBAAuB,CAAA;IACzC,WAAW,CAAC,EAAE,eAAe,CAAA;IAC7B,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,QAAQ,GAAG,aAAa,CAiBlE"}

package/dist/es/domain/models/routeInstance.js

@@ -0,0 +1,26 @@
+/**
+ * Creates a new RouteInstance from a route.
+ * Each instance gets unique MapLibre source/layer IDs based on the route's UUID.
+ * @param route The route to create an instance for.
+ * @returns A new RouteInstance with initialized GeoJSON data structures.
+ * @group Routes
+ */
+export function createRouteInstance(route) {
+    return {
+        id: route.id,
+        route,
+        aheadId: `AHEAD_${route.id}`,
+        behindId: `BEHIND_${route.id}`,
+        currentId: `CURRENT_${route.id}`,
+        aheadSourceData: { type: "FeatureCollection", features: [] },
+        behindSourceData: { type: "FeatureCollection", features: [] },
+        currentSourceData: {
+            type: "Feature",
+            properties: {},
+            geometry: { type: "LineString", coordinates: [] },
+        },
+        animationStatus: "NO_ROUTE",
+        stepAnimationStatus: "NO_ROUTE",
+    };
+}
+//# sourceMappingURL=routeInstance.js.map