fix: serialize date to seconds and not milliseconds (#376)

e2e/timezone.test.ts

@@ -1,9 +1,9 @@
 import { timezone } from "../src/timezone";
 
-test("elevation should call axios correctly", async () => {
+test("elevation should get an ok response", async () => {
   const params = {
-    location: { lat: 35, lng: -110 },
-    timestamp: 0,
+    location: "30, 50",
+    timestamp: new Date(),
     language: "en" as const,
     key: process.env.GOOGLE_MAPS_API_KEY
   };

src/directions.ts

@@ -1,20 +1,21 @@
+import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios";
 import {
   DirectionsRoute,
   GeocodedWaypoint,
-  TrafficModel,
-  TransitRoutingPreference,
-  TravelRestriction,
-  LatLng,
   Language,
-  UnitSystem,
+  LatLng,
+  RequestParams,
+  ResponseData,
+  TrafficModel,
   TransitMode,
+  TransitRoutingPreference,
   TravelMode,
-  ResponseData,
-  RequestParams
+  TravelRestriction,
+  UnitSystem
 } from "./common";
-import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios";
+import { latLngToString, serializer, toTimestamp } from "./serialize";
+
 import { defaultAxiosInstance } from "./client";
-import { serializer, latLngToString } from "./serialize";
 
 export interface DirectionsRequest extends Partial<AxiosRequestConfig> {
   params: {
@@ -176,8 +177,8 @@ export const defaultParamsSerializer = serializer({
   origin: latLngToString,
   destination: latLngToString,
   waypoints: o => o.map(latLngToString),
-  arrival_time: Number,
-  departure_time: Number
+  arrival_time: toTimestamp,
+  departure_time: toTimestamp
 });
 
 export function directions(

src/distance.ts

@@ -1,18 +1,19 @@
+import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios";
 import {
   DistanceMatrixRow,
-  TrafficModel,
-  TransitRoutingPreference,
-  TravelRestriction,
   LatLng,
-  UnitSystem,
+  RequestParams,
+  ResponseData,
+  TrafficModel,
   TransitMode,
+  TransitRoutingPreference,
   TravelMode,
-  ResponseData,
-  RequestParams
+  TravelRestriction,
+  UnitSystem
 } from "./common";
-import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios";
+import { latLngToString, serializer, toTimestamp } from "./serialize";
+
 import { defaultAxiosInstance } from "./client";
-import { serializer, latLngToString } from "./serialize";
 
 export interface DistanceMatrixRequest extends Partial<AxiosRequestConfig> {
   params: {
@@ -155,8 +156,8 @@ export const defaultUrl =
 export const defaultParamsSerializer = serializer({
   origins: o => o.map(latLngToString),
   destinations: o => o.map(latLngToString),
-  arrival_time: Number,
-  departure_time: Number
+  arrival_time: toTimestamp,
+  departure_time: toTimestamp
 });
 
 export function distancematrix(

src/serialize.test.ts

@@ -1,12 +1,13 @@
+import { LatLng, LatLngLiteral } from "./common";
 import {
+  latLngArrayToStringMaybeEncoded,
+  latLngBoundsToString,
   latLngToString,
-  serializer,
   objectToString,
-  latLngBoundsToString,
-  latLngArrayToStringMaybeEncoded,
-  toLatLngLiteral
+  serializer,
+  toLatLngLiteral,
+  toTimestamp
 } from "./serialize";
-import { LatLngLiteral, LatLng } from "./common";
 
 test("latLngToString is correct", () => {
   expect(latLngToString("")).toBe("");
@@ -78,3 +79,13 @@ test("toLatLngLiteral", () => {
     toLatLngLiteral({} as LatLngLiteral);
   }).toThrow(TypeError);
 });
+
+test("toTimestamp", () => {
+  expect(toTimestamp(100)).toEqual(100);
+
+  const dt = new Date();
+  const seconds = Number(dt) / 1000
+  expect(toTimestamp(dt)).toEqual(seconds);
+
+});
+

src/serialize.ts

@@ -1,6 +1,7 @@
 import { LatLng, LatLngBounds, LatLngLiteral } from "./common";
-import { stringify as qs } from "query-string";
+
 import { encodePath } from "./util";
+import { stringify as qs } from "query-string";
 
 const separator = "|";
 
@@ -96,3 +97,10 @@ export function serializer(
     return qs(params, queryStringOptions);
   };
 }
+
+export function toTimestamp(o: number | Date) {
+  if (o instanceof Date) {
+    return Number(o) / 1000;
+  }
+  return o
+}

src/timezone.test.ts

@@ -1,5 +1,6 @@
+import { defaultParamsSerializer, defaultUrl, timezone } from "./timezone";
+
 import axios from "axios";
-import { timezone, defaultParamsSerializer, defaultUrl } from "./timezone";
 
 jest.mock("axios");
 
@@ -25,3 +26,8 @@ test("elevation should call axios correctly", () => {
     url: defaultUrl
   });
 });
+
+test("serializer should handle date object", () => {
+  const dt = new Date();
+  expect(defaultParamsSerializer({timestamp: dt})).toEqual(`timestamp=${Number(dt)/1000}`)
+});

src/timezone.ts

@@ -1,7 +1,8 @@
-import { LatLng, Language, ResponseData, RequestParams } from "./common";
 import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios";
+import { Language, LatLng, RequestParams, ResponseData } from "./common";
+import { latLngToString, serializer, toTimestamp } from "./serialize";
+
 import { defaultAxiosInstance } from "./client";
-import { serializer, latLngToString } from "./serialize";
 
 export interface TimeZoneRequest extends Partial<AxiosRequestConfig> {
   params: {
@@ -55,7 +56,7 @@ export interface TimeZoneResponse extends AxiosResponse {
 
 export const defaultUrl = "https://maps.googleapis.com/maps/api/timezone/json";
 export const defaultParamsSerializer = serializer({
-  timestamp: Number,
+  timestamp: toTimestamp,
   location: latLngToString
 });
 export function timezone(