apple-maps-server-sdk 1.1.2 → 1.1.3

package/src/globals.ts

@@ -1,146 +1,145 @@
-// OBJECTS
-type PoiCategory =
-  | "Airport"
-  | "AirportGate"
-  | "AirportTerminal"
-  | "AmusementPark"
-  | "ATM"
-  | "Aquarium"
-  | "Bakery"
-  | "Bank"
-  | "Beach"
-  | "Brewery"
-  | "Cafe"
-  | "Campground"
-  | "CarRental"
-  | "EVCharger"
-  | "FireStation"
-  | "FitnessCenter"
-  | "FoodMarket"
-  | "GasStation"
-  | "Hospital"
-  | "Hotel"
-  | "Laundry"
-  | "Library"
-  | "Marina"
-  | "MovieTheater"
-  | "Museum"
-  | "NationalPark"
-  | "Nightlife"
-  | "Park"
-  | "Parking"
-  | "Pharmacy"
-  | "Playground"
-  | "Police"
-  | "PostOffice"
-  | "PublicTransport"
-  | "ReligiousSite"
-  | "Restaurant"
-  | "Restroom"
-  | "School"
-  | "Stadium"
-  | "Store"
-  | "Theater"
-  | "University"
-  | "Winery"
-  | "Zoo";
-
-type TransportType = "Automobile" | "Transit" | "Walking";
-
-interface Location {
-  latitude: number;
-  longitude: number;
-}
-
-interface MapRegion {
-  eastLongitude: number;
-  northLatitude: number;
-  southLatitude: number;
-  westLongitude: number;
-}
-
-interface StructuredAddress {
-  administrativeArea: string;
-  administrativeAreaCode: string;
-  areasOfInterest: string[];
-  dependentLocalities: string[];
-  fullThoroughfare: string;
-  locality: string;
-  postCode: string;
-  subLocality: string;
-  subThoroughfare: string;
-  thoroughfare: string;
-}
-
-interface Place {
-  country: string;
-  countryCode: string;
-  displayMapRegion: MapRegion;
-  formattedAddressLines: string[];
-  name: string;
-  coordinate: Location;
-  structuredAddress: StructuredAddress;
-}
-
-interface ETA {
-  destination: Location;
-  distanceMeters: number;
-  expectedTravelTimeSeconds: number;
-  staticTravelTimeSeconds: number;
-  transportType: TransportType;
-}
-
-interface SearchResponsePlace extends Place {
-  poiCategory: PoiCategory;
-}
-
-export interface GeocodeInput {
-  q: string;
-  limitToCountries?: string[];
-  lang?: string;
-  searchLocation?: string;
-  searchRegion?: string;
-  userLocation?: string;
-}
-
-export interface ReverseGeocodeInput {
-  loc: string;
-  lang?: string;
-}
-
-export interface ETAInput {
-  origin: string;
-  destinations: string[];
-  transportType?: TransportType;
-  departureDate?: string;
-  arrivalDate?: string;
-}
-
-export interface SearchInput {
-  q: string;
-  excludePoiCategories?: PoiCategory[];
-  includePoiCategories?: PoiCategory[];
-  limitToCountries?: string[];
-  resultTypeFilter?: "Poi" | "Address";
-  lang?: string;
-  searchLocation?: string;
-  searchRegion?: string;
-  userLocation?: string;
-}
-
-export interface GeocodeResponse {
-  results: Place[];
-}
-
-export interface ReverseGeocodeResponse {
-  results: Place[];
-}
-
-export interface ETAResponse {
-  etas: ETA[];
-}
-
-export interface SearchResponse {
-  displayMapRegion: MapRegion;
-  results: SearchResponsePlace[];
-}
+type PoiCategory =
+  | "Airport"
+  | "AirportGate"
+  | "AirportTerminal"
+  | "AmusementPark"
+  | "ATM"
+  | "Aquarium"
+  | "Bakery"
+  | "Bank"
+  | "Beach"
+  | "Brewery"
+  | "Cafe"
+  | "Campground"
+  | "CarRental"
+  | "EVCharger"
+  | "FireStation"
+  | "FitnessCenter"
+  | "FoodMarket"
+  | "GasStation"
+  | "Hospital"
+  | "Hotel"
+  | "Laundry"
+  | "Library"
+  | "Marina"
+  | "MovieTheater"
+  | "Museum"
+  | "NationalPark"
+  | "Nightlife"
+  | "Park"
+  | "Parking"
+  | "Pharmacy"
+  | "Playground"
+  | "Police"
+  | "PostOffice"
+  | "PublicTransport"
+  | "ReligiousSite"
+  | "Restaurant"
+  | "Restroom"
+  | "School"
+  | "Stadium"
+  | "Store"
+  | "Theater"
+  | "University"
+  | "Winery"
+  | "Zoo";
+
+type TransportType = "Automobile" | "Transit" | "Walking";
+
+interface Location {
+  latitude: number;
+  longitude: number;
+}
+
+interface MapRegion {
+  eastLongitude: number;
+  northLatitude: number;
+  southLatitude: number;
+  westLongitude: number;
+}
+
+interface StructuredAddress {
+  administrativeArea: string;
+  administrativeAreaCode: string;
+  areasOfInterest: string[];
+  dependentLocalities: string[];
+  fullThoroughfare: string;
+  locality: string;
+  postCode: string;
+  subLocality: string;
+  subThoroughfare: string;
+  thoroughfare: string;
+}
+
+interface Place {
+  country: string;
+  countryCode: string;
+  displayMapRegion: MapRegion;
+  formattedAddressLines: string[];
+  name: string;
+  coordinate: Location;
+  structuredAddress: StructuredAddress;
+}
+
+interface ETA {
+  destination: Location;
+  distanceMeters: number;
+  expectedTravelTimeSeconds: number;
+  staticTravelTimeSeconds: number;
+  transportType: TransportType;
+}
+
+interface SearchResponsePlace extends Place {
+  poiCategory: PoiCategory;
+}
+
+export interface GeocodeInput {
+  q: string;
+  limitToCountries?: string[];
+  lang?: string;
+  searchLocation?: string;
+  searchRegion?: string;
+  userLocation?: string;
+}
+
+export interface ReverseGeocodeInput {
+  loc: string;
+  lang?: string;
+}
+
+export interface ETAInput {
+  origin: string;
+  destinations: string[];
+  transportType?: TransportType;
+  departureDate?: string;
+  arrivalDate?: string;
+}
+
+export interface SearchInput {
+  q: string;
+  excludePoiCategories?: PoiCategory[];
+  includePoiCategories?: PoiCategory[];
+  limitToCountries?: string[];
+  resultTypeFilter?: "Poi" | "Address";
+  lang?: string;
+  searchLocation?: string;
+  searchRegion?: string;
+  userLocation?: string;
+}
+
+export interface GeocodeResponse {
+  results: Place[];
+}
+
+export interface ReverseGeocodeResponse {
+  results: Place[];
+}
+
+export interface ETAResponse {
+  etas: ETA[];
+}
+
+export interface SearchResponse {
+  displayMapRegion: MapRegion;
+  results: SearchResponsePlace[];
+}

package/src/index.ts

@@ -1,161 +1,147 @@
-import axios, { AxiosError, AxiosInstance } from "axios";
-import {
-  GeocodeInput,
-  GeocodeResponse,
-  ReverseGeocodeInput,
-  ReverseGeocodeResponse,
-  ETAInput,
-  ETAResponse,
-  SearchInput,
-  SearchResponse,
-} from "./globals";
-
-class AppleMaps {
-  accessToken: string;
-  authorizationToken: string;
-  accessTokenRetries: number;
-  apiClient: AxiosInstance;
-
-  constructor({ authorizationToken }: { authorizationToken: string }) {
-    this.accessToken = "";
-    this.accessTokenRetries = 0;
-    this.authorizationToken = authorizationToken;
-
-    if (!authorizationToken) {
-      throw new Error("'authorizationToken' param is required");
-    }
-
-    this.apiClient = axios.create({
-      baseURL: "https://maps-api.apple.com/v1",
-    });
-
-    this.getAccessToken();
-  }
-
-  async getAccessToken(): Promise<undefined> {
-    try {
-      const response = await this.apiClient.get("/token", {
-        headers: {
-          Authorization: `Bearer ${this.authorizationToken}`,
-        },
-      });
-
-      this.accessToken = response.data.accessToken;
-    } catch (error) {
-      throw error;
-    }
-
-    return;
-  }
-
-  async geocode(input: GeocodeInput): Promise<GeocodeResponse> {
-    try {
-      const response = await this.apiClient.get("/geocode", {
-        headers: {
-          Authorization: `Bearer ${this.accessToken}`,
-        },
-        params: input,
-      });
-
-      return response.data;
-    } catch (error) {
-      if (error instanceof AxiosError) {
-        if (error.response?.status === 401) {
-          if (this.accessTokenRetries > 3) {
-            throw new Error("Unable to get access token");
-          }
-
-          this.accessTokenRetries++;
-
-          await this.getAccessToken();
-          return this.geocode(input);
-        } else {
-          throw error;
-        }
-      } else throw error;
-    }
-  }
-
-  async reverseGeocode(input: ReverseGeocodeInput): Promise<ReverseGeocodeResponse> {
-    try {
-      const response = await this.apiClient.get("/reverseGeocode", {
-        headers: {
-          Authorization: `Bearer ${this.accessToken}`,
-        },
-        params: input,
-      });
-
-      return response.data;
-    } catch (error) {
-      if (error instanceof AxiosError) {
-        if (error.response?.status === 401) {
-          if (this.accessTokenRetries > 3) {
-            throw new Error("Unable to get access token");
-          }
-
-          this.accessTokenRetries++;
-          await this.getAccessToken();
-          return this.reverseGeocode(input);
-        } else {
-          throw error.response?.data;
-        }
-      } else throw error;
-    }
-  }
-
-  async eta(input: ETAInput): Promise<ETAResponse> {
-    try {
-      const response = await this.apiClient.get("/etas", {
-        headers: {
-          Authorization: `Bearer ${this.accessToken}`,
-        },
-        params: input,
-      });
-
-      return response.data;
-    } catch (error) {
-      if (error instanceof AxiosError) {
-        if (error.response?.status === 401) {
-          if (this.accessTokenRetries > 3) {
-            throw new Error("Unable to get access token");
-          }
-
-          this.accessTokenRetries++;
-          await this.getAccessToken();
-          return this.eta(input);
-        } else {
-          throw error.response?.data;
-        }
-      } else throw error;
-    }
-  }
-
-  async search(input: SearchInput): Promise<SearchResponse> {
-    try {
-      const response = await this.apiClient.get("/search", {
-        headers: {
-          Authorization: `Bearer ${this.accessToken}`,
-        },
-        params: input,
-      });
-
-      return response.data;
-    } catch (error) {
-      if (error instanceof AxiosError) {
-        if (error.response?.status === 401) {
-          if (this.accessTokenRetries > 3) {
-            throw new Error("Unable to get access token");
-          }
-
-          this.accessTokenRetries++;
-          await this.getAccessToken();
-          return this.search(input);
-        } else {
-          throw error.response?.data;
-        }
-      } else throw error;
-    }
-  }
-}
-
-export default AppleMaps;
+import axios, { AxiosError, AxiosInstance } from "axios";
+
+import {
+  GeocodeInput,
+  GeocodeResponse,
+  ReverseGeocodeInput,
+  ReverseGeocodeResponse,
+  ETAInput,
+  ETAResponse,
+  SearchInput,
+  SearchResponse,
+} from "./globals";
+
+class AppleMaps {
+  accessToken: string;
+  authorizationToken: string;
+  accessTokenRetries: number;
+  apiClient: AxiosInstance;
+
+  constructor({ authorizationToken }: { authorizationToken: string }) {
+    this.accessToken = "";
+    this.accessTokenRetries = 0;
+    this.authorizationToken = authorizationToken;
+
+    if (!authorizationToken) {
+      throw new Error("'authorizationToken' param is required");
+    }
+
+    this.apiClient = axios.create({
+      baseURL: "https://maps-api.apple.com/v1",
+    });
+
+    this.getAccessToken();
+  }
+
+  /**
+   * Take an authorization token and fetch an access token from apples servers
+   */
+  private async getAccessToken(): Promise<undefined> {
+    try {
+      const response = await this.apiClient.get("/token", {
+        headers: {
+          Authorization: `Bearer ${this.authorizationToken}`,
+        },
+      });
+
+      this.accessToken = response.data.accessToken;
+    } catch (error) {
+      throw error;
+    }
+
+    return;
+  }
+
+  private async handleError<T>(err: unknown, callback: () => Promise<T>) {
+    if (err instanceof AxiosError) {
+      if (err.response?.status === 401) {
+        if (this.accessTokenRetries > 3) {
+          throw new Error("Unable to get access token");
+        }
+
+        this.accessTokenRetries++;
+
+        await this.getAccessToken();
+        return callback();
+      }
+    }
+
+    throw err;
+  }
+
+  /**
+   * Returns the latitude and longitude of the address you specify.
+   */
+  public async geocode(input: GeocodeInput): Promise<GeocodeResponse> {
+    try {
+      const response = await this.apiClient.get("/geocode", {
+        headers: {
+          Authorization: `Bearer ${this.accessToken}`,
+        },
+        params: input,
+      });
+
+      return response.data;
+    } catch (error) {
+      return this.handleError(error, () => this.geocode(input));
+    }
+  }
+
+  /**
+   * Returns an array of addresses present at the coordinates you provide.
+   */
+  public async reverseGeocode(
+    input: ReverseGeocodeInput
+  ): Promise<ReverseGeocodeResponse> {
+    try {
+      const response = await this.apiClient.get("/reverseGeocode", {
+        headers: {
+          Authorization: `Bearer ${this.accessToken}`,
+        },
+        params: input,
+      });
+
+      return response.data;
+    } catch (error) {
+      return this.handleError(error, () => this.reverseGeocode(input));
+    }
+  }
+
+  /**
+   * Returns the estimated time of arrival (ETA) and distance between starting and ending locations.
+   */
+  public async eta(input: ETAInput): Promise<ETAResponse> {
+    try {
+      const response = await this.apiClient.get("/etas", {
+        headers: {
+          Authorization: `Bearer ${this.accessToken}`,
+        },
+        params: input,
+      });
+
+      return response.data;
+    } catch (error) {
+      return this.handleError(error, () => this.eta(input));
+    }
+  }
+
+  /**
+   * Find places by name or by specific search criteria.
+   */
+  public async search(input: SearchInput): Promise<SearchResponse> {
+    try {
+      const response = await this.apiClient.get("/search", {
+        headers: {
+          Authorization: `Bearer ${this.accessToken}`,
+        },
+        params: input,
+      });
+
+      return response.data;
+    } catch (error) {
+      return this.handleError(error, () => this.search(input));
+    }
+  }
+}
+
+export default AppleMaps;

package/tsconfig.json

@@ -1,13 +1,13 @@
-{
-  "compilerOptions": {
-    "target": "ES6",
-    "module": "commonjs",
-    "declaration": true,
-    "outDir": "./lib",
-    "strict": true,
-    "esModuleInterop": true,
-    
-  },
-  "include": ["src"],
-  "exclude": ["node_modules", "**/__tests__/*"]
+{
+  "compilerOptions": {
+    "target": "ES6",
+    "module": "commonjs",
+    "declaration": true,
+    "outDir": "./lib",
+    "strict": true,
+    "esModuleInterop": true,
+    
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "**/__tests__/*"]
 }