@igo2/geo 18.0.0-next.10 → 18.0.0-next.11

package/lib/directions/shared/directions.service.d.ts

@@ -7,8 +7,7 @@ import 'jspdf-autotable';
 import { Observable } from 'rxjs';
 import { IgoMap } from '../../map/shared/map';
 import { PrintService } from '../../print/shared/print.service';
-import { DirectionsSource } from '../directions-sources/directions-source';
-import { Direction, DirectionOptions } from '../shared/directions.interface';
+import { DirectionOptions, Directions } from '../shared/directions.interface';
 import { DirectionsSourceService } from './directions-source.service';
 import * as i0 from "@angular/core";
 export declare class DirectionsService {
@@ -19,13 +18,52 @@ export declare class DirectionsService {
     private document;
     private activityService;
     constructor(directionsSourceService: DirectionsSourceService, configService: ConfigService, languageService: LanguageService, printService: PrintService, document: Document, activityService: ActivityService);
-    route(coordinates: Position[], directionsOptions?: DirectionOptions): Observable<Direction[]>;
-    routeSource(source: DirectionsSource, coordinates: Position[], directionsOptions?: DirectionOptions): Observable<Direction[]>;
-    downloadDirection(map: IgoMap, direction: Direction): Observable<SubjectStatus>;
-    private addAttribution;
-    private setHTMLTableContent;
-    private directionsInstruction;
+    /**
+     * Routes the given coordinates using the specified directions source and options.
+     *
+     * @param {DirectionsSource} source - The directions source to use for routing.
+     * @param {Position[]} coordinates - The array of coordinates to route.
+     * @param {DirectionOptions} [directionsOptions={}] - The optional direction options.
+     * @return {Observable<Directions[]>} An observable that emits an array of directions.
+     */
+    route(coordinates: Position[], directionsOptions?: DirectionOptions): Observable<Directions[]>;
+    /**
+     * Downloads directions for a given map and directions object.
+     *
+     * @param {IgoMap} map - The map object to download directions for.
+     * @param {Directions} directions - The directions object containing the route information.
+     * @return {Observable<SubjectStatus>} An observable that emits the status of the download process.
+     */
+    downloadDirections(map: IgoMap, directions: Directions): Observable<SubjectStatus>;
+    /**
+     * Generates an HTML table element with directions steps.
+     *
+     * @param {Directions} directions - The directions object containing the steps.
+     * @return {Promise<HTMLTableElement>} - A promise that resolves to the generated HTML table element.
+     */
+    private setHTMLTableDirections;
+    /**
+     * Generates formatted steps for the given directions.
+     *
+     * @param {Directions} directions - The directions object containing the steps.
+     * @return {Promise<{ instruction: string; icon: string; distanceDuration: string }[]>}
+     * A promise that resolves to an array of formatted steps.
+     */
+    private directionsSteps;
+    /**
+     * Adds instructions to the given jsPDF document.
+     *
+     * @param {jsPDF} doc - The jsPDF document to add instructions to.
+     * @param {Directions} directions - The directions object containing the instructions.
+     * @param {string} title - The title of the instructions.
+     * @return {Promise<void>} A promise that resolves when the instructions are added to the document.
+     */
     private addInstructions;
+    /**
+     * Sets the header and footer of each page in the given jsPDF document.
+     *
+     * @param {jsPDF} doc - The jsPDF document to modify.
+     */
     private setPageHeaderFooter;
     static ɵfac: i0.ɵɵFactoryDeclaration<DirectionsService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<DirectionsService>;

package/lib/directions/shared/directions.utils.d.ts

@@ -2,41 +2,120 @@ import { LanguageService } from '@igo2/core/language';
 import olFeature from 'ol/Feature';
 import type { default as OlGeometry } from 'ol/geom/Geometry';
 import * as olStyle from 'ol/style';
-import { DirectionRelativePositionType } from './directions.enum';
-import { Direction, Stop } from './directions.interface';
-import { RoutesFeatureStore, StepFeatureStore, StopsFeatureStore, StopsStore } from './store';
+import { DirectionRelativePositionType, ManeuverModifier } from './directions.enum';
+import { Directions, IgoStep, Stop } from './directions.interface';
+import { RoutesFeatureStore, StepsFeatureStore, StopsFeatureStore, StopsStore } from './store';
 /**
- * Function that updat the sort of the list base on the provided field.
- * @param source stop store
- * @param direction asc / desc sort order
- * @param field the field to use to sort the view
+ * Updates the sorting of the stops in the provided StopsStore based on the specified field and direction.
+ *
+ * @param {StopsStore} stopsStore - The StopsStore to update the sorting for.
+ * @param {'asc' | 'desc'} [direction='asc'] - The direction of sorting ('asc' for ascending, 'desc' for descending).
+ * @param {string} [field='position'] - The field to sort the stops by.
  */
 export declare function updateStoreSorting(stopsStore: StopsStore, direction?: 'asc' | 'desc', field?: string): void;
-export declare function computeRelativePosition(index: number, totalLength: any): DirectionRelativePositionType;
-export declare function computeStopsPosition(stopsStore: StopsStore): void;
 /**
- * Function that add a stop to the stop store. Stop are always added before the last stop.
- * @param stopsStore stop store as an EntityStore
+ * Computes the relative position of a stop in a list of stops.
+ *
+ * @param {number} stopIndex - The index of the stop.
+ * @param {number} stopListLength - The total number of stops.
+ * @return {DirectionRelativePositionType} The relative position of the stop.
+ */
+export declare function computeRelativePosition(stopIndex: number, stopListLength: number): DirectionRelativePositionType;
+/**
+ * Computes the position and relative position of stops in the given stopsStore.
+ *
+ * @param {StopsStore} stopsStore - The store containing the stops.
+ */
+export declare function computeStopsPosition(deletedStopIndex: number, stopsStore: StopsStore): void;
+/**
+ * Adds a stop to the given stopsStore. The stop is always added as the last stop.
+ *
+ * @param {StopsStore} stopsStore - The store containing the stops.
+ * @return {Stop} The newly added stop.
  */
 export declare function addStopToStore(stopsStore: StopsStore): Stop;
+/**
+ * Removes a stop from the given stopsStore and updates the positions of the remaining stops.
+ *
+ * @param {StopsStore} stopsStore - The store containing the stops.
+ * @param {Stop} stop - The stop to be removed.
+ */
 export declare function removeStopFromStore(stopsStore: StopsStore, stop: Stop): void;
 /**
- * Create a style for the directions stops and routes
+ * Create a style for the directions steps, stops and route
  * @param feature OlFeature
  * @returns OL style function
  */
 export declare function directionsStyle(feature: olFeature<OlGeometry>): olStyle.Style | olStyle.Style[];
+/**
+ * Initializes the stops feature store with the provided language service.
+ *
+ * @param {StopsFeatureStore} stopsFeatureStore - The stops feature store to initialize.
+ * @param {LanguageService} languageService - The language service used for translations.
+ */
 export declare function initStopsFeatureStore(stopsFeatureStore: StopsFeatureStore, languageService: LanguageService): void;
+/**
+ * Initializes the routes feature store with the provided language service.
+ *
+ * @param {StopsFeatureStore} routesFeatureStore - The routes feature store to initialize.
+ * @param {LanguageService} languageService - The language service used for translations.
+ */
 export declare function initRoutesFeatureStore(routesFeatureStore: RoutesFeatureStore, languageService: LanguageService): void;
-export declare function initStepFeatureStore(stepFeatureStore: StepFeatureStore): void;
-export declare function addStopToStopsFeatureStore(stop: Stop, stopsStore: StopsStore, stopsFeatureStore: StopsFeatureStore, projection: string, languageService: LanguageService): void;
-export declare function addDirectionToRoutesFeatureStore(routesFeatureStore: RoutesFeatureStore, direction: Direction, projection: string, active?: boolean): void;
-export declare function formatDistance(distance: number): string;
-export declare function formatDuration(duration: number): string;
-export declare function formatInstruction(type: any, modifier: any, route: string, direction: any, stepPosition: any, exit: any, languageService: LanguageService, lastStep?: boolean): {
-    instruction: any;
-    image: string;
-    cssClass: string;
+/**
+ * Initializes the routes feature store.
+ *
+ * @param {StopsFeatureStore} stepsFeatureStore - The steps feature store to initialize.
+ */
+export declare function initStepsFeatureStore(stepsFeatureStore: StepsFeatureStore): void;
+/**
+ * Adds a stop to the stopsFeatureStore.
+ *
+ * @param {Stop} stop - The stop to be added.
+ * @param {StopsFeatureStore} stopsFeatureStore - The stopsFeatureStore to add the stop to.
+ * @param {string} projection - The projection of the stop coordinates.
+ * @param {LanguageService} languageService - The language service for translating stop text.
+ */
+export declare function addStopToStopsFeatureStore(stop: Stop, stopsFeatureStore: StopsFeatureStore, projection: string, languageService: LanguageService): void;
+/**
+ * Adds a route to the routes feature store.
+ *
+ * @param {RoutesFeatureStore} routesFeatureStore - The routes feature store to add the route to.
+ * @param {Directions} directions - The directions object containing the geometry and other information.
+ * @param {string} projection - The projection of the geometry coordinates.
+ * @param {boolean} [active=false] - Indicates whether the direction is active or not. Default is false.
+ */
+export declare function addRouteToRoutesFeatureStore(routesFeatureStore: RoutesFeatureStore, directions: Directions, projection: string, active?: boolean): void;
+/**
+ * Formats the given distance in meters to a human-readable string.
+ *
+ * @param {number} meters - The distance in meters to be formatted.
+ * @return {string | undefined} The formatted distance string.
+ */
+export declare function formatDistance(meters: number): string;
+/**
+ * Formats the given duration in seconds to a human-readable string.
+ *
+ * @param {number} seconds - The duration in seconds to be formatted.
+ * @return {string} The formatted duration string.
+ */
+export declare function formatDuration(seconds: number): string;
+export declare function formatStep(step: IgoStep, languageService: LanguageService, lastStep?: boolean): {
+    instruction: string;
+    iconName: string;
 };
-export declare function translateModifier(modifier: any, languageService: LanguageService): any;
-export declare function translateBearing(bearing: number, languageService: LanguageService): any;
+/**
+ * Translates a maneuver modifier into a human-readable string using the provided language service.
+ *
+ * @param {ManeuverModifier} maneuverModifier - The maneuver modifier to be translated.
+ * @param {LanguageService} languageService - The language service used for translation.
+ * @return {string | undefined} The translated maneuver modifier string, or undefined if the modifier is falsy.
+ */
+export declare function translateManeuverModifier(maneuverModifier: ManeuverModifier, languageService: LanguageService): string;
+/**
+ * Translates the given bearing value into a human-readable direction using the provided language service.
+ *
+ * @param {number} bearing - The bearing value to be translated.
+ * @param {LanguageService} languageService - The language service used for translation.
+ * @return {string} The translated direction corresponding to the given bearing value.
+ */
+export declare function translateManeuverBearing(bearing: number, languageService: LanguageService): string;

package/lib/directions/shared/store.d.ts

@@ -1,7 +1,7 @@
 import { EntityStore } from '@igo2/common/entity';
 import { BehaviorSubject } from 'rxjs';
 import { FeatureStore } from '../../feature/shared/store';
-import { FeatureWithDirection, FeatureWithStep, FeatureWithStop, Stop } from './directions.interface';
+import { FeatureWithDirections, FeatureWithStep, FeatureWithStop, Stop } from './directions.interface';
 /**
  * The class is a specialized version of an EntityStore that stores
  * stops.
@@ -12,7 +12,7 @@ export declare class StopsStore extends EntityStore<Stop> {
 }
 export declare class StopsFeatureStore extends FeatureStore<FeatureWithStop> {
 }
-export declare class RoutesFeatureStore extends FeatureStore<FeatureWithDirection> {
+export declare class RoutesFeatureStore extends FeatureStore<FeatureWithDirections> {
 }
-export declare class StepFeatureStore extends FeatureStore<FeatureWithStep> {
+export declare class StepsFeatureStore extends FeatureStore<FeatureWithStep> {
 }

package/lib/draw/shared/draw.utils.d.ts

@@ -1,4 +1,5 @@
 import OlOverlay from 'ol/Overlay';
+import { Coordinate } from 'ol/coordinate';
 import OlCircle from 'ol/geom/Circle';
 import OlLineString from 'ol/geom/LineString';
 import OlPoint from 'ol/geom/Point';
@@ -32,4 +33,4 @@ export declare function updateOlTooltipDrawAtCenter(olGeometry: OlLineString | O
  * @returns OL overlay
  */
 export declare function createOlTooltipDrawAtPoint(olPoint: OlPoint): OlOverlay;
-export declare function DDtoDMS(value: [number, number], unit: CoordinatesUnit): string[] | undefined;
+export declare function DDtoDMS(value: Coordinate, unit: CoordinatesUnit): string[] | undefined;

package/lib/map/shared/controllers/geolocation.interface.d.ts

@@ -1,3 +1,4 @@
+import { Coordinate } from 'ol/coordinate';
 import { ProjectionLike } from 'ol/proj';
 export interface GeolocationOptions {
     activateDefault?: boolean;
@@ -14,7 +15,7 @@ export interface MapGeolocationControllerOptions {
     buffer?: GeolocationBuffer;
 }
 export interface MapGeolocationState {
-    position: number[];
+    position: Coordinate;
     projection: string;
     accuracy: number;
     altitude: number;

package/lib/map/shared/map.utils.d.ts

@@ -1,4 +1,6 @@
 import MapBrowserPointerEvent from 'ol/MapBrowserEvent';
+import { Coordinate } from 'ol/coordinate';
+import { Position } from 'geojson';
 import { MapViewState } from './map.interface';
 import { Projection } from './projection.interfaces';
 /**
@@ -26,7 +28,7 @@ export declare function stringToLonLat(str: string, mapProjection: string, opts?
  * @param decimal number of decimals for seconds
  * @returns longitude and latitude in dms
  */
-export declare function convertDDToDMS(lonLatDD: [number, number], decimal?: number): string[];
+export declare function convertDDToDMS(lonLatDD: Coordinate, decimal?: number): string[];
 /**
  * Return true of two view states are equal.
  * @param state1 View state
@@ -59,8 +61,8 @@ export declare function getScaleFromResolution(resolution: number, unit?: string
  * @returns Whether the CTRL key is pushed
  */
 export declare function ctrlKeyDown(event: MapBrowserPointerEvent<any>): boolean;
-export declare function roundCoordTo(coord: [number, number], decimal?: number): [number, number];
-export declare function roundCoordToString(coord: [number, number], decimal?: number): [string, string];
+export declare function roundCoordTo(coord: [number, number] | Position | Coordinate, decimal?: number): Coordinate;
+export declare function roundCoordToString(coord: [number, number] | Position | Coordinate, decimal?: number): [string, string];
 /**
  * Returns an array of converted coordinates.
  * Conversion is done for every configured projections

package/locale/en.geo.json

@@ -373,102 +373,100 @@
         },
         "showNorthArrow": "Show north arrow"
       },
-      "directionsForm": {
-        "stopLayer": "Directions - stops",
-        "routeLayer": "Directions - route",
-        "start": "Start",
-        "intermediate": "Intermediate",
-        "end": "End",
-        "directionsBtn": "Get route",
-        "resetDirectionsBtn": "Reset",
-        "zoomRoute": "Zoom on route",
-        "null": "",
+      "directions": {
+        "buttons": {
+          "copyDirections": "Copy directions to clipboard",
+          "copyLink": "Copy link to clipboard",
+          "downloadDirections": "Download directions",
+          "message": {
+            "copyDirections": "Directions copied to clipboard",
+            "copyLink": "Link copied to clipboard"
+          },
+          "resetStops": "Reset stops",
+          "zoomOnRoute": "Zoom on route"
+        },
         "directions": "Directions",
-        "raiseStop": "Raise stop's priority",
-        "lowerStop": "Lower stop's priority",
-        "addStop": "Add a stop",
-        "clearStop": "Clear this stop",
-        "moveStop": "Move this stop",
-        "removeStop": "Remove this stop",
-        "drivingOptions": "Options",
-        "summary": "Direction's summary",
-        "stopsList": "Stops's list",
-        "instructions": "Instructions",
-        "copy": "Copy directions",
-        "geolocate": "Use current localisation as stop",
-        "link": "Link",
-        "print": "Print",
-        "dialog": {
-          "copyMsg": "Directions copied to clipboard",
-          "copyMsgLink": "Link for directions copied to clipboard",
-          "copyTitle": "Directions"
+        "directionsText": {
+          "link": "Link",
+          "stopList": "Stops",
+          "summary": "Summary"
         },
-        "toggleActive": "Activate direction control",
-        "toggleType": "Include forest roads",
         "forestRoadsWarning": {
           "title": "Warning",
           "text": "Some forest roads may be impassable or not suitable for vehicles."
+        },
+        "input": {
+          "addStop": "Add a destination",
+          "clearStop": "Clear stop",
+          "currentPosition": "Use current position",
+          "end": "Destination",
+          "intermediate": "Intermediate stop",
+          "moveStop": "Move stop",
+          "placeholder": "Click on the map or type to search",
+          "removeStop": "Remove stop",
+          "start": "Starting point"
+        },
+        "layer": {
+          "stops": "Directions - Stops",
+          "route": "Directions - Route"
+        },
+        "results": {
+          "direction": {
+            "n": "north",
+            "ne": "northeast",
+            "e": "east",
+            "se": "southeast",
+            "s": "south",
+            "sw": "southwest",
+            "w": "west",
+            "nw": "northwest"
+          },
+          "maneuverModifier": {
+            "uturn": "u-turn",
+            "sharp right": "sharp right",
+            "right": "right",
+            "slight right": "slight right",
+            "sharp left": "sharp left",
+            "left": "left",
+            "slight left": "slight left",
+            "straight": "straight"
+          },
+          "maneuverType": {
+            "arrive": {
+              "lastStep": "You have reached your destination, {{name}}",
+              "intermediate": "You have reached an intermediate stop, {{name}}"
+            },
+            "continue": "Continue on {{name}}",
+            "depart": "Head {{maneuverBearing}} on {{name}}",
+            "end of road": "At the end of the road, turn {{maneuverModifier}} onto {{name}}",
+            "exit roundabout": "Continue to {{name}}",
+            "fork": {
+              "left": "Keep left onto {{name}}",
+              "right": "Keep right onto {{name}}",
+              "else": "Continue on {{name}}"
+            },
+            "merge": "Continue on {{name}}",
+            "new name": "Head {{maneuverBearing}} on {{name}}",
+            "notification": "",
+            "off ramp": "Take the exit on the {{maneuverModifier}}",
+            "on ramp": "Take the ramp on the {{maneuverModifier}}",
+            "rotary": "",
+            "roundabout": "At the roundabout, take the exit towards {{name}}",
+            "roundabout turn": "",
+            "turn": {
+              "straight": "Continue {{maneuverModifier}} on {{name}}",
+              "uturn": "Make a {{maneuverModifier}}}} onto {{name}}",
+              "else": "Make a {{maneuverModifier}} turn onto {{name}}"
+            }
+          },
+          "routeOptions": "Route options",
+          "stepTitleTooltip": "Zoom on location"
+        },
+        "toggle": {
+          "activateControl": "Activate controls",
+          "type": "Include forest roads"
         }
       },
-      "directions": {
-        "uturn": "u-turn",
-        "sharp right": "sharp right",
-        "right": "right",
-        "slight right": "slightly on right",
-        "sharp left": "sharp left",
-        "left": "left",
-        "slight left": "slightly on left",
-        "straight": "forward",
-        "turn": {
-          "straight": "Continue on {{route}}",
-          "uturn": "Make u-turn on {{route}}",
-          "else": "Turn {{translatedModifier}} onto {{route}}"
-        },
-        "new name": "Head {{translatedDirection}} on {{route}}",
-        "depart": "Head {{translatedDirection}} on {{route}}",
-        "arrive": {
-          "lastStep": "You have reached your destination {{coma}} {{aggregatedDirection}}",
-          "intermediate": "You have reached the intermediate stop onto {{route}}"
-        },
-        "merge": "Continue on {{route}}",
-        "on ramp": "Take the ramp {{aggregatedDirection}}",
-        "off ramp": "Take exit {{aggregatedDirection}}",
-        "fork": {
-          "left": "Merge left onto {{route}}",
-          "right": "Merge right onto {{route}}",
-          "else": "Continue on {{route}}"
-        },
-        "end of road": "At the end of the road, turn {{translatedModifier}} onto {{route}}",
-        "use lane": "Take the lane ...",
-        "continue": {
-          "notUturn": "Continue on {{route}}"
-        },
-        "roundabout": "At the roundabout, take the {{exit}}{{cntSuffix}} exit towards {{route}}",
-        "rotary": "Roundabout rotary ...",
-        "roundabout turn": "Roundabout, take the ...",
-        "exit roundabout": "Continue to {{route}}",
-        "notification": "notification ...",
-        "uturnText": "Make u-turn and head {{translatedDirection}} on {{route}}",
-        "unknown": "???",
-
-        "cntSuffix": {
-          "first": "st",
-          "secondAndMore": "rd"
-        },
-        "modifier": {
-          "prefix": "on the "
-        }
-      },
-      "cardinalPoints": {
-        "n": "north",
-        "ne": "northeast",
-        "e": "east",
-        "se": "southeast",
-        "s": "south",
-        "sw": "southwest",
-        "w": "west",
-        "nw": "northwest"
-      },
       "search": {
         "placeholder": "Search for a localisation or a layer",
         "emptyType.placeholder": "Please choose a search type",