[TT-7263] Make peer dependencies 'cross-fetch' and 'axios' optional (#47)

* Attempt to use optional deps by providing transport instead of transport name

* [fix] Make peer dependencies optional

* [fix] further modular require improvements

* [mod] bump to prod version

Co-authored-by: Frances Downey <frances@what3words.com>

Author: c5haw

.gitignore

@@ -206,4 +206,7 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
-# End of https://www.toptal.com/developers/gitignore/api/node,macos,windows,visualstudiocode
+# End of https://www.toptal.com/developers/gitignore/api/node,macos,windows,visualstudiocode
+
+# Snyk cacke
+.dccache

package-lock.json

@@ -1,7 +1,7 @@
 {
   "private": false,
   "name": "@what3words/api",
-  "version": "4.0.5",
+  "version": "4.0.6",
   "description": "what3words JavaScript API",
   "homepage": "https://github.com/what3words/w3w-node-wrapper#readme",
   "main": "dist/index.js",
@@ -27,6 +27,14 @@
     "axios": "^0.21.2",
     "cross-fetch": "^3.1.5"
   },
+  "peerDependenciesMeta": {
+    "axios": {
+      "optional": true
+    },
+    "cross-fetch": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "^1.0.1",
     "@testing-library/react": "^12.1.3",

package.json

@@ -1,9 +1,10 @@
-import axios from 'axios';
+import { AxiosResponse } from 'axios';
 import type { Transport, TransportResponse } from './model';
 import { ClientRequest } from '../client';
 import { errorHandler } from './error';
 
 export function axiosTransport(): Transport {
+  const axios = require('axios');
   return async function axiosTransport<T>(
     req: ClientRequest
   ): Promise<TransportResponse<T>> {
@@ -16,7 +17,7 @@ export function axiosTransport(): Transport {
       params,
     };
     return await axios(options)
-      .then(res => {
+      .then((res: AxiosResponse) => {
         const response = errorHandler({
           status: res.status,
           statusText: res.statusText,
@@ -25,7 +26,7 @@ export function axiosTransport(): Transport {
         });
         return response;
       })
-      .catch(err => {
+      .catch((err: any) => {
         if (err.isAxiosError)
           errorHandler<T>({
             status: err.response?.status || err.status || 500,

src/lib/transport/axios.ts

@@ -1,10 +1,10 @@
-import fetch from 'cross-fetch';
 import type { Transport, TransportResponse } from './model';
 import { ClientRequest } from '../client';
 import { errorHandler } from './error';
 import { searchParams } from '../serializer';
 
 export function fetchTransport(): Transport {
+  const fetch = require('cross-fetch');
   return async function fetchTransport<T>(
     req: ClientRequest
   ): Promise<TransportResponse<T>> {

src/lib/transport/fetch.ts

@@ -2,4 +2,3 @@ export * from './axios';
 export * from './error';
 export * from './fetch';
 export * from './model';
-export * from './parse';

src/lib/transport/index.ts

@@ -18,7 +18,7 @@ import type {
   LocationGeoJsonResponse,
   LocationJsonResponse,
 } from './client';
-import { ApiClientConfiguration, getTransport } from './lib';
+import { ApiClientConfiguration } from './lib';
 import type { Transport } from './lib';
 
 export type What3wordsService = {
@@ -48,9 +48,9 @@ export type What3wordsService = {
 export function what3words(
   apiKey?: string,
   config?: ApiClientConfiguration,
-  opts?: { transport: 'fetch' | 'axios' | Transport }
+  opts?: { transport: Transport }
 ): What3wordsService {
-  const transport = getTransport(opts?.transport);
+  const transport = opts?.transport || require('./lib').fetchTransport();
   const autosuggestClient = new AutosuggestClient(apiKey, config, transport);
   const availableLanguagesClient = new AvailableLanguagesClient(
     apiKey,

src/lib/transport/parse.ts

@@ -5,6 +5,7 @@ import what3words, {
   ApiClientConfiguration,
   ApiVersion,
   searchParams,
+  axiosTransport,
 } from '../src';
 import { What3wordsService } from '../src/service';
 
@@ -120,7 +121,7 @@ describe('what3words', () => {
   describe('Axios Transport', () => {
     let input: string;
     beforeEach(() => {
-      service = what3words(apiKey, config, { transport: 'axios' });
+      service = what3words(apiKey, config, { transport: axiosTransport() });
       input = CHANCE.string();
       nock(`${config.host!}/${config.apiVersion}`)
         .get(`/autosuggest?${searchParams({ input, key: apiKey })}`)