@googlemaps/routing 0.5.1 → 1.0.0

package/build/src/v2/routes_client.d.ts

@@ -163,8 +163,16 @@ export declare class RoutesClient {
      *   Optional. Specifies the preferred encoding for the polyline.
      * @param {google.protobuf.Timestamp} [request.departureTime]
      *   Optional. The departure time. If you don't set this value, then this value
-     *   defaults to the time that you made the request. If you set this value to a
-     *   time that has already occurred, then the request fails.
+     *   defaults to the time that you made the request.
+     *   NOTE: You can only specify a `departure_time` in the past when
+     *   {@link protos.google.maps.routing.v2.RouteTravelMode|RouteTravelMode} is set to
+     *   `TRANSIT`.
+     * @param {google.protobuf.Timestamp} [request.arrivalTime]
+     *   Optional. The arrival time.
+     *   NOTE: Can only be set when
+     *   {@link protos.google.maps.routing.v2.RouteTravelMode|RouteTravelMode} is set to
+     *   `TRANSIT`. You can specify either departure_time or arrival_time, but not
+     *   both.
      * @param {boolean} [request.computeAlternativeRoutes]
      *   Optional. Specifies whether to calculate alternate routes in addition to
      *   the route. No alternative routes are returned for requests that have
@@ -184,12 +192,23 @@ export declare class RoutesClient {
      *   two-character value. For more information see
      *   https://en.wikipedia.org/wiki/List_of_Internet_top-level_domains#Country_code_top-level_domains
      * @param {google.maps.routing.v2.Units} [request.units]
-     *   Optional. Specifies the units of measure for the display fields. This
-     *   includes the `instruction` field in
-     *   {@link google.maps.routing.v2.NavigationInstruction|NavigationInstruction}. The
+     *   Optional. Specifies the units of measure for the display fields. These
+     *   fields include the `instruction` field in
+     *   {@link protos.google.maps.routing.v2.NavigationInstruction|NavigationInstruction}. The
      *   units of measure used for the route, leg, step distance, and duration are
      *   not affected by this value. If you don't provide this value, then the
-     *   display units are inferred from the location of the request.
+     *   display units are inferred from the location of the first origin.
+     * @param {boolean} [request.optimizeWaypointOrder]
+     *   Optional. If set to true, the service attempts to minimize the overall cost
+     *   of the route by re-ordering the specified intermediate waypoints. The
+     *   request fails if any of the intermediate waypoints is a `via` waypoint. Use
+     *   `ComputeRoutesResponse.Routes.optimized_intermediate_waypoint_index` to
+     *   find the new ordering.
+     *   If `ComputeRoutesResponseroutes.optimized_intermediate_waypoint_index` is
+     *   not requested in the `X-Goog-FieldMask` header, the request fails.
+     *   If `optimize_waypoint_order` is set to false,
+     *   `ComputeRoutesResponse.optimized_intermediate_waypoint_index` will be
+     *   empty.
      * @param {number[]} [request.requestedReferenceRoutes]
      *   Optional. Specifies what reference routes to calculate as part of the
      *   request in addition to the default route. A reference route is a route with
@@ -201,12 +220,28 @@ export declare class RoutesClient {
      *   request. Note: These extra computations may return extra fields on the
      *   response. These extra fields must also be specified in the field mask to be
      *   returned in the response.
+     * @param {google.maps.routing.v2.TrafficModel} [request.trafficModel]
+     *   Optional. Specifies the assumptions to use when calculating time in
+     *   traffic. This setting affects the value returned in the duration field in
+     *   the {@link protos.google.maps.routing.v2.Route|Route} and
+     *   {@link protos.google.maps.routing.v2.RouteLeg|RouteLeg} which contains the predicted
+     *   time in traffic based on historical averages.
+     *   `TrafficModel` is only available for requests that have set
+     *   {@link protos.google.maps.routing.v2.RoutingPreference|RoutingPreference} to
+     *   `TRAFFIC_AWARE_OPTIMAL` and
+     *   {@link protos.google.maps.routing.v2.RouteTravelMode|RouteTravelMode} to `DRIVE`.
+     *   Defaults to `BEST_GUESS` if traffic is requested and `TrafficModel` is not
+     *   specified.
+     * @param {google.maps.routing.v2.TransitPreferences} [request.transitPreferences]
+     *   Optional. Specifies preferences that influence the route returned for
+     *   `TRANSIT` routes. NOTE: You can only specify a `transit_preferences` when
+     *   {@link protos.google.maps.routing.v2.RouteTravelMode|RouteTravelMode} is set to
+     *   `TRANSIT`.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
-     *   The first element of the array is an object representing {@link google.maps.routing.v2.ComputeRoutesResponse | ComputeRoutesResponse}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.maps.routing.v2.ComputeRoutesResponse|ComputeRoutesResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/routes.compute_routes.js</caption>
      * region_tag:routes_v2_generated_Routes_ComputeRoutes_async
@@ -280,9 +315,17 @@ export declare class RoutesClient {
      *   returned. You can specify this option only when the `travel_mode` is
      *   `DRIVE` or `TWO_WHEELER`, otherwise the request fails.
      * @param {google.protobuf.Timestamp} [request.departureTime]
-     *   Optional. The departure time. If you don't set this value, this defaults to
-     *   the time that you made the request. If you set this value to a time that
-     *   has already occurred, the request fails.
+     *   Optional. The departure time. If you don't set this value, then this value
+     *   defaults to the time that you made the request.
+     *   NOTE: You can only specify a `departure_time` in the past when
+     *   {@link protos.google.maps.routing.v2.RouteTravelMode|RouteTravelMode} is set to
+     *   `TRANSIT`.
+     * @param {google.protobuf.Timestamp} [request.arrivalTime]
+     *   Optional. The arrival time.
+     *   NOTE: Can only be set when
+     *   {@link protos.google.maps.routing.v2.RouteTravelMode|RouteTravelMode} is set to
+     *   `TRANSIT`. You can specify either departure_time or arrival_time, but not
+     *   both.
      * @param {string} [request.languageCode]
      *   Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more
      *   information, see
@@ -299,12 +342,26 @@ export declare class RoutesClient {
      *   request. Note: These extra computations may return extra fields on the
      *   response. These extra fields must also be specified in the field mask to be
      *   returned in the response.
+     * @param {google.maps.routing.v2.TrafficModel} [request.trafficModel]
+     *   Optional. Specifies the assumptions to use when calculating time in
+     *   traffic. This setting affects the value returned in the duration field in
+     *   the {@link protos.google.maps.routing.v2.RouteMatrixElement|RouteMatrixElement} which
+     *   contains the predicted time in traffic based on historical averages.
+     *   {@link protos.google.maps.routing.v2.RoutingPreference|RoutingPreference} to
+     *   `TRAFFIC_AWARE_OPTIMAL` and
+     *   {@link protos.google.maps.routing.v2.RouteTravelMode|RouteTravelMode} to `DRIVE`.
+     *   Defaults to `BEST_GUESS` if traffic is requested and `TrafficModel` is not
+     *   specified.
+     * @param {google.maps.routing.v2.TransitPreferences} [request.transitPreferences]
+     *   Optional. Specifies preferences that influence the route returned for
+     *   `TRANSIT` routes. NOTE: You can only specify a `transit_preferences` when
+     *   {@link protos.google.maps.routing.v2.RouteTravelMode|RouteTravelMode} is set to
+     *   `TRANSIT`.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
-     *   An object stream which emits {@link google.maps.routing.v2.RouteMatrixElement | RouteMatrixElement} on 'data' event.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming)
+     *   An object stream which emits {@link protos.google.maps.routing.v2.RouteMatrixElement|RouteMatrixElement} on 'data' event.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/routes.compute_route_matrix.js</caption>
      * region_tag:routes_v2_generated_Routes_ComputeRouteMatrix_async

package/build/src/v2/routes_client.js

@@ -316,9 +316,17 @@ class RoutesClient {
      *   returned. You can specify this option only when the `travel_mode` is
      *   `DRIVE` or `TWO_WHEELER`, otherwise the request fails.
      * @param {google.protobuf.Timestamp} [request.departureTime]
-     *   Optional. The departure time. If you don't set this value, this defaults to
-     *   the time that you made the request. If you set this value to a time that
-     *   has already occurred, the request fails.
+     *   Optional. The departure time. If you don't set this value, then this value
+     *   defaults to the time that you made the request.
+     *   NOTE: You can only specify a `departure_time` in the past when
+     *   {@link protos.google.maps.routing.v2.RouteTravelMode|RouteTravelMode} is set to
+     *   `TRANSIT`.
+     * @param {google.protobuf.Timestamp} [request.arrivalTime]
+     *   Optional. The arrival time.
+     *   NOTE: Can only be set when
+     *   {@link protos.google.maps.routing.v2.RouteTravelMode|RouteTravelMode} is set to
+     *   `TRANSIT`. You can specify either departure_time or arrival_time, but not
+     *   both.
      * @param {string} [request.languageCode]
      *   Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more
      *   information, see
@@ -335,12 +343,26 @@ class RoutesClient {
      *   request. Note: These extra computations may return extra fields on the
      *   response. These extra fields must also be specified in the field mask to be
      *   returned in the response.
+     * @param {google.maps.routing.v2.TrafficModel} [request.trafficModel]
+     *   Optional. Specifies the assumptions to use when calculating time in
+     *   traffic. This setting affects the value returned in the duration field in
+     *   the {@link protos.google.maps.routing.v2.RouteMatrixElement|RouteMatrixElement} which
+     *   contains the predicted time in traffic based on historical averages.
+     *   {@link protos.google.maps.routing.v2.RoutingPreference|RoutingPreference} to
+     *   `TRAFFIC_AWARE_OPTIMAL` and
+     *   {@link protos.google.maps.routing.v2.RouteTravelMode|RouteTravelMode} to `DRIVE`.
+     *   Defaults to `BEST_GUESS` if traffic is requested and `TrafficModel` is not
+     *   specified.
+     * @param {google.maps.routing.v2.TransitPreferences} [request.transitPreferences]
+     *   Optional. Specifies preferences that influence the route returned for
+     *   `TRANSIT` routes. NOTE: You can only specify a `transit_preferences` when
+     *   {@link protos.google.maps.routing.v2.RouteTravelMode|RouteTravelMode} is set to
+     *   `TRANSIT`.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
-     *   An object stream which emits {@link google.maps.routing.v2.RouteMatrixElement | RouteMatrixElement} on 'data' event.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming)
+     *   An object stream which emits {@link protos.google.maps.routing.v2.RouteMatrixElement|RouteMatrixElement} on 'data' event.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#server-streaming | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/routes.compute_route_matrix.js</caption>
      * region_tag:routes_v2_generated_Routes_ComputeRouteMatrix_async

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@googlemaps/routing",
-  "version": "0.5.1",
+  "version": "1.0.0",
   "description": " client for Node.js",
   "repository": {
     "type": "git",
@@ -31,7 +31,7 @@
   ],
   "scripts": {
     "clean": "gts clean",
-    "compile": "tsc -p . && cp -r protos build/ && minifyProtoJson",
+    "compile": "tsc -p . && cp -r protos build/",
     "compile-protos": "compileProtos src",
     "docs": "jsdoc -c .jsdoc.js",
     "predocs-test": "npm run docs",
@@ -39,34 +39,33 @@
     "fix": "gts fix",
     "lint": "gts check",
     "prepare": "npm run compile-protos && npm run compile",
-    "system-test": "npm run compile && c8 mocha build/system-test",
-    "test": "c8 mocha build/test",
-    "samples-test": "npm run compile && cd samples/ && npm link ../ && npm i && npm test",
-    "prelint": "cd samples; npm link ../; npm i"
+    "prelint": "cd samples; npm link ../; npm i",
+    "postpack": "minifyProtoJson",
+    "samples-test": "cd samples/ && npm link ../ && npm i && npm test",
+    "system-test": "c8 mocha build/system-test",
+    "test": "c8 mocha build/test"
   },
   "dependencies": {
-    "google-gax": "^3.5.8"
+    "google-gax": "^4.0.3"
   },
   "devDependencies": {
     "@types/mocha": "^9.0.0",
-    "@types/node": "^18.0.0",
+    "@types/node": "^20.4.5",
     "@types/sinon": "^10.0.0",
-    "c8": "^7.3.5",
-    "gts": "^3.1.0",
+    "c8": "^8.0.1",
+    "gapic-tools": "^0.1.8",
+    "gts": "^5.0.0",
     "jsdoc": "^4.0.0",
     "jsdoc-fresh": "^2.0.0",
     "jsdoc-region-tag": "^2.0.0",
-    "linkinator": "^4.0.0",
+    "linkinator": "4.1.2",
+    "long": "^5.2.3",
     "mocha": "^9.2.2",
-    "null-loader": "^4.0.1",
     "pack-n-play": "^1.0.0-2",
     "sinon": "^15.0.0",
-    "ts-loader": "^9.0.0",
-    "typescript": "^4.6.4",
-    "webpack": "^5.9.0",
-    "webpack-cli": "^5.0.0"
+    "typescript": "^5.1.6"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14.0.0"
   }
 }