fix: support pkg builds again

Author: rossiam

.changeset/chilled-rivers-sell.md

@@ -0,0 +1,7 @@
+---
+"@smartthings/core-sdk": major
+---
+
+back off axios version to last non-ESM version so library will still work with pkg tool
+
+NOTE: Dependents which use axios will also need to downgrade to version 0.27.2.

package-lock.json

@@ -20,7 +20,7 @@
 	],
 	"dependencies": {
 		"async-mutex": "^0.4.0",
-		"axios": "^1.3.4",
+		"axios": "^0.27.2",
 		"http-signature": "^1.3.6",
 		"lodash.isdate": "^4.0.1",
 		"lodash.isstring": "^4.0.1",

package.json

@@ -180,7 +180,7 @@ export class EndpointClient {
 			headers: options?.headerOverrides ? { ...headers, ...options.headerOverrides } : headers,
 			params,
 			data,
-			paramsSerializer: { serialize: params => qs.stringify(params, { indices: false }) },
+			paramsSerializer: params => qs.stringify(params, { indices: false }),
 		}
 
 		axiosConfig = await this.config.authenticator.authenticate(axiosConfig)

src/endpoint-client.ts

@@ -1,5 +1,5 @@
 import { Mutex } from 'async-mutex'
-import axios, { AxiosRequestConfig, AxiosResponse, CustomParamsSerializer, ParamsSerializerOptions } from 'axios'
+import axios, { AxiosRequestConfig, AxiosResponse } from 'axios'
 import qs from 'qs'
 
 import { AuthData, Authenticator, BearerTokenAuthenticator, NoOpAuthenticator, RefreshData,
@@ -150,18 +150,17 @@ describe('EndpointClient',  () => {
 				},
 				data: undefined,
 				params: undefined,
-				paramsSerializer: expect.any(Object),
+				paramsSerializer: expect.any(Function),
 			})
 			expect(response.status).toBe('ok')
 
 			const stringifyMock = (qs.stringify as jest.Mock<string, [unknown]>)
 				.mockReturnValue('stringified parameters')
 			// eslint-disable-next-line @typescript-eslint/no-explicit-any
-			const serialize = (mockRequest.mock.calls[0][0].paramsSerializer as ParamsSerializerOptions)
-				?.serialize as CustomParamsSerializer
+			const paramsSerializer = mockRequest.mock.calls[0][0].paramsSerializer as (params: any) => string
 
-			expect(serialize).toBeDefined()
-			expect(serialize({ param: 'value' })).toBe('stringified parameters')
+			expect(paramsSerializer).toBeDefined()
+			expect(paramsSerializer({ param: 'value' })).toBe('stringified parameters')
 
 			expect(stringifyMock).toHaveBeenCalledTimes(1)
 			expect(stringifyMock).toHaveBeenCalledWith({ param: 'value' }, { indices: false })
@@ -185,7 +184,7 @@ describe('EndpointClient',  () => {
 				},
 				data: undefined,
 				params: undefined,
-				paramsSerializer: expect.any(Object),
+				paramsSerializer: expect.any(Function),
 			})
 			expect(response.status).toBe('ok')
 		})
@@ -204,7 +203,7 @@ describe('EndpointClient',  () => {
 				},
 				data: undefined,
 				params: undefined,
-				paramsSerializer: expect.any(Object),
+				paramsSerializer: expect.any(Function),
 			})
 			expect(response.status).toBe('ok')
 		})
@@ -227,7 +226,7 @@ describe('EndpointClient',  () => {
 				},
 				data: { name: 'Bob' },
 				params: undefined,
-				paramsSerializer: expect.any(Object),
+				paramsSerializer: expect.any(Function),
 			})
 			expect(response.status).toBe('ok')
 		})
@@ -245,7 +244,7 @@ describe('EndpointClient',  () => {
 				},
 				data: undefined,
 				params: undefined,
-				paramsSerializer: expect.any(Object),
+				paramsSerializer: expect.any(Function),
 			})
 			expect(response.status).toBe('ok')
 		})
@@ -268,7 +267,7 @@ describe('EndpointClient',  () => {
 				},
 				data: undefined,
 				params: undefined,
-				paramsSerializer: expect.any(Object),
+				paramsSerializer: expect.any(Function),
 			})
 			expect(response.status).toBe('ok')
 
@@ -321,7 +320,7 @@ describe('EndpointClient',  () => {
 				},
 				data: undefined,
 				params: undefined,
-				paramsSerializer: expect.any(Object),
+				paramsSerializer: expect.any(Function),
 			})
 			expect(response.status).toBe('ok')
 		})
@@ -340,7 +339,7 @@ describe('EndpointClient',  () => {
 				params: {
 					locationId: 'XXX',
 				},
-				paramsSerializer: expect.any(Object),
+				paramsSerializer: expect.any(Function),
 			})
 			expect(response.status).toBe('ok')
 		})
@@ -357,7 +356,7 @@ describe('EndpointClient',  () => {
 				},
 				data: undefined,
 				params: undefined,
-				paramsSerializer: expect.any(Object),
+				paramsSerializer: expect.any(Function),
 			})
 			expect(response.status).toBe('ok')
 		})
@@ -374,7 +373,7 @@ describe('EndpointClient',  () => {
 				},
 				data: undefined,
 				params: undefined,
-				paramsSerializer: expect.any(Object),
+				paramsSerializer: expect.any(Function),
 			})
 			expect(response.status).toBe('ok')
 		})
@@ -394,7 +393,7 @@ describe('EndpointClient',  () => {
 				name: 'Bill',
 			},
 			params: undefined,
-			paramsSerializer: expect.any(Object),
+			paramsSerializer: expect.any(Function),
 		})
 		expect(response.status).toBe('ok')
 	})
@@ -413,7 +412,7 @@ describe('EndpointClient',  () => {
 				name: 'Bill',
 			},
 			params: undefined,
-			paramsSerializer: expect.any(Object),
+			paramsSerializer: expect.any(Function),
 		})
 		expect(response.status).toBe('ok')
 	})
@@ -432,7 +431,7 @@ describe('EndpointClient',  () => {
 				name: 'Joe',
 			},
 			params: undefined,
-			paramsSerializer: expect.any(Object),
+			paramsSerializer: expect.any(Function),
 		})
 		expect(response.status).toBe('ok')
 	})
@@ -449,7 +448,7 @@ describe('EndpointClient',  () => {
 			},
 			data: undefined,
 			params: undefined,
-			paramsSerializer: expect.any(Object),
+			paramsSerializer: expect.any(Function),
 		})
 		expect(response.status).toBe('ok')
 	})

test/unit/endpoint-client.test.ts

@@ -4,9 +4,7 @@ export function expectedRequest(config: any): any {
 		data: undefined,
 		params: undefined,
 		...config,
-		paramsSerializer: expect.objectContaining({
-			serialize: expect.any(Function),
-		}),
+		paramsSerializer: expect.any(Function),
 	}
 }
 
@@ -21,8 +19,6 @@ export function buildRequest(path?: string, params?: any, data?: any, method = '
 		},
 		data: data,
 		params: params,
-		paramsSerializer: expect.objectContaining({
-			serialize: expect.any(Function),
-		}),
+		paramsSerializer: expect.any(Function),
 	}
 }