Merge pull request #370 from contentful/fix/types

fix: usage of axios [PHX-2738]

Author: marcolink

package.json

@@ -46,8 +46,7 @@
     "fast-copy": "^2.1.7",
     "lodash.isplainobject": "^4.0.6",
     "lodash.isstring": "^4.0.1",
-    "p-throttle": "^4.1.1",
-    "qs": "^6.11.2"
+    "p-throttle": "^4.1.1"
   },
   "devDependencies": {
     "@babel/cli": "^7.12.8",
@@ -66,7 +65,6 @@
     "@types/jest": "^29.2.2",
     "@types/lodash.isplainobject": "^4.0.6",
     "@types/lodash.isstring": "^4.0.6",
-    "@types/qs": "^6.9.5",
     "@typescript-eslint/eslint-plugin": "^5.11.0",
     "@typescript-eslint/parser": "^5.11.0",
     "axios": "^1.4.0",

src/create-http-client.ts

@@ -1,6 +1,6 @@
-import type { AxiosRequestHeaders, AxiosStatic } from 'axios'
+import { AxiosRequestHeaders } from 'axios'
+import type { AxiosStatic } from 'axios'
 import copy from 'fast-copy'
-import qs from 'qs'
 import asyncToken from './async-token'
 
 import rateLimitRetry from './rate-limit'
@@ -16,7 +16,7 @@ const HOST_REGEX = /^(?!\w+:\/\/)([^\s:]+\.?[^\s:]+)(?::(\d+))?(?!:)$/
  * @private
  * @param {AxiosStatic} axios - Axios library
  * @param {CreateHttpClientParams} options - Initialization parameters for the HTTP client
- * @return {ContentfulAxiosInstance} Initialized axios instance
+ * @return {AxiosInstance} Initialized axios instance
  */
 export default function createHttpClient(
   axios: AxiosStatic,
@@ -41,7 +41,6 @@ export default function createHttpClient(
     httpsAgent: false as const,
     timeout: 30000,
     throttle: 0,
-    proxy: false as const,
     basePath: '',
     adapter: undefined,
     maxContentLength: 1073741824, // 1GB
@@ -90,11 +89,6 @@ export default function createHttpClient(
     headers: config.headers,
     httpAgent: config.httpAgent,
     httpsAgent: config.httpsAgent,
-    paramsSerializer: {
-      serialize: (params) => {
-        return qs.stringify(params, { arrayFormat: 'repeat' })
-      },
-    },
     proxy: config.proxy,
     timeout: config.timeout,
     adapter: config.adapter,
@@ -106,6 +100,7 @@ export default function createHttpClient(
     requestLogger: config.requestLogger,
     retryOnError: config.retryOnError,
   }
+
   const instance = axios.create(axiosOptions) as AxiosInstance
   instance.httpClientParams = options
 
@@ -116,8 +111,8 @@ export default function createHttpClient(
    * and the version of the library comes from different places depending
    * on whether it's a browser build or a node.js build.
    * @private
-   * @param {CreateHttpClientParams} httpClientParams - Initialization parameters for the HTTP client
-   * @return {ContentfulAxiosInstance} Initialized axios instance
+   * @param {CreateHttpClientParams} newParams - Initialization parameters for the HTTP client
+   * @return {AxiosInstance} Initialized axios instance
    */
   instance.cloneWithNewParams = function (
     newParams: Partial<CreateHttpClientParams>

src/error-handler.ts

@@ -1,5 +1,4 @@
 import isPlainObject from 'lodash.isplainobject'
-import type { AxiosError } from 'axios'
 import type { ContentfulErrorData } from './types'
 
 /**
@@ -10,7 +9,7 @@ import type { ContentfulErrorData } from './types'
  * and the expected error codes.
  * @private
  */
-export default function errorHandler(errorResponse: AxiosError<ContentfulErrorData>): never {
+export default function errorHandler(errorResponse: any): never {
   const { config, response } = errorResponse
   let errorName
 

src/types.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import { AxiosRequestHeaders, InternalAxiosRequestConfig } from 'axios'
+import { AxiosHeaderValue, AxiosRequestHeaders, InternalAxiosRequestConfig } from 'axios'
 
 import type {
   AxiosInstance as OriginalAxiosInstance,
@@ -64,7 +64,7 @@ export type CreateHttpClientParams = {
   logHandler?: DefaultOptions['logHandler']
 
   /** Optional additional headers */
-  headers?: AxiosRequestHeaders
+  headers?: AxiosRequestHeaders | Record<string, AxiosHeaderValue>
 
   defaultHostname?: string
 
@@ -122,7 +122,7 @@ export type ContentfulErrorData = {
   statusText?: string
   requestId?: string
   message: string
-  details: Record<string, unknown>
-  request?: Record<string, unknown>
+  details: Record<string, any>
+  request?: Record<string, any>
   sys?: { id?: string }
 }