@wemap/routers 12.10.8 → 12.11.0

package/dist/src/remote/RemoteRouterManager.d.ts

@@ -0,0 +1,731 @@
+import { default as RemoteRouter } from './RemoteRouter.js';
+import { RouterRequest } from '../model/RouterRequest.js';
+declare const remoteRouters: readonly [{
+    readonly rname: "cityway";
+    getItineraries(endpointUrl: string, routerRequest: RouterRequest): Promise<import('../model/Itinerary.js').default[]>;
+    getURL(endpointUrl: string, routerRequest: RouterRequest): string;
+    parseResponse(json: {
+        StatusCode: number;
+        Message: string;
+        Data: {
+            response: {
+                trips: {
+                    Trip: {
+                        Duration: string;
+                        Departure: {
+                            Time: string;
+                            Site: {
+                                Position: {
+                                    Lat: number;
+                                    Long: number;
+                                };
+                            };
+                        };
+                        Arrival: {
+                            Time: string;
+                            Site: {
+                                Position: {
+                                    Lat: number;
+                                    Long: number;
+                                };
+                            };
+                        };
+                        sections: {
+                            Section: {
+                                Leg?: {
+                                    TransportMode: string;
+                                    Duration: string;
+                                    Departure: {
+                                        Time: string;
+                                        Site: {
+                                            Name: string;
+                                            Position: {
+                                                Lat: number;
+                                                Long: number;
+                                            };
+                                        };
+                                        StopPlace: {
+                                            Name: string;
+                                            Position: {
+                                                Lat: number;
+                                                Long: number;
+                                            };
+                                        };
+                                    };
+                                    Arrival: {
+                                        /**
+                                         * Singleton
+                                         */
+                                        Time: string;
+                                        Site: {
+                                            Name: string;
+                                            Position: {
+                                                Lat: number;
+                                                Long: number;
+                                            };
+                                        };
+                                        StopPlace: {
+                                            Name: string;
+                                            Position: {
+                                                Lat: number;
+                                                Long: number;
+                                            };
+                                        };
+                                    };
+                                    Line: {
+                                        Name: string;
+                                        Number: string;
+                                        Color: string;
+                                        TextColor: string;
+                                    };
+                                    Destination: string;
+                                    Distance: number;
+                                    steps: {
+                                        Step: {
+                                            Geometry: string;
+                                        }[];
+                                    };
+                                    pathLinks: {
+                                        PathLink: {
+                                            Departure: {
+                                                Site: {
+                                                    Name: string;
+                                                };
+                                            };
+                                            Distance: number;
+                                            Geometry: string;
+                                        }[];
+                                    };
+                                } | undefined;
+                                PTRide: {
+                                    TransportMode: string;
+                                    Duration: string;
+                                    Departure: {
+                                        Time: string;
+                                        Site: {
+                                            Name: string;
+                                            Position: {
+                                                Lat: number;
+                                                Long: number;
+                                            };
+                                        };
+                                        StopPlace: {
+                                            Name: string;
+                                            Position: {
+                                                Lat: number;
+                                                Long: number;
+                                            };
+                                        };
+                                    };
+                                    Arrival: {
+                                        /**
+                                         * Singleton
+                                         */
+                                        Time: string;
+                                        Site: {
+                                            Name: string;
+                                            Position: {
+                                                Lat: number;
+                                                Long: number;
+                                            };
+                                        };
+                                        StopPlace: {
+                                            Name: string;
+                                            Position: {
+                                                Lat: number;
+                                                Long: number;
+                                            };
+                                        };
+                                    };
+                                    Line: {
+                                        Name: string;
+                                        Number: string;
+                                        Color: string;
+                                        TextColor: string;
+                                    };
+                                    Destination: string;
+                                    Distance: number;
+                                    steps: {
+                                        Step: {
+                                            Geometry: string;
+                                        }[];
+                                    };
+                                    pathLinks: {
+                                        PathLink: {
+                                            Departure: {
+                                                Site: {
+                                                    Name: string;
+                                                };
+                                            };
+                                            Distance: number;
+                                            Geometry: string;
+                                        }[];
+                                    };
+                                };
+                            }[];
+                        };
+                    }[];
+                };
+            };
+            PlanTripType?: string | undefined;
+        }[];
+    }): import('../model/Itinerary.js').default[];
+    parseDuration(iso8601Duration: string): number;
+}, {
+    readonly rname: "navitia";
+    getItineraries(endpointUrl: string, routerRequest: RouterRequest): Promise<import('../model/Itinerary.js').default[]>;
+    getURL(endpointUrl: string, routerRequest: RouterRequest): URL;
+    getCarQuery(): URLSearchParams;
+    getWalkingQuery(): URLSearchParams;
+    getBikeQuery(): URLSearchParams;
+    getSectionCoords(section: import('./navitia/types.js').NavitiaSection): {
+        from: import('@wemap/geo/dist/src/coordinates/Coordinates.js').default;
+        to: import('@wemap/geo/dist/src/coordinates/Coordinates.js').default;
+    };
+    findStepsCoord(legCoords: import('@wemap/geo/dist/src/coordinates/Coordinates.js').default[], steps: import('./navitia/types.js').NavitiaIntermediateStep[]): {
+        coords: import('@wemap/geo/dist/src/coordinates/Coordinates.js').default;
+        name: string;
+        distance: number;
+    }[];
+    findStepCoords(step: import('./navitia/types.js').NavitiaPath, section: import('./navitia/types.js').NavitiaSection): import('@wemap/geo/dist/src/coordinates/Coordinates.js').default | undefined;
+    parseResponse(json: import('./navitia/types.js').NavitiaJson): import('../model/Itinerary.js').default[];
+}, {
+    readonly rname: "deutsche-bahn";
+    getItineraries(endpointUrl: string, routerRequest: RouterRequest): Promise<import('../model/Itinerary.js').default[]>;
+    getURL(endpointUrl: string, routerRequest: RouterRequest): string;
+    parseResponse(json: {
+        segments: {
+            fromLevel: number;
+            toLevel: number;
+            polyline: {
+                lat: number;
+                lon: number;
+            }[];
+        }[];
+    }, origin: import('@wemap/geo/dist/src/coordinates/Coordinates.js').default, destination: import('@wemap/geo/dist/src/coordinates/Coordinates.js').default): import('../model/Itinerary.js').default[];
+}, {
+    readonly rname: "idfm";
+    getItineraries(endpointUrl: string, routerRequest: RouterRequest): Promise<import('../model/Itinerary.js').default[]>;
+    getURL(endpointUrl: string, routerRequest: RouterRequest): string;
+    getCarQuery(): URLSearchParams;
+    getWalkingQuery(): URLSearchParams;
+    getBikeQuery(): URLSearchParams;
+    getSectionCoords(section: {
+        id: string;
+        type: string;
+        mode: string;
+        departure_date_time: string;
+        arrival_date_time: string;
+        duration: number;
+        geojson: {
+            coordinates: [number, number][];
+            properties: {
+                length: number;
+            }[];
+        };
+        path: ({
+            name: string;
+            length: number;
+        } & ({
+            instruction_start_coordinate: {
+                lat: string | number;
+                lon: string | number;
+            };
+        } | {
+            via_uri: string;
+        }))[];
+        display_informations: {
+            code: string;
+            color: string;
+            text_color: string;
+            direction: string;
+            physical_mode: string;
+        };
+        from: {
+            name: string;
+        } & ({
+            stop_point: {
+                coord: {
+                    lat: string | number;
+                    lon: string | number;
+                };
+            };
+        } | {
+            address: {
+                coord: {
+                    lat: string | number;
+                    lon: string | number;
+                };
+            };
+        } | {
+            poi: {
+                coord: {
+                    lat: string | number;
+                    lon: string | number;
+                };
+            };
+        });
+        to: {
+            name: string;
+        } & ({
+            stop_point: {
+                coord: {
+                    lat: string | number;
+                    lon: string | number;
+                };
+            };
+        } | {
+            address: {
+                coord: {
+                    lat: string | number;
+                    lon: string | number;
+                };
+            };
+        } | {
+            poi: {
+                coord: {
+                    lat: string | number;
+                    lon: string | number;
+                };
+            };
+        });
+        vias?: {
+            id: string;
+            name: string;
+            access_point: {
+                id: string;
+                name: string;
+                coord: {
+                    lon: string;
+                    lat: string;
+                };
+                embedded_type: string;
+            };
+            is_entrance: boolean;
+            is_exit: boolean;
+            length: number;
+            traversal_time: number;
+            pathway_mode: number;
+        }[] | undefined;
+    }): {
+        from: import('@wemap/geo/dist/src/coordinates/Coordinates.js').default;
+        to: import('@wemap/geo/dist/src/coordinates/Coordinates.js').default;
+    };
+    findStepsCoord(legCoords: import('@wemap/geo/dist/src/coordinates/Coordinates.js').default[], steps: {
+        name: string;
+        distance: number;
+    }[]): {
+        coords: import('@wemap/geo/dist/src/coordinates/Coordinates.js').default;
+        name: string;
+        distance: number;
+    }[];
+    findStepCoords(step: {
+        name: string;
+        length: number;
+    } & ({
+        instruction_start_coordinate: {
+            lat: string | number;
+            lon: string | number;
+        };
+    } | {
+        via_uri: string;
+    }), section: {
+        id: string;
+        type: string;
+        mode: string;
+        departure_date_time: string;
+        arrival_date_time: string;
+        duration: number;
+        geojson: {
+            coordinates: [number, number][];
+            properties: {
+                length: number;
+            }[];
+        };
+        path: ({
+            name: string;
+            length: number;
+        } & ({
+            instruction_start_coordinate: {
+                lat: string | number;
+                lon: string | number;
+            };
+        } | {
+            via_uri: string;
+        }))[];
+        display_informations: {
+            code: string;
+            color: string;
+            text_color: string;
+            direction: string;
+            physical_mode: string;
+        };
+        from: {
+            name: string;
+        } & ({
+            stop_point: {
+                coord: {
+                    lat: string | number;
+                    lon: string | number;
+                };
+            };
+        } | {
+            address: {
+                coord: {
+                    lat: string | number;
+                    lon: string | number;
+                };
+            };
+        } | {
+            poi: {
+                coord: {
+                    lat: string | number;
+                    lon: string | number;
+                };
+            };
+        });
+        to: {
+            name: string;
+        } & ({
+            stop_point: {
+                coord: {
+                    lat: string | number;
+                    lon: string | number;
+                };
+            };
+        } | {
+            address: {
+                coord: {
+                    lat: string | number;
+                    lon: string | number;
+                };
+            };
+        } | {
+            poi: {
+                coord: {
+                    lat: string | number;
+                    lon: string | number;
+                };
+            };
+        });
+        vias?: {
+            id: string;
+            name: string;
+            access_point: {
+                id: string;
+                name: string;
+                coord: {
+                    lon: string;
+                    lat: string;
+                };
+                embedded_type: string;
+            };
+            is_entrance: boolean;
+            is_exit: boolean;
+            length: number;
+            traversal_time: number;
+            pathway_mode: number;
+        }[] | undefined;
+    }): import('@wemap/geo/dist/src/coordinates/Coordinates.js').default | undefined;
+    parseResponse(json: {
+        journeys: {
+            duration: number;
+            departure_date_time: string;
+            arrival_date_time: string;
+            sections: {
+                id: string;
+                type: string;
+                mode: string;
+                departure_date_time: string;
+                arrival_date_time: string;
+                duration: number;
+                geojson: {
+                    coordinates: [number, number][];
+                    properties: {
+                        length: number;
+                    }[];
+                };
+                path: ({
+                    name: string;
+                    length: number;
+                } & ({
+                    instruction_start_coordinate: {
+                        lat: string | number;
+                        lon: string | number;
+                    };
+                } | {
+                    via_uri: string;
+                }))[];
+                display_informations: {
+                    code: string;
+                    color: string;
+                    text_color: string;
+                    direction: string;
+                    physical_mode: string;
+                };
+                from: {
+                    name: string;
+                } & ({
+                    stop_point: {
+                        coord: {
+                            lat: string | number;
+                            lon: string | number;
+                        };
+                    };
+                } | {
+                    address: {
+                        coord: {
+                            lat: string | number;
+                            lon: string | number;
+                        };
+                    };
+                } | {
+                    poi: {
+                        coord: {
+                            lat: string | number;
+                            lon: string | number;
+                        };
+                    };
+                });
+                to: {
+                    name: string;
+                } & ({
+                    stop_point: {
+                        coord: {
+                            lat: string | number;
+                            lon: string | number;
+                        };
+                    };
+                } | {
+                    address: {
+                        coord: {
+                            lat: string | number;
+                            lon: string | number;
+                        };
+                    };
+                } | {
+                    poi: {
+                        coord: {
+                            lat: string | number;
+                            lon: string | number;
+                        };
+                    };
+                });
+                vias?: {
+                    id: string;
+                    name: string;
+                    access_point: {
+                        id: string;
+                        name: string;
+                        coord: {
+                            lon: string;
+                            lat: string;
+                        };
+                        embedded_type: string;
+                    };
+                    is_entrance: boolean;
+                    is_exit: boolean;
+                    length: number;
+                    traversal_time: number;
+                    pathway_mode: number;
+                }[] | undefined;
+            }[];
+        }[];
+        context: {
+            timezone: string;
+        };
+        error: {
+            message?: string | undefined;
+        };
+    }): import('../model/Itinerary.js').default[];
+}, {
+    readonly rname: "osrm";
+    getItineraries(endpointUrl: string, routerRequest: RouterRequest): Promise<import('../model/Itinerary.js').default[]>;
+    getURL(endpointUrl: string, routerRequest: RouterRequest): string;
+    inputModeCorrespondance: (routerRequest: RouterRequest) => "walking" | "bike" | "driving" | "pmr" | "bike-safest" | "bike-fastest";
+    coordinatesToJson({ lat, lng, level }: import('@wemap/geo/dist/src/coordinates/Coordinates.js').default): import('geojson').Position;
+    jsonToCoordinates(json: import('geojson').Position): import('@wemap/geo/dist/src/coordinates/Coordinates.js').default;
+    getModifierFromAngle(_angle: number): "sharp right" | "sharp left" | "slight right" | "slight left" | "right" | "left" | "u turn" | "straight";
+    noRouteFoundJson(message: object): {
+        code: string;
+        message: object;
+    };
+    itineraryToOsrmJson(itinerary: import('../model/Itinerary.js').default): {
+        code?: string | undefined;
+        message?: string | undefined;
+        routes?: {
+            geometry: import('geojson').LineString;
+            legs: {
+                distance: number;
+                duration: number;
+                steps: {
+                    geometry: import('geojson').LineString;
+                    distance: number;
+                    duration: number;
+                    name?: string | undefined;
+                    maneuver: {
+                        bearing_before: number;
+                        bearing_after: number;
+                        location: import('geojson').Position;
+                        modifier: "sharp right" | "sharp left" | "slight right" | "slight left" | "right" | "left" | "u turn" | "straight";
+                        type: "depart" | "turn" | "arrive";
+                    };
+                }[];
+            }[];
+            distance: number;
+            duration: number;
+            weight_name: string;
+            weight: number;
+        }[] | undefined;
+        waypoints?: [] | undefined;
+    };
+    parseResponse(json: {
+        code?: string | undefined;
+        message?: string | undefined;
+        routes?: {
+            geometry: import('geojson').LineString;
+            legs: {
+                distance: number;
+                duration: number;
+                steps: {
+                    geometry: import('geojson').LineString;
+                    distance: number;
+                    duration: number;
+                    name?: string | undefined;
+                    maneuver: {
+                        bearing_before: number;
+                        bearing_after: number;
+                        location: import('geojson').Position;
+                        modifier: "sharp right" | "sharp left" | "slight right" | "slight left" | "right" | "left" | "u turn" | "straight";
+                        type: "depart" | "turn" | "arrive";
+                    };
+                }[];
+            }[];
+            distance: number;
+            duration: number;
+            weight_name: string;
+            weight: number;
+        }[] | undefined;
+        waypoints?: [] | undefined;
+    }, origin: import('@wemap/geo/dist/src/coordinates/Coordinates.js').default, destination: import('@wemap/geo/dist/src/coordinates/Coordinates.js').default, travelMode: import('../model/TravelMode.js').TravelMode): import('../model/Itinerary.js').default[];
+}, {
+    readonly rname: "otp";
+    getItineraries(endpointUrl: string, routerRequest: RouterRequest): Promise<import('../model/Itinerary.js').default[]>;
+    getURL(endpointUrl: string, routerRequest: RouterRequest): string;
+    parseResponse(json: {
+        plan: {
+            from: {
+                lat: number;
+                lon: number;
+            } & {
+                name: string;
+            };
+            to: {
+                lat: number;
+                lon: number;
+            } & {
+                name: string;
+            };
+            itineraries: {
+                duration: number;
+                startTime: number;
+                endTime: number;
+                walkDistance: number;
+                legs: (({
+                    startTime: number;
+                    endTime: number;
+                    legGeometry: {
+                        points: string;
+                        length: number;
+                    };
+                    duration: number;
+                } & {
+                    mode: "WALK";
+                    from: {
+                        lat: number;
+                        lon: number;
+                    } & {
+                        name: string;
+                    };
+                    to: {
+                        lat: number;
+                        lon: number;
+                    } & {
+                        name: string;
+                    };
+                    steps: ({
+                        lat: number;
+                        lon: number;
+                    } & {
+                        distance: number;
+                        streetName: string;
+                    })[];
+                }) | ({
+                    startTime: number;
+                    endTime: number;
+                    legGeometry: {
+                        points: string;
+                        length: number;
+                    };
+                    duration: number;
+                } & {
+                    mode: "BUS" | "TRAM";
+                    from: {
+                        lat: number;
+                        lon: number;
+                    } & {
+                        name: string;
+                    } & {
+                        stopId: string;
+                        stopCode: string;
+                    };
+                    to: {
+                        lat: number;
+                        lon: number;
+                    } & {
+                        name: string;
+                    } & {
+                        stopId: string;
+                        stopCode: string;
+                    };
+                    intermediateStops: {
+                        lat: number;
+                        lon: number;
+                    } & {
+                        name: string;
+                    } & {
+                        stopId: string;
+                        stopCode: string;
+                    };
+                    routeShortName: "string";
+                    routeColor?: "string" | undefined;
+                    routeTextColor?: "string" | undefined;
+                    headsign: "string";
+                }))[];
+            }[];
+        };
+    }): import('../model/Itinerary.js').default[];
+}, {
+    readonly rname: "wemap-multi";
+    getItineraries(endpointUrl: string, routerRequest: Omit<RouterRequest, "origin" | "destination" | "waypoints"> & {
+        mapId?: number | undefined;
+        origin: string | number | import('@wemap/geo/dist/src/coordinates/Coordinates.js').default;
+        destination: string | number | import('@wemap/geo/dist/src/coordinates/Coordinates.js').default;
+        waypoints?: (string | number | import('@wemap/geo/dist/src/coordinates/Coordinates.js').default)[] | undefined;
+    }): Promise<import('../model/Itinerary.js').default[]>;
+}];
+export type RemoteRouterName = typeof remoteRouters[number]['rname'];
+export type RoutingFallbackStrategy = {
+    name: RemoteRouterName;
+    endpointUrl: string;
+}[];
+/**
+ * Singleton
+ */
+declare class RemoteRouterManager {
+    getRouterByName(name: RemoteRouterName): RemoteRouter;
+    getItineraries(name: RemoteRouterName, endpointUrl: string, routerRequest: RouterRequest): Promise<import('../model/Itinerary.js').default[]>;
+    getItinerariesWithFallback(routerRequest: RouterRequest, fallbackStrategy: RoutingFallbackStrategy): Promise<import('../model/Itinerary.js').default[]>;
+}
+declare const _default: RemoteRouterManager;
+export default _default;