Drop init argument when not needed in query key (#2061)

* Drop init argument when not needed in query key

For urls that do not include an init param, generate a query key of length 2. This allows the value to be passed directly to `invalidateQueries()`.

Without this change, the package generates `["get", "/foo", undefined]` which does not correctly match the corresponding get query.

Related to #1806

* Create sour-steaks-double.md

Author: kevmo314

.changeset/sour-steaks-double.md

@@ -0,0 +1,5 @@
+---
+"openapi-react-query": patch
+---
+
+Drop init argument when not needed in query key

packages/openapi-react-query/src/index.ts

@@ -34,7 +34,8 @@ export type QueryKey<
   Paths extends Record<string, Record<HttpMethod, {}>>,
   Method extends HttpMethod,
   Path extends PathsWithMethod<Paths, Method>,
-> = readonly [Method, Path, MaybeOptionalInit<Paths[Path], Method>];
+  Init = MaybeOptionalInit<Paths[Path], Method>,
+> = Init extends undefined ? readonly [Method, Path] : readonly [Method, Path, Init];
 
 export type QueryOptionsFunction<Paths extends Record<string, Record<HttpMethod, {}>>, Media extends MediaType> = <
   Method extends HttpMethod,
@@ -199,7 +200,11 @@ export default function createClient<Paths extends {}, Media extends MediaType =
   };
 
   const queryOptions: QueryOptionsFunction<Paths, Media> = (method, path, ...[init, options]) => ({
-    queryKey: [method, path, init as InitWithUnknowns<typeof init>] as const,
+    queryKey: (init === undefined ? ([method, path] as const) : ([method, path, init] as const)) as QueryKey<
+      Paths,
+      typeof method,
+      typeof path
+    >,
     queryFn,
     ...options,
   });

packages/openapi-react-query/test/index.test.tsx

@@ -231,6 +231,16 @@ describe("client", () => {
       expectTypeOf(result.current.data).toEqualTypeOf<"select(true)">();
       expectTypeOf(result.current.error).toEqualTypeOf<false | null>();
     });
+
+    it("returns query options without an init", async () => {
+      const fetchClient = createFetchClient<minimalGetPaths>({
+        baseUrl,
+        fetch: () => Promise.resolve(Response.json(true)),
+      });
+      const client = createClient(fetchClient);
+
+      expect(client.queryOptions("get", "/foo").queryKey.length).toBe(2);
+    });
   });
 
   describe("useQuery", () => {