Add RequestTypes helper

Author: htunnicliff

src/index.ts

@@ -4,13 +4,15 @@ import type createClient from "openapi-fetch";
 import type { FetchOptions, ParseAsResponse } from "openapi-fetch";
 import type {
   ErrorResponse,
+  ErrorResponseJSON,
   FilterKeys,
   MediaType,
   PathsWithMethod,
   ResponseObjectMap,
   SuccessResponse,
+  SuccessResponseJSON,
 } from "openapi-typescript-helpers";
-import useSWR, { type SWRConfiguration } from "swr";
+import useSWR, { SWRResponse, type SWRConfiguration } from "swr";
 import useSWRInfinite, { SWRInfiniteKeyLoader } from "swr/infinite";
 import type { PartialDeep } from "type-fest";
 
@@ -151,3 +153,26 @@ export function createHooks<Paths extends {}>(
     },
   };
 }
+
+export type RequestTypes<
+  Paths extends object,
+  Path extends PathsWithMethod<Paths, "get">,
+  Req = FilterKeys<Paths[Path], "get">,
+  Data = SuccessResponseJSON<Req>,
+  Error = ErrorResponseJSON<Req>,
+  Params = Req extends { parameters: infer P } ? P : never,
+  PathParams = Params extends { path: infer P } ? P : never,
+  QueryParams = Params extends { query: infer Q } ? Q : never,
+  HeaderParams = Params extends { header: infer H } ? H : never,
+  CookieParams = Params extends { cookie: infer C } ? C : never,
+  SWRConfig = SWRConfiguration<Data, Error>,
+> = {
+  Data: Data;
+  Error: Error;
+  PathParams: PathParams;
+  QueryParams: QueryParams;
+  Headers: HeaderParams;
+  Cookies: CookieParams;
+  SWRConfig: SWRConfig;
+  SWRResponse: SWRResponse<Data, Error, SWRConfig>;
+};

test/index.spec.ts

@@ -2,7 +2,7 @@ import { expectTypeOf } from "expect-type";
 import createClient from "openapi-fetch";
 import { SuccessResponseJSON } from "openapi-typescript-helpers";
 import type { paths } from "../generated/petstore";
-import { createHooks } from "../src/index";
+import { createHooks, RequestTypes } from "../src/index";
 import { mutate } from "swr";
 
 const petStoreApi = createClient<paths>({
@@ -71,3 +71,10 @@ usePetStoreInfinite("/store/order/{orderId}", (index, previous) => ({
     },
   },
 }));
+
+type Req = RequestTypes<paths, "/store/order/{orderId}">;
+
+expectTypeOf<Req["Data"]>().toEqualTypeOf<OrderSuccessResponse>();
+expectTypeOf<
+  Parameters<NonNullable<Req["SWRConfig"]["onSuccess"]>>[0]
+>().toEqualTypeOf<OrderSuccessResponse>();

tsconfig.json

@@ -3,6 +3,7 @@
     "target": "ESNext",
     "module": "ES2020",
     "moduleResolution": "Node",
+    "noUncheckedIndexedAccess": true,
     "outDir": "dist",
     "strict": true,
     "skipLibCheck": true