Merge pull request #6 from cuppachino/happycollision-fix-strictness-of-query-params

Use exact optional query parameters

Author: cuppachino

.changeset/calm-parrots-clean.md

@@ -0,0 +1,5 @@
+---
+"@cuppachino/openapi-fetch": patch
+---
+
+Use exact optional query parameters

src/index.ts

@@ -117,7 +117,7 @@ type _CreateFetch<OP, Q = never> = [Q] extends [never]
 
 export type CreateFetch<M, OP> = M extends 'post' | 'put' | 'patch' | 'delete'
   ? OP extends { parameters: { query: infer Q } }
-    ? _CreateFetch<OP, { [K in keyof Q]: true | 1 }>
+    ? _CreateFetch<OP, { [K in keyof Q]-?: true | 1 }>
     : _CreateFetch<OP>
   : _CreateFetch<OP>
 

test/fetch.test.ts

@@ -86,7 +86,7 @@ describe('fetch', () => {
       const fun = fetcher
         .path('/bodyquery/{id}')
         .method(method)
-        .create({ scalar: 1 })
+        .create({ scalar: 1, optional: 1 })
 
       const { data } = await fun({
         id: 1,
@@ -235,7 +235,7 @@ describe('fetch', () => {
     const fun = fetcher
       .path('/bodyquery/{id}')
       .method('post')
-      .create({ scalar: 1 })
+      .create({ scalar: 1, optional: 1 })
 
     const captured = { url: '', body: '' }
 

test/infer.test.ts

@@ -9,6 +9,7 @@ import type {
   OpReturnType,
   TypedFetch,
 } from '../src'
+import type { paths } from './paths'
 import type { paths as paths2 } from './examples/stripe-openapi2'
 import type { paths as paths3 } from './examples/stripe-openapi3'
 
@@ -40,6 +41,23 @@ interface Openapi3 {
 type Same<A, B> = A extends B ? (B extends A ? true : false) : false
 
 describe('infer', () => {
+  it('queryParams', () => {
+    const fetcher = Fetcher.for<paths>()
+
+    fetcher
+      .path('/bodyquery/{id}')
+      .method('post')
+      // @ts-expect-error // Missing the optional param is wrong
+      .create({ scalar: 1 })
+
+    fetcher
+      .path('/bodyquery/{id}')
+      .method('post')
+      .create({ scalar: 1, optional: 1 })
+
+    expect(true).toBe(true)
+  })
+
   it('argument', () => {
     const same: Same<Openapi2['Argument'], Openapi3['Argument']> = true
     expect(same).toBe(true)

test/paths.ts

@@ -9,7 +9,7 @@ export type Data = {
 type Query = {
   parameters: {
     path: { a: number; b: string }
-    query: { scalar: string; list: string[] }
+    query: { scalar: string; list: string[]; optional?: string }
   }
   responses: { 200: { schema: Data } }
 }
@@ -33,7 +33,7 @@ type BodyArray = {
 type BodyAndQuery = {
   parameters: {
     path: { id: number }
-    query: { scalar: string }
+    query: { scalar: string; optional?: string }
     body: { payload: { list: string[] } }
   }
   responses: { 201: { schema: Data } }