@googlemaps/routing 1.3.0 → 2.0.0

package/build/protos/protos.json

@@ -160,30 +160,6 @@
                 }
               }
             },
-            "Duration": {
-              "fields": {
-                "seconds": {
-                  "type": "int64",
-                  "id": 1
-                },
-                "nanos": {
-                  "type": "int32",
-                  "id": 2
-                }
-              }
-            },
-            "Timestamp": {
-              "fields": {
-                "seconds": {
-                  "type": "int64",
-                  "id": 1
-                },
-                "nanos": {
-                  "type": "int32",
-                  "id": 2
-                }
-              }
-            },
             "FileDescriptorSet": {
               "fields": {
                 "file": {
@@ -1447,6 +1423,30 @@
                   }
                 }
               }
+            },
+            "Duration": {
+              "fields": {
+                "seconds": {
+                  "type": "int64",
+                  "id": 1
+                },
+                "nanos": {
+                  "type": "int32",
+                  "id": 2
+                }
+              }
+            },
+            "Timestamp": {
+              "fields": {
+                "seconds": {
+                  "type": "int64",
+                  "id": 1
+                },
+                "nanos": {
+                  "type": "int32",
+                  "id": 2
+                }
+              }
             }
           }
         },
@@ -1535,7 +1535,6 @@
               "nested": {
                 "v2": {
                   "options": {
-                    "cc_enable_arenas": true,
                     "csharp_namespace": "Google.Maps.Routing.V2",
                     "go_package": "cloud.google.com/go/maps/routing/apiv2/routingpb;routingpb",
                     "java_multiple_files": true,
@@ -1543,7 +1542,8 @@
                     "java_package": "com.google.maps.routing.v2",
                     "objc_class_prefix": "GMRV2",
                     "php_namespace": "Google\\Maps\\Routing\\V2",
-                    "ruby_package": "Google::Maps::Routing::V2"
+                    "ruby_package": "Google::Maps::Routing::V2",
+                    "cc_enable_arenas": true
                   },
                   "nested": {
                     "FallbackInfo": {
@@ -1719,6 +1719,89 @@
                         "GEO_JSON_LINESTRING": 2
                       }
                     },
+                    "PolylineDetails": {
+                      "fields": {
+                        "flyoverInfo": {
+                          "rule": "repeated",
+                          "type": "FlyoverInfo",
+                          "id": 12
+                        },
+                        "narrowRoadInfo": {
+                          "rule": "repeated",
+                          "type": "NarrowRoadInfo",
+                          "id": 13
+                        }
+                      },
+                      "nested": {
+                        "PolylinePointIndex": {
+                          "oneofs": {
+                            "_startIndex": {
+                              "oneof": [
+                                "startIndex"
+                              ]
+                            },
+                            "_endIndex": {
+                              "oneof": [
+                                "endIndex"
+                              ]
+                            }
+                          },
+                          "fields": {
+                            "startIndex": {
+                              "type": "int32",
+                              "id": 1,
+                              "options": {
+                                "proto3_optional": true
+                              }
+                            },
+                            "endIndex": {
+                              "type": "int32",
+                              "id": 2,
+                              "options": {
+                                "proto3_optional": true
+                              }
+                            }
+                          }
+                        },
+                        "RoadFeatureState": {
+                          "values": {
+                            "ROAD_FEATURE_STATE_UNSPECIFIED": 0,
+                            "EXISTS": 1,
+                            "DOES_NOT_EXIST": 2
+                          }
+                        },
+                        "FlyoverInfo": {
+                          "fields": {
+                            "flyoverPresence": {
+                              "type": "RoadFeatureState",
+                              "id": 1,
+                              "options": {
+                                "(google.api.field_behavior)": "OUTPUT_ONLY"
+                              }
+                            },
+                            "polylinePointIndex": {
+                              "type": "PolylinePointIndex",
+                              "id": 2
+                            }
+                          }
+                        },
+                        "NarrowRoadInfo": {
+                          "fields": {
+                            "narrowRoadPresence": {
+                              "type": "RoadFeatureState",
+                              "id": 1,
+                              "options": {
+                                "(google.api.field_behavior)": "OUTPUT_ONLY"
+                              }
+                            },
+                            "polylinePointIndex": {
+                              "type": "PolylinePointIndex",
+                              "id": 2
+                            }
+                          }
+                        }
+                      }
+                    },
                     "Route": {
                       "fields": {
                         "routeLabels": {
@@ -1776,6 +1859,10 @@
                         "routeToken": {
                           "type": "string",
                           "id": 12
+                        },
+                        "polylineDetails": {
+                          "type": "PolylineDetails",
+                          "id": 14
                         }
                       },
                       "nested": {
@@ -2089,7 +2176,8 @@
                         "ROUTE_LABEL_UNSPECIFIED": 0,
                         "DEFAULT_ROUTE": 1,
                         "DEFAULT_ROUTE_ALTERNATE": 2,
-                        "FUEL_EFFICIENT": 3
+                        "FUEL_EFFICIENT": 3,
+                        "SHORTER_DISTANCE": 4
                       }
                     },
                     "RouteTravelMode": {
@@ -2607,7 +2695,8 @@
                         "ReferenceRoute": {
                           "values": {
                             "REFERENCE_ROUTE_UNSPECIFIED": 0,
-                            "FUEL_EFFICIENT": 1
+                            "FUEL_EFFICIENT": 1,
+                            "SHORTER_DISTANCE": 2
                           }
                         },
                         "ExtraComputation": {
@@ -2616,7 +2705,9 @@
                             "TOLLS": 1,
                             "FUEL_CONSUMPTION": 2,
                             "TRAFFIC_ON_POLYLINE": 3,
-                            "HTML_FORMATTED_NAVIGATION_INSTRUCTIONS": 4
+                            "HTML_FORMATTED_NAVIGATION_INSTRUCTIONS": 4,
+                            "FLYOVER_INFO_ON_POLYLINE": 7,
+                            "NARROW_ROAD_INFO_ON_POLYLINE": 8
                           }
                         }
                       }
@@ -2986,14 +3077,33 @@
         },
         "api": {
           "options": {
-            "go_package": "google.golang.org/genproto/googleapis/api/annotations;annotations",
+            "go_package": "google.golang.org/genproto/googleapis/api;api",
             "java_multiple_files": true,
-            "java_outer_classname": "FieldBehaviorProto",
+            "java_outer_classname": "LaunchStageProto",
             "java_package": "com.google.api",
             "objc_class_prefix": "GAPI",
             "cc_enable_arenas": true
           },
           "nested": {
+            "fieldBehavior": {
+              "rule": "repeated",
+              "type": "google.api.FieldBehavior",
+              "id": 1052,
+              "extend": "google.protobuf.FieldOptions"
+            },
+            "FieldBehavior": {
+              "values": {
+                "FIELD_BEHAVIOR_UNSPECIFIED": 0,
+                "OPTIONAL": 1,
+                "REQUIRED": 2,
+                "OUTPUT_ONLY": 3,
+                "INPUT_ONLY": 4,
+                "IMMUTABLE": 5,
+                "UNORDERED_LIST": 6,
+                "NON_EMPTY_DEFAULT": 7,
+                "IDENTIFIER": 8
+              }
+            },
             "http": {
               "type": "HttpRule",
               "id": 72295728,
@@ -3375,25 +3485,6 @@
                 "GA": 4,
                 "DEPRECATED": 5
               }
-            },
-            "fieldBehavior": {
-              "rule": "repeated",
-              "type": "google.api.FieldBehavior",
-              "id": 1052,
-              "extend": "google.protobuf.FieldOptions"
-            },
-            "FieldBehavior": {
-              "values": {
-                "FIELD_BEHAVIOR_UNSPECIFIED": 0,
-                "OPTIONAL": 1,
-                "REQUIRED": 2,
-                "OUTPUT_ONLY": 3,
-                "INPUT_ONLY": 4,
-                "IMMUTABLE": 5,
-                "UNORDERED_LIST": 6,
-                "NON_EMPTY_DEFAULT": 7,
-                "IDENTIFIER": 8
-              }
             }
           }
         }

package/build/src/index.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2024 Google LLC
+// Copyright 2025 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

package/build/src/v2/gapic_metadata.json

@@ -0,0 +1,38 @@
+{
+    "schema": "1.0",
+    "comment": "This file maps proto services/RPCs to the corresponding library clients/methods",
+    "language": "typescript",
+    "protoPackage": "google.maps.routing.v2",
+    "libraryPackage": "@googlemaps/routing",
+    "services": {
+        "Routes": {
+            "clients": {
+                "grpc": {
+                    "libraryClient": "RoutesClient",
+                    "rpcs": {
+                        "ComputeRoutes": {
+                            "methods": [
+                                "computeRoutes"
+                            ]
+                        },
+                        "ComputeRouteMatrix": {
+                            "methods": [
+                                "computeRouteMatrix"
+                            ]
+                        }
+                    }
+                },
+                "grpc-fallback": {
+                    "libraryClient": "RoutesClient",
+                    "rpcs": {
+                        "ComputeRoutes": {
+                            "methods": [
+                                "computeRoutes"
+                            ]
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

package/build/src/v2/index.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2024 Google LLC
+// Copyright 2025 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

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

@@ -16,6 +16,7 @@ export declare class RoutesClient {
     private _defaults;
     private _universeDomain;
     private _servicePath;
+    private _log;
     auth: gax.GoogleAuth;
     descriptors: Descriptors;
     warn: (code: string, message: string, warnType?: string) => void;
@@ -47,7 +48,7 @@ export declare class RoutesClient {
      *     Developer's Console, e.g. 'grape-spaceship-123'. We will also check
      *     the environment variable GCLOUD_PROJECT for your project ID. If your
      *     app is running in an environment which supports
-     *     {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
+     *     {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
      *     your project ID will be detected automatically.
      * @param {string} [options.apiEndpoint] - The domain name of the
      *     API remote host.
@@ -225,7 +226,10 @@ export declare class RoutesClient {
      *   request in addition to the default route. A reference route is a route with
      *   a different route calculation objective than the default route. For example
      *   a `FUEL_EFFICIENT` reference route calculation takes into account various
-     *   parameters that would generate an optimal fuel efficient route.
+     *   parameters that would generate an optimal fuel efficient route. When using
+     *   this feature, look for
+     *   {@link protos.google.maps.routing.v2.Route.route_labels|`route_labels`} on the
+     *   resulting routes.
      * @param {number[]} [request.extraComputations]
      *   Optional. A list of extra computations which may be used to complete the
      *   request. Note: These extra computations may return extra fields on the

package/build/src/v2/routes_client.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2024 Google LLC
+// Copyright 2025 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -20,6 +20,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RoutesClient = void 0;
 const stream_1 = require("stream");
 const jsonProtos = require("../../protos/protos.json");
+const google_gax_1 = require("google-gax");
 /**
  * Client JSON configuration object, loaded from
  * `src/v2/routes_client_config.json`.
@@ -33,6 +34,26 @@ const version = require('../../../package.json').version;
  * @memberof v2
  */
 class RoutesClient {
+    _terminated = false;
+    _opts;
+    _providedCustomServicePath;
+    _gaxModule;
+    _gaxGrpc;
+    _protos;
+    _defaults;
+    _universeDomain;
+    _servicePath;
+    _log = google_gax_1.loggingUtils.log('routing');
+    auth;
+    descriptors = {
+        page: {},
+        stream: {},
+        longrunning: {},
+        batching: {},
+    };
+    warn;
+    innerApiCalls;
+    routesStub;
     /**
      * Construct an instance of RoutesClient.
      *
@@ -55,7 +76,7 @@ class RoutesClient {
      *     Developer's Console, e.g. 'grape-spaceship-123'. We will also check
      *     the environment variable GCLOUD_PROJECT for your project ID. If your
      *     app is running in an environment which supports
-     *     {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
+     *     {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
      *     your project ID will be detected automatically.
      * @param {string} [options.apiEndpoint] - The domain name of the
      *     API remote host.
@@ -73,32 +94,28 @@ class RoutesClient {
      *     ```
      */
     constructor(opts, gaxInstance) {
-        var _a, _b, _c, _d, _e;
-        this._terminated = false;
-        this.descriptors = {
-            page: {},
-            stream: {},
-            longrunning: {},
-            batching: {},
-        };
         // Ensure that options include all the required fields.
         const staticMembers = this.constructor;
-        if ((opts === null || opts === void 0 ? void 0 : opts.universe_domain) &&
-            (opts === null || opts === void 0 ? void 0 : opts.universeDomain) &&
-            (opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== (opts === null || opts === void 0 ? void 0 : opts.universeDomain)) {
+        if (opts?.universe_domain &&
+            opts?.universeDomain &&
+            opts?.universe_domain !== opts?.universeDomain) {
             throw new Error('Please set either universe_domain or universeDomain, but not both.');
         }
         const universeDomainEnvVar = typeof process === 'object' && typeof process.env === 'object'
             ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN']
             : undefined;
         this._universeDomain =
-            (_c = (_b = (_a = opts === null || opts === void 0 ? void 0 : opts.universeDomain) !== null && _a !== void 0 ? _a : opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== null && _b !== void 0 ? _b : universeDomainEnvVar) !== null && _c !== void 0 ? _c : 'googleapis.com';
+            opts?.universeDomain ??
+                opts?.universe_domain ??
+                universeDomainEnvVar ??
+                'googleapis.com';
         this._servicePath = 'routes.' + this._universeDomain;
-        const servicePath = (opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint) || this._servicePath;
-        this._providedCustomServicePath = !!((opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint));
-        const port = (opts === null || opts === void 0 ? void 0 : opts.port) || staticMembers.port;
-        const clientConfig = (_d = opts === null || opts === void 0 ? void 0 : opts.clientConfig) !== null && _d !== void 0 ? _d : {};
-        const fallback = (_e = opts === null || opts === void 0 ? void 0 : opts.fallback) !== null && _e !== void 0 ? _e : (typeof window !== 'undefined' && typeof (window === null || window === void 0 ? void 0 : window.fetch) === 'function');
+        const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
+        this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
+        const port = opts?.port || staticMembers.port;
+        const clientConfig = opts?.clientConfig ?? {};
+        const fallback = opts?.fallback ??
+            (typeof window !== 'undefined' && typeof window?.fetch === 'function');
         opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
         // Request numeric enum values if REST transport is used.
         opts.numericEnums = true;
@@ -188,7 +205,7 @@ class RoutesClient {
             const callPromise = this.routesStub.then(stub => (...args) => {
                 if (this._terminated) {
                     if (methodName in this.descriptors.stream) {
-                        const stream = new stream_1.PassThrough();
+                        const stream = new stream_1.PassThrough({ objectMode: true });
                         setImmediate(() => {
                             stream.emit('error', new this._gaxModule.GoogleError('The client has already been closed.'));
                         });
@@ -281,7 +298,19 @@ class RoutesClient {
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
         this.initialize();
-        return this.innerApiCalls.computeRoutes(request, options, callback);
+        this._log.info('computeRoutes request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('computeRoutes response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .computeRoutes(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('computeRoutes response %j', response);
+            return [response, options, rawResponse];
+        });
     }
     /**
      * Takes in a list of origins and destinations and returns a stream containing
@@ -407,6 +436,7 @@ class RoutesClient {
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
         this.initialize();
+        this._log.info('computeRouteMatrix stream %j', options);
         return this.innerApiCalls.computeRouteMatrix(request, options);
     }
     /**
@@ -418,6 +448,7 @@ class RoutesClient {
     close() {
         if (this.routesStub && !this._terminated) {
             return this.routesStub.then(stub => {
+                this._log.info('ending gRPC channel');
                 this._terminated = true;
                 stub.close();
             });

package/build/src/v2/routes_proto_list.json

@@ -0,0 +1,27 @@
+[
+    "../../protos/google/geo/type/viewport.proto",
+    "../../protos/google/maps/routing/v2/fallback_info.proto",
+    "../../protos/google/maps/routing/v2/geocoding_results.proto",
+    "../../protos/google/maps/routing/v2/localized_time.proto",
+    "../../protos/google/maps/routing/v2/location.proto",
+    "../../protos/google/maps/routing/v2/maneuver.proto",
+    "../../protos/google/maps/routing/v2/navigation_instruction.proto",
+    "../../protos/google/maps/routing/v2/polyline.proto",
+    "../../protos/google/maps/routing/v2/polyline_details.proto",
+    "../../protos/google/maps/routing/v2/route.proto",
+    "../../protos/google/maps/routing/v2/route_label.proto",
+    "../../protos/google/maps/routing/v2/route_modifiers.proto",
+    "../../protos/google/maps/routing/v2/route_travel_mode.proto",
+    "../../protos/google/maps/routing/v2/routes_service.proto",
+    "../../protos/google/maps/routing/v2/routing_preference.proto",
+    "../../protos/google/maps/routing/v2/speed_reading_interval.proto",
+    "../../protos/google/maps/routing/v2/toll_info.proto",
+    "../../protos/google/maps/routing/v2/toll_passes.proto",
+    "../../protos/google/maps/routing/v2/traffic_model.proto",
+    "../../protos/google/maps/routing/v2/transit.proto",
+    "../../protos/google/maps/routing/v2/transit_preferences.proto",
+    "../../protos/google/maps/routing/v2/units.proto",
+    "../../protos/google/maps/routing/v2/vehicle_emission_type.proto",
+    "../../protos/google/maps/routing/v2/vehicle_info.proto",
+    "../../protos/google/maps/routing/v2/waypoint.proto"
+]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@googlemaps/routing",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "description": " client for Node.js",
   "repository": {
     "type": "git",
@@ -46,26 +46,26 @@
     "test": "c8 mocha build/test"
   },
   "dependencies": {
-    "google-gax": "^4.0.3"
+    "google-gax": "^5.0.0-rc.0"
   },
   "devDependencies": {
-    "@types/mocha": "^9.0.0",
-    "@types/node": "^20.4.5",
-    "@types/sinon": "^17.0.0",
-    "c8": "^9.0.0",
-    "gapic-tools": "^0.4.0",
-    "gts": "^5.0.0",
-    "jsdoc": "^4.0.0",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^22.13.9",
+    "@types/sinon": "^17.0.4",
+    "c8": "^10.1.3",
+    "gapic-tools": "^1.0.0",
+    "gts": "^6.0.2",
+    "jsdoc": "^4.0.4",
     "jsdoc-fresh": "^3.0.0",
     "jsdoc-region-tag": "^3.0.0",
-    "linkinator": "4.1.2",
-    "long": "^5.2.3",
-    "mocha": "^9.2.2",
-    "pack-n-play": "^2.0.0",
-    "sinon": "^17.0.0",
-    "typescript": "^5.1.6"
+    "linkinator": "^6.1.2",
+    "long": "^5.3.1",
+    "mocha": "^11.1.0",
+    "pack-n-play": "^3.0.0",
+    "sinon": "^19.0.2",
+    "typescript": "^5.8.2"
   },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=18"
   }
 }