Merge pull request #8 from seamapi/array-param-support-get

Author: razor-x

src/lib/params-serializer.test.ts

@@ -0,0 +1,106 @@
+import test from 'ava'
+
+import {
+  paramsSerializer,
+  UnserializableParamError,
+} from './params-serializer.js'
+
+test('serializes empty object', (t) => {
+  t.is(paramsSerializer({}), '')
+})
+
+test('serializes string', (t) => {
+  t.is(paramsSerializer({ foo: 'd' }), 'foo=d')
+  t.is(paramsSerializer({ foo: 'null' }), 'foo=null')
+  t.is(paramsSerializer({ foo: 'undefined' }), 'foo=undefined')
+  t.is(paramsSerializer({ foo: '0' }), 'foo=0')
+})
+
+test('serializes number', (t) => {
+  t.is(paramsSerializer({ foo: 1 }), 'foo=1')
+  t.is(paramsSerializer({ foo: 23.8 }), 'foo=23.8')
+})
+
+test('serializes boolean', (t) => {
+  t.is(paramsSerializer({ foo: true }), 'foo=true')
+  t.is(paramsSerializer({ foo: false }), 'foo=false')
+})
+
+test('removes undefined params', (t) => {
+  t.is(paramsSerializer({ bar: undefined }), '')
+  t.is(paramsSerializer({ foo: 1, bar: undefined }), 'foo=1')
+})
+
+test('removes null params', (t) => {
+  t.is(paramsSerializer({ bar: null }), '')
+  t.is(paramsSerializer({ foo: 1, bar: null }), 'foo=1')
+})
+
+test('serializes empty array params', (t) => {
+  t.is(paramsSerializer({ bar: [] }), 'bar=')
+  t.is(paramsSerializer({ foo: 1, bar: [] }), 'bar=&foo=1')
+})
+
+test('serializes array params with one value', (t) => {
+  t.is(paramsSerializer({ bar: ['a'] }), 'bar=a')
+  t.is(paramsSerializer({ foo: 1, bar: ['a'] }), 'bar=a&foo=1')
+})
+
+test('serializes array params with many values', (t) => {
+  t.is(paramsSerializer({ foo: 1, bar: ['a', '2'] }), 'bar=a&bar=2&foo=1')
+  t.is(
+    paramsSerializer({ foo: 1, bar: ['null', '2', 'undefined'] }),
+    'bar=null&bar=2&bar=undefined&foo=1',
+  )
+  t.is(paramsSerializer({ foo: 1, bar: ['', '', ''] }), 'bar=&bar=&bar=&foo=1')
+  t.is(
+    paramsSerializer({ foo: 1, bar: ['', 'a', '2'] }),
+    'bar=&bar=a&bar=2&foo=1',
+  )
+  t.is(
+    paramsSerializer({ foo: 1, bar: ['', 'a', ''] }),
+    'bar=&bar=a&bar=&foo=1',
+  )
+})
+
+test('cannot serialize single element array params with empty string', (t) => {
+  t.throws(() => paramsSerializer({ foo: [''] }), {
+    instanceOf: UnserializableParamError,
+  })
+})
+
+test('cannot serialize unserializable values', (t) => {
+  t.throws(() => paramsSerializer({ foo: {} }), {
+    instanceOf: UnserializableParamError,
+  })
+  t.throws(() => paramsSerializer({ foo: { x: 2 } }), {
+    instanceOf: UnserializableParamError,
+  })
+  t.throws(() => paramsSerializer({ foo: () => {} }), {
+    instanceOf: UnserializableParamError,
+  })
+})
+
+test('cannot serialize array params with unserializable values', (t) => {
+  t.throws(() => paramsSerializer({ bar: ['a', null] }), {
+    instanceOf: UnserializableParamError,
+  })
+  t.throws(() => paramsSerializer({ bar: ['a', undefined] }), {
+    instanceOf: UnserializableParamError,
+  })
+  t.throws(() => paramsSerializer({ bar: ['a', ['s']] }), {
+    instanceOf: UnserializableParamError,
+  })
+  t.throws(() => paramsSerializer({ bar: ['a', []] }), {
+    instanceOf: UnserializableParamError,
+  })
+  t.throws(() => paramsSerializer({ bar: ['a', {}] }), {
+    instanceOf: UnserializableParamError,
+  })
+  t.throws(() => paramsSerializer({ bar: ['a', { x: 2 }] }), {
+    instanceOf: UnserializableParamError,
+  })
+  t.throws(() => paramsSerializer({ bar: ['a', () => {}] }), {
+    instanceOf: UnserializableParamError,
+  })
+})

src/lib/params-serializer.ts

@@ -0,0 +1,55 @@
+import type { CustomParamsSerializer } from 'axios'
+
+export const paramsSerializer: CustomParamsSerializer = (params) => {
+  const searchParams = new URLSearchParams()
+
+  for (const [name, value] of Object.entries(params)) {
+    if (value == null) continue
+
+    if (Array.isArray(value)) {
+      if (value.length === 0) searchParams.set(name, '')
+      if (value.length === 1 && value[0] === '') {
+        throw new UnserializableParamError(
+          name,
+          `is a single element array containing the empty string which is unsupported because it serializes to the empty array`,
+        )
+      }
+      for (const v of value) {
+        throwIfUnserializable(name, v)
+        searchParams.append(name, v)
+      }
+      continue
+    }
+
+    throwIfUnserializable(name, value)
+    searchParams.set(name, value)
+  }
+
+  searchParams.sort()
+  return searchParams.toString()
+}
+
+const throwIfUnserializable = (k: string, v: unknown): void => {
+  if (v == null) {
+    throw new UnserializableParamError(k, `is ${v} or contains ${v}`)
+  }
+
+  if (typeof v === 'function') {
+    throw new UnserializableParamError(
+      k,
+      'is a function or contains a function',
+    )
+  }
+
+  if (typeof v === 'object') {
+    throw new UnserializableParamError(k, 'is an object or contains an object')
+  }
+}
+
+export class UnserializableParamError extends Error {
+  constructor(name: string, message: string) {
+    super(`Could not serialize parameter: '${name}' ${message}`)
+    this.name = this.constructor.name
+    Error.captureStackTrace(this, this.constructor)
+  }
+}

src/lib/seam/connect/axios.ts

@@ -1,5 +1,7 @@
 import axios, { type Axios } from 'axios'
 
+import { paramsSerializer } from 'lib/params-serializer.js'
+
 import { getAuthHeaders } from './auth.js'
 import {
   isSeamHttpOptionsWithClient,
@@ -15,6 +17,7 @@ export const createAxiosClient = (
   return axios.create({
     baseURL: options.endpoint,
     withCredentials: isSeamHttpOptionsWithClientSessionToken(options),
+    paramsSerializer,
     ...options.axiosOptions,
     headers: {
       ...getAuthHeaders(options),