@googlemaps/routing 0.1.0

package/build/protos/google/maps/routing/v2/maneuver.proto

@@ -0,0 +1,88 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.maps.routing.v2;
+
+option cc_enable_arenas = true;
+option csharp_namespace = "Google.Maps.Routing.V2";
+option go_package = "google.golang.org/genproto/googleapis/maps/routing/v2;routing";
+option java_multiple_files = true;
+option java_outer_classname = "ManeuverProto";
+option java_package = "com.google.maps.routing.v2";
+option objc_class_prefix = "GMRV2";
+option php_namespace = "Google\\Maps\\Routing\\V2";
+option ruby_package = "Google::Maps::Routing::V2";
+
+// A set of values that specify the navigation action to take for the current
+// step (e.g., turn left, merge, straight, etc.).
+enum Maneuver {
+  // Not used.
+  MANEUVER_UNSPECIFIED = 0;
+
+  // Turn slightly to the left.
+  TURN_SLIGHT_LEFT = 1;
+
+  // Turn sharply to the left.
+  TURN_SHARP_LEFT = 2;
+
+  // Make a left u-turn.
+  UTURN_LEFT = 3;
+
+  // Turn left.
+  TURN_LEFT = 4;
+
+  // Turn slightly to the right.
+  TURN_SLIGHT_RIGHT = 5;
+
+  // Turn sharply to the right.
+  TURN_SHARP_RIGHT = 6;
+
+  // Make a right u-turn.
+  UTURN_RIGHT = 7;
+
+  // Turn right.
+  TURN_RIGHT = 8;
+
+  // Go straight.
+  STRAIGHT = 9;
+
+  // Take the left ramp.
+  RAMP_LEFT = 10;
+
+  // Take the right ramp.
+  RAMP_RIGHT = 11;
+
+  // Merge into traffic.
+  MERGE = 12;
+
+  // Take the left fork.
+  FORK_LEFT = 13;
+
+  // Take the right fork.
+  FORK_RIGHT = 14;
+
+  // Take the ferry.
+  FERRY = 15;
+
+  // Take the train leading onto the ferry.
+  FERRY_TRAIN = 16;
+
+  // Turn left at the roundabout.
+  ROUNDABOUT_LEFT = 17;
+
+  // Turn right at the roundabout.
+  ROUNDABOUT_RIGHT = 18;
+}

package/build/protos/google/maps/routing/v2/navigation_instruction.proto

@@ -0,0 +1,40 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.maps.routing.v2;
+
+import "google/maps/routing/v2/maneuver.proto";
+
+option cc_enable_arenas = true;
+option csharp_namespace = "Google.Maps.Routing.V2";
+option go_package = "google.golang.org/genproto/googleapis/maps/routing/v2;routing";
+option java_multiple_files = true;
+option java_outer_classname = "NavigationInstructionProto";
+option java_package = "com.google.maps.routing.v2";
+option objc_class_prefix = "GMRV2";
+option php_namespace = "Google\\Maps\\Routing\\V2";
+option ruby_package = "Google::Maps::Routing::V2";
+
+// Encapsulates navigation instructions for a
+// [RouteLegStep][google.maps.routing.v2.RouteLegStep]
+message NavigationInstruction {
+  // Encapsulates the navigation instructions for the current step (e.g., turn
+  // left, merge, straight, etc.). This field determines which icon to display.
+  Maneuver maneuver = 1;
+
+  // Instructions for navigating this step.
+  string instructions = 2;
+}

package/build/protos/google/maps/routing/v2/polyline.proto

@@ -0,0 +1,74 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.maps.routing.v2;
+
+import "google/protobuf/struct.proto";
+
+option cc_enable_arenas = true;
+option csharp_namespace = "Google.Maps.Routing.V2";
+option go_package = "google.golang.org/genproto/googleapis/maps/routing/v2;routing";
+option java_multiple_files = true;
+option java_outer_classname = "PolylineProto";
+option java_package = "com.google.maps.routing.v2";
+option objc_class_prefix = "GMRV2";
+option php_namespace = "Google\\Maps\\Routing\\V2";
+option ruby_package = "Google::Maps::Routing::V2";
+
+// Encapsulates an encoded polyline.
+message Polyline {
+  // Encapsulates the type of polyline. Defaults to encoded_polyline.
+  oneof polyline_type {
+    // The string encoding of the polyline using the [polyline encoding
+    // algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm)
+    string encoded_polyline = 1;
+
+    // Specifies a polyline using the [GeoJSON LineString
+    // format](https://tools.ietf.org/html/rfc7946#section-3.1.4)
+    google.protobuf.Struct geo_json_linestring = 2;
+  }
+}
+
+// A set of values that specify the quality of the polyline.
+enum PolylineQuality {
+  // No polyline quality preference specified. Defaults to `OVERVIEW`.
+  POLYLINE_QUALITY_UNSPECIFIED = 0;
+
+  // Specifies a high-quality polyline - which is composed using more points
+  // than `OVERVIEW`, at the cost of increased response size. Use this value
+  // when you need more precision.
+  HIGH_QUALITY = 1;
+
+  // Specifies an overview polyline - which is composed using a small number of
+  // points. Use this value when displaying an overview of the route. Using this
+  // option has a lower request latency compared to using the
+  // `HIGH_QUALITY` option.
+  OVERVIEW = 2;
+}
+
+// Specifies the preferred type of polyline to be returned.
+enum PolylineEncoding {
+  // No polyline type preference specified. Defaults to `ENCODED_POLYLINE`.
+  POLYLINE_ENCODING_UNSPECIFIED = 0;
+
+  // Specifies a polyline encoded using the [polyline encoding
+  // algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm).
+  ENCODED_POLYLINE = 1;
+
+  // Specifies a polyline using the [GeoJSON LineString
+  // format](https://tools.ietf.org/html/rfc7946#section-3.1.4)
+  GEO_JSON_LINESTRING = 2;
+}

package/build/protos/google/maps/routing/v2/route.proto

@@ -0,0 +1,208 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.maps.routing.v2;
+
+import "google/geo/type/viewport.proto";
+import "google/maps/routing/v2/location.proto";
+import "google/maps/routing/v2/navigation_instruction.proto";
+import "google/maps/routing/v2/polyline.proto";
+import "google/maps/routing/v2/speed_reading_interval.proto";
+import "google/maps/routing/v2/toll_info.proto";
+import "google/protobuf/duration.proto";
+
+option cc_enable_arenas = true;
+option csharp_namespace = "Google.Maps.Routing.V2";
+option go_package = "google.golang.org/genproto/googleapis/maps/routing/v2;routing";
+option java_multiple_files = true;
+option java_outer_classname = "RouteProto";
+option java_package = "com.google.maps.routing.v2";
+option objc_class_prefix = "GMRV2";
+option php_namespace = "Google\\Maps\\Routing\\V2";
+option ruby_package = "Google::Maps::Routing::V2";
+
+// Encapsulates a route, which consists of a series of connected road segments
+// that join beginning, ending, and intermediate waypoints.
+message Route {
+  // A collection of legs (path segments between waypoints) that make-up the
+  // route. Each leg corresponds to the trip between two non-`via` Waypoints.
+  // For example, a route with no intermediate waypoints has only one leg. A
+  // route that includes one non-`via` intermediate waypoint has two legs. A
+  // route that includes one `via` intermediate waypoint has one leg. The order
+  // of the legs matches the order of Waypoints from `origin` to `intermediates`
+  // to `destination`.
+  repeated RouteLeg legs = 1;
+
+  // The travel distance of the route, in meters.
+  int32 distance_meters = 2;
+
+  // The length of time needed to navigate the route. If you set the
+  // `routing_preference` to `TRAFFIC_UNAWARE`, then this value is the same as
+  // `static_duration`. If you set the `routing_preference` to either
+  // `TRAFFIC_AWARE` or `TRAFFIC_AWARE_OPTIMAL`, then this value is calculated
+  // taking traffic conditions into account.
+  google.protobuf.Duration duration = 3;
+
+  // The duration of traveling through the route without taking traffic
+  // conditions into consideration.
+  google.protobuf.Duration static_duration = 4;
+
+  // The overall route polyline. This polyline will be the combined polyline of
+  // all `legs`.
+  Polyline polyline = 5;
+
+  // A description of the route.
+  string description = 6;
+
+  // An array of warnings to show when displaying the route.
+  repeated string warnings = 7;
+
+  // The viewport bounding box of the polyline.
+  google.geo.type.Viewport viewport = 8;
+
+  // Additional information about the route.
+  RouteTravelAdvisory travel_advisory = 9;
+}
+
+// Encapsulates the additional information that the user should be informed
+// about, such as possible traffic zone restriction etc.
+message RouteTravelAdvisory {
+  // Encapsulates information about tolls on the Route.
+  // This field is only populated if we expect there are tolls on the Route.
+  // If this field is set but the estimated_price subfield is not populated,
+  // we expect that road contains tolls but we do not know an estimated price.
+  // If this field is not set, then we expect there is no toll on the Route.
+  TollInfo toll_info = 2;
+
+  // Speed reading intervals detailing traffic density. Applicable in case of
+  // `TRAFFIC_AWARE` and `TRAFFIC_AWARE_OPTIMAL` routing preferences.
+  // The intervals cover the entire polyline of the route without overlap.
+  // The start point of a specified interval is the same as the end point of the
+  // preceding interval.
+  //
+  // Example:
+  //
+  //     polyline: A ---- B ---- C ---- D ---- E ---- F ---- G
+  //     speed_reading_intervals: [A,C), [C,D), [D,G).
+  repeated SpeedReadingInterval speed_reading_intervals = 3;
+}
+
+// Encapsulates the additional information that the user should be informed
+// about, such as possible traffic zone restriction etc. on a route leg.
+message RouteLegTravelAdvisory {
+  // Encapsulates information about tolls on the specific RouteLeg.
+  // This field is only populated if we expect there are tolls on the RouteLeg.
+  // If this field is set but the estimated_price subfield is not populated,
+  // we expect that road contains tolls but we do not know an estimated price.
+  // If this field does not exist, then there is no toll on the RouteLeg.
+  TollInfo toll_info = 1;
+
+  // Speed reading intervals detailing traffic density. Applicable in case of
+  // `TRAFFIC_AWARE` and `TRAFFIC_AWARE_OPTIMAL` routing preferences.
+  // The intervals cover the entire polyline of the RouteLg without overlap.
+  // The start point of a specified interval is the same as the end point of the
+  // preceding interval.
+  //
+  // Example:
+  //
+  //     polyline: A ---- B ---- C ---- D ---- E ---- F ---- G
+  //     speed_reading_intervals: [A,C), [C,D), [D,G).
+  repeated SpeedReadingInterval speed_reading_intervals = 2;
+}
+
+// Encapsulates the additional information that the user should be informed
+// about, such as possible traffic zone restriction on a leg step.
+message RouteLegStepTravelAdvisory {
+  // Speed reading intervals detailing traffic density. Applicable in case of
+  // `TRAFFIC_AWARE` and `TRAFFIC_AWARE_OPTIMAL` routing preferences.
+  // The intervals cover the entire polyline of the RouteLegStep without
+  // overlap. The start point of a specified interval is the same as the end
+  // point of the preceding interval.
+  //
+  // Example:
+  //
+  //     polyline: A ---- B ---- C ---- D ---- E ---- F ---- G
+  //     speed_reading_intervals: [A,C), [C,D), [D,G).
+  repeated SpeedReadingInterval speed_reading_intervals = 1;
+}
+
+// Encapsulates a segment between non-`via` waypoints.
+message RouteLeg {
+  // The travel distance of the route leg, in meters.
+  int32 distance_meters = 1;
+
+  // The length of time needed to navigate the leg. If the `route_preference`
+  // is set to `TRAFFIC_UNAWARE`, then this value is the same as
+  // `static_duration`. If the `route_preference` is either `TRAFFIC_AWARE` or
+  // `TRAFFIC_AWARE_OPTIMAL`, then this value is calculated taking traffic
+  // conditions into account.
+  google.protobuf.Duration duration = 2;
+
+  // The duration of traveling through the leg, calculated without taking
+  // traffic conditions into consideration.
+  google.protobuf.Duration static_duration = 3;
+
+  // The overall polyline for this leg. This includes that each `step`'s
+  // polyline.
+  Polyline polyline = 4;
+
+  // The start location of this leg. This might be different from the provided
+  // `origin`. For example, when the provided `origin` is not near a road, this
+  // is a point on the road.
+  Location start_location = 5;
+
+  // The end location of this leg. This might be different from the provided
+  // `destination`. For example, when the provided `destination` is not near a
+  // road, this is a point on the road.
+  Location end_location = 6;
+
+  // An array of steps denoting segments within this leg. Each step represents
+  // one navigation instruction.
+  repeated RouteLegStep steps = 7;
+
+  // Encapsulates the additional information that the user should be informed
+  // about, such as possible traffic zone restriction etc. on a route leg.
+  RouteLegTravelAdvisory travel_advisory = 8;
+}
+
+// Encapsulates a segment of a `RouteLeg`. A step corresponds to a single
+// navigation instruction. Route legs are made up of steps.
+message RouteLegStep {
+  // The travel distance of this step, in meters. In some circumstances, this
+  // field might not have a value.
+  int32 distance_meters = 1;
+
+  // The duration of travel through this step without taking traffic conditions
+  // into consideration. In some circumstances, this field might not have a
+  // value.
+  google.protobuf.Duration static_duration = 2;
+
+  // The polyline associated with this step.
+  Polyline polyline = 3;
+
+  // The start location of this step.
+  Location start_location = 4;
+
+  // The end location of this step.
+  Location end_location = 5;
+
+  // Navigation instructions.
+  NavigationInstruction navigation_instruction = 6;
+
+  // Encapsulates the additional information that the user should be informed
+  // about, such as possible traffic zone restriction on a leg step.
+  RouteLegStepTravelAdvisory travel_advisory = 7;
+}

package/build/protos/google/maps/routing/v2/route_modifiers.proto

@@ -0,0 +1,64 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.maps.routing.v2;
+
+import "google/maps/routing/v2/toll_passes.proto";
+import "google/maps/routing/v2/vehicle_info.proto";
+
+option cc_enable_arenas = true;
+option csharp_namespace = "Google.Maps.Routing.V2";
+option go_package = "google.golang.org/genproto/googleapis/maps/routing/v2;routing";
+option java_multiple_files = true;
+option java_outer_classname = "RouteModifiersProto";
+option java_package = "com.google.maps.routing.v2";
+option objc_class_prefix = "GMRV2";
+option php_namespace = "Google\\Maps\\Routing\\V2";
+option ruby_package = "Google::Maps::Routing::V2";
+
+// Encapsulates a set of optional conditions to satisfy when calculating the
+// routes.
+message RouteModifiers {
+  // Specifies whether to avoid toll roads where reasonable. Preference will be
+  // given to routes not containing toll roads. Applies only to the `DRIVE` and
+  // `TWO_WHEELER` travel modes.
+  bool avoid_tolls = 1;
+
+  // Specifies whether to avoid highways where reasonable. Preference will be
+  // given to routes not containing highways. Applies only to the `DRIVE` and
+  // `TWO_WHEELER` travel modes.
+  bool avoid_highways = 2;
+
+  // Specifies whether to avoid ferries where reasonable. Preference will be
+  // given to routes not containing travel by ferries.
+  // Applies only to the `DRIVE` and`TWO_WHEELER` travel modes.
+  bool avoid_ferries = 3;
+
+  // Specifies whether to avoid navigating indoors where reasonable. Preference
+  // will be given to routes not containing indoor navigation.
+  // Applies only to the `WALK` travel mode.
+  bool avoid_indoor = 4;
+
+  // Specifies the vehicle information.
+  VehicleInfo vehicle_info = 5;
+
+  // Encapsulates information about toll passes.
+  // If toll passes are provided, the API tries to return the pass price. If
+  // toll passes are not provided, the API treats the toll pass as unknown and
+  // tries to return the cash price.
+  // Applies only to the DRIVE and TWO_WHEELER travel modes.
+  repeated TollPass toll_passes = 6;
+}

package/build/protos/google/maps/routing/v2/route_travel_mode.proto

@@ -0,0 +1,46 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.maps.routing.v2;
+
+option cc_enable_arenas = true;
+option csharp_namespace = "Google.Maps.Routing.V2";
+option go_package = "google.golang.org/genproto/googleapis/maps/routing/v2;routing";
+option java_multiple_files = true;
+option java_outer_classname = "RouteTravelModeProto";
+option java_package = "com.google.maps.routing.v2";
+option objc_class_prefix = "GMRV2";
+option php_namespace = "Google\\Maps\\Routing\\V2";
+option ruby_package = "Google::Maps::Routing::V2";
+
+// A set of values used to specify the mode of travel.
+enum RouteTravelMode {
+  // No travel mode specified. Defaults to `DRIVE`.
+  TRAVEL_MODE_UNSPECIFIED = 0;
+
+  // Travel by passenger car.
+  DRIVE = 1;
+
+  // Travel by bicycle.
+  BICYCLE = 2;
+
+  // Travel by walking.
+  WALK = 3;
+
+  // Two-wheeled, motorized vehicle. For example, motorcycle. Note that this
+  // differs from the `BICYCLE` travel mode which covers human-powered mode.
+  TWO_WHEELER = 4;
+}