feat: typed api method handler data param

johannschopplich · Sep 3, 2023 · a99216f · a99216f
1 parent d81adb1
commit a99216f
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 23 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -1,18 +1,12 @@
 import { ofetch } from 'ofetch'
 import { joinURL } from 'ufo'
-import type { QueryObject } from 'ufo'
 import type { FetchOptions } from 'ofetch'
 import type { ApiBuilder, ApiMethodHandler, ResponseType } from './types'
 import { mergeFetchOptions } from './utils'
 
 export type { ApiBuilder }
 
-const payloadMethods = [
-  'POST',
-  'PUT',
-  'DELETE',
-  'PATCH',
-] as const
+const payloadMethods = ['POST', 'PUT', 'DELETE', 'PATCH']
 
 /**
  * Minimal, type-safe REST client using JS proxies
@@ -32,12 +26,12 @@ export function createClient<R extends ResponseType = 'json'>(
           return p(joinURL(url, key))
 
         const handler: ApiMethodHandler = <T = any, R extends ResponseType = 'json'>(
-          data?: RequestInit['body'] | Record<string, any>,
+          data?: any,
           opts: FetchOptions<R> = {},
         ) => {
-          if (method === 'GET' && data)
-            opts.query = data as QueryObject
-          else if (payloadMethods.includes(method as typeof payloadMethods[number]))
+          if (method === 'GET')
+            opts.query = data
+          else if (payloadMethods.includes(method))
             opts.body = data
 
           opts.method = method

diff --git a/src/types.ts b/src/types.ts
@@ -7,20 +7,26 @@ export interface ResponseMap {
 }
 
 export type ResponseType = keyof ResponseMap | 'json'
-export type MappedType<R extends ResponseType, JsonType = any> = R extends keyof ResponseMap ? ResponseMap[R] : JsonType
+export type MappedType<
+  R extends ResponseType,
+  JsonType = any,
+> = R extends keyof ResponseMap ? ResponseMap[R] : JsonType
 
-export type ApiMethodHandler = <T = any, R extends ResponseType = 'json'>(
-  data?: RequestInit['body'] | Record<string, any>,
-  opts?: Omit<FetchOptions<R>, 'baseURL' | 'method'>
+export type ApiMethodHandler<Data = never> = <
+  T = any,
+  R extends ResponseType = 'json',
+>(
+  data?: Data,
+  opts?: Omit<FetchOptions<R>, 'baseURL' | 'method'>,
 ) => Promise<MappedType<R, T>>
 
 export type ApiBuilder = {
   [key: string]: ApiBuilder
   (...segmentsOrIds: (string | number)[]): ApiBuilder
 } & {
-  get: ApiMethodHandler
-  post: ApiMethodHandler
-  put: ApiMethodHandler
-  delete: ApiMethodHandler
-  patch: ApiMethodHandler
+  get: ApiMethodHandler<FetchOptions['query']>
+  post: ApiMethodHandler<FetchOptions['body']>
+  put: ApiMethodHandler<FetchOptions['body']>
+  delete: ApiMethodHandler<FetchOptions['body']>
+  patch: ApiMethodHandler<FetchOptions['body']>
 }
diff --git a/test/index.test.ts b/test/index.test.ts
@@ -72,13 +72,20 @@ describe('unrested', () => {
   })
 
   it('default options', async () => {
-    const { headers } = await client.bar.post()
-    expect(headers).to.include({ 'x-foo': 'bar' })
+    const { headers } = await client.bar.post(undefined, {
+      headers: {
+        'Content-Type': 'application/json',
+      },
+    })
+    expect(headers).to.include({
+      'x-foo': 'bar',
+      'content-type': 'application/json',
+    })
   })
 
   it('override default options', async () => {
     const { headers } = await client.bar.post(
-      {},
+      undefined,
       { headers: { 'X-Foo': 'baz' } },
     )
     expect(headers).to.include({ 'x-foo': 'baz' })