2026-08-08 updates

.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+name: "CI"
+on: [push]
+
+jobs:
+  build:
+    name: Build and Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Setup Node
+        uses: actions/setup-node@v5
+        with:
+          node-version: 24
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Test
+        run: npm test
+
+  matrix-tests:
+    name: Test Node versions
+    runs-on: ubuntu-latest
+    needs: build
+    strategy:
+      matrix:
+        node_version: [18, 20, 22, 24]
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Setup Node
+        uses: actions/setup-node@v5
+        with:
+          node-version: ${{ matrix.node_version }}
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Test
+        run: npm test
+
+  integration-tests:
+    name: Integration Tests
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Setup Node
+        uses: actions/setup-node@v5
+        with:
+          node-version: 24
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Integration Test
+        run: npm run integration-test
+        env:
+          GOOGLE_MAPS_API_KEY: ${{ secrets.GOOGLE_MAPS_API_KEY }}

.gitignore

@@ -1,2 +1,4 @@
 node_modules
-npm-debug.log
+npm-debug.log
+test/simpleConfig.json
+.env

README.md

@@ -1,7 +1,9 @@
-[![Build Status](https://travis-ci.org/moshen/node-googlemaps.svg?branch=master)](https://travis-ci.org/moshen/node-googlemaps)
+[![CI](https://github.com/moshen/node-googlemaps/actions/workflows/ci.yml/badge.svg)](https://github.com/moshen/node-googlemaps/actions/workflows/ci.yml)
 
 # Google Maps API for Node.js
 
+> **DEPRECATED:** This package is no longer maintained. Please use Google's official Node.js client library [`@googlemaps/google-maps-services-js`](https://github.com/googlemaps/google-maps-services-js) instead.
+
 This library implements the following Google Maps APIs, and can be also used by Google Maps for Work users.
 
 * [Maps API Web Services](https://developers.google.com/maps/documentation/webservices/)
@@ -67,7 +69,7 @@ var gmAPI = new GoogleMapsAPI(enterpriseConfig);
 // geocode API
 var geocodeParams = {
   "address":    "121, Curtain Road, EC2A 3AD, London UK",
-  "components": "components=country:GB",
+  "components": "country:GB",
   "bounds":     "55,-1|54,1",
   "language":   "en",
   "region":     "uk"
@@ -92,6 +94,34 @@ gmAPI.reverseGeocode(reverseGeocodeParams, function(err, result){
 
 Check out the [unit tests](./tree/new-major-version/test/unit/) for more APIs examples.
 
+### Optional configuration
+
+The following config keys control behavior that was added as bug fixes but
+could break existing callers. Each defaults to the old (pre-fix) behavior
+so existing code keeps working unless you opt in.
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| `static_map_binary` | boolean | `false` | When `true`, `staticMap` returns image data as a `Buffer` instead of a string. Use this if you save the image to a file (the old string output produced unusable files). |
+| `static_map_warnings` | boolean | `false` | When `true`, Google's `X-StaticMap-API-Warning` response header is surfaced as a non-fatal error (`err.isWarning = true`) in the `staticMap` callback, alongside the image data. By default warnings are silently ignored. |
+| `places_default_radius` | boolean | `true` | When `true`, `placeSearch` defaults `radius` to 50000 meters (the max) if omitted and `rankby=prominence`. Set to `false` to omit the radius entirely (Google ranks differently without it). |
+| `google_api_url` | string | `http://maps.googleapis.com` | Override the base API URL forHTTP requests. Useful for mocking in tests. |
+| `google_secure_api_url` | string | `https://maps.googleapis.com` | Override the base API URL for HTTPS requests. |
+
+### Mocking responses
+
+To mock the Google API endpoints for local development or CI, override the
+base URLs in your config:
+
+```javascript
+var config = {
+  key:                  '<YOUR-KEY>',
+  google_api_url:       'http://localhost:3000/fixture',
+  google_secure_api_url: 'https://localhost:3443/fixture'
+};
+var gmAPI = new GoogleMapsAPI(config);
+```
+
 ### Static Maps
 
 ```javascript
@@ -180,6 +210,27 @@ var result = gmAPI.streetView(params);
 Please refer to the code, [tests](http://github.com/moshen/node-googlemaps/tree/master/test/) and the [Google Maps API docs](https://developers.google.com/maps/web-services/) for further usage information.
 
 
+### Tests
+
+The unit tests run offline with no credentials:
+
+```
+npm test
+```
+
+The integration tests make real requests to the Google Maps API and require a
+valid, billing-enabled API key. Provide it via the `GOOGLE_MAPS_API_KEY`
+environment variable (no key is committed to this repository):
+
+```
+GOOGLE_MAPS_API_KEY=your-key-here npm run integration-test
+```
+
+`GOOGLE_MAPS_SECURE` may be set to `false` to use http (defaults to `true` /
+https). For local development you may instead create a git-ignored
+`test/simpleConfig.json` of the form `{"key": "...", "secure": true}`.
+
+
 ### Contributions
 Criticism/Suggestions/Patches/PullRequests are welcome.
 

lib/config/constants.json

@@ -1,12 +1,17 @@
 {
   "ACCEPTED_CONFIG_KEYS": {
-    "encode_polylines":   "boolean",
-    "google_client_id":   "string",
-    "google_channel":     "string",
-    "key":                "string",
-    "proxy":              "string",
-    "secure":             "boolean",
-    "stagger_time":       "number"
+    "encode_polylines":       "boolean",
+    "google_client_id":       "string",
+    "google_channel":         "string",
+    "google_api_url":         "string",
+    "google_secure_api_url":  "string",
+    "key":                    "string",
+    "proxy":                  "string",
+    "secure":                 "boolean",
+    "stagger_time":           "number",
+    "static_map_binary":      "boolean",
+    "static_map_warnings":    "boolean",
+    "places_default_radius":  "boolean"
   },
 
   "ACCEPTED_PARAMS": {
@@ -22,6 +27,7 @@
       "radius":    "number",
       "rankby":    "string",
       "sensor":    "string",
+      "type":      "string",
       "types":     "string"
     },
     "place-search-text": {
@@ -73,6 +79,8 @@
       "language":       "string",
       "avoid":          "string",
       "units":          "string",
+      "transit_mode":          "string",
+      "transit_routing_preference": "string",
       "departure_time": "date",
       "arrival_time":   "date",
       "traffic_model":  "string"
@@ -87,6 +95,8 @@
       "language":       "string",
       "region":         "string",
       "units":          "string",
+      "transit_mode":          "string",
+      "transit_routing_preference": "string",
       "departure_time": "date",
       "arrival_time":   "date",
       "traffic_model":  "string"
@@ -136,7 +146,7 @@
     "place-search-text":   2048,
     "place-autocomplete":  2048,
     "reverse-geocode":     2048,
-    "static-map":          2048,
+    "static-map":          8192,
     "timezone":            2048,
     "street-view":         2048
   },

lib/config/getDefault.js

@@ -4,13 +4,18 @@
  module.exports = function() {
 
   return {
-    encode_polylines: true,
-    google_client_id: null,
-    google_channel:   null,
-    key:              null,
-    proxy:            null,
-    secure:           false,
-    stagger_time:     200,
+    encode_polylines:       true,
+    google_client_id:       null,
+    google_channel:         null,
+    google_api_url:         'http://maps.googleapis.com',
+    google_secure_api_url:  'https://maps.googleapis.com',
+    key:                    null,
+    proxy:                  null,
+    secure:                 false,
+    stagger_time:           200,
+    static_map_binary:      false,
+    static_map_warnings:     false,
+    places_default_radius:   true,
     set google_private_key(value) {
       if (typeof value !== 'undefined' && value !== null) {
         // Google private keys are URL friendly base64, needs to be replaced with base64 valid characters

lib/index.js

@@ -12,6 +12,7 @@ var _makeRequest      = require('./utils/makeRequest');
 var _assignParams     = require('./utils/assignParams');
 var _jsonParser       = require('./utils/jsonParser');
 var _encodePolyline   = require('./utils/encodePolylines');
+var _decodePolyline   = require('./utils/decodePolylines');
 var _getDefaultConfig = require('./config/getDefault');
 var _constants        = require('./config/constants');
 
@@ -243,6 +244,18 @@ GoogleMapsAPI.prototype.checkAndConvertPoint = function(input) {
 };
 
 
+/**
+ * Decodes an encoded polyline string (e.g. from the Directions API
+ * overview_polyline.points field) into an array of [lat, lng] pairs.
+ *
+ * Google documentation reference: https://developers.google.com/maps/documentation/utilities/polylinealgorithm
+ *
+ * var coords = gmAPI.decodePolyline(encoded);
+ * // coords = [[38.5, -120.2], [40.7, -120.95], ...]
+ */
+GoogleMapsAPI.prototype.decodePolyline = _decodePolyline;
+
+
 module.exports = GoogleMapsAPI;
 
 // TODO improve this and move to a separate file

lib/placeSearchNearby.js

@@ -56,7 +56,7 @@ module.exports = function(params, callback) {
       return callback(new Error('If rankby=distance is specified, then one or more of keyword, name, or types is required.'));
     }
     delete args.radius;
-  } else if (args.rankby === PLACES_RANKBY_DEFAULT) {
+  } else if (args.rankby === PLACES_RANKBY_DEFAULT && this.config.places_default_radius) {
     if (args.radius == null) {
       args.radius = MAX_RADIUS;
     }
@@ -80,7 +80,7 @@ module.exports = function(params, callback) {
     }
     if (args.minprice > args.maxprice) {
       var swap = args.maxprice;
-      args.maxprice = ags.minprice;
+      args.maxprice = args.minprice;
       args.minprice = swap;
     }
   }

lib/utils/assignParams.js

@@ -30,7 +30,7 @@ var check = require('check-types');
 
       if (expectedType == 'date') {
 
-        if (check.date(newParams[ key ])) {
+        if (newParams[ key ] === 'now' || check.date(newParams[ key ])) {
           params[ key ] = newParams[ key ];
         }
 

lib/utils/decodePolylines.js

@@ -0,0 +1,51 @@
+/**
+ * Decodes an encoded polyline string into an array of [lat, lng] pairs.
+ *
+ * Algorithm from Google's polyline encoding documentation:
+ * https://developers.google.com/maps/documentation/utilities/polylinealgorithm
+ *
+ * input = '_p~iF~ps|U_ulLnnqC_mqNvxq`@'
+ * output = [[38.5, -120.2], [40.7, -120.95], [43.252, -126.453]]
+ */
+module.exports = function(encoded) {
+
+  if (typeof encoded !== 'string') {
+    throw new Error('Encoded polyline must be a string');
+  }
+
+  var index = 0;
+  var lat = 0;
+  var lng = 0;
+  var coordinates = [];
+
+  while (index < encoded.length) {
+
+    var result = 1;
+    var shift = 0;
+    var b;
+
+    do {
+      b = encoded.charCodeAt(index++) - 63 - 1;
+      result += b << shift;
+      shift += 5;
+    } while (b >= 0x1f);
+
+    lat += (result & 1) ? ~(result >> 1) : (result >> 1);
+
+    result = 1;
+    shift = 0;
+
+    do {
+      b = encoded.charCodeAt(index++) - 63 - 1;
+      result += b << shift;
+      shift += 5;
+    } while (b >= 0x1f);
+
+    lng += (result & 1) ? ~(result >> 1) : (result >> 1);
+
+    coordinates.push([lat / 1e5, lng / 1e5]);
+  }
+
+  return coordinates;
+
+};