Merge pull request #1993 from openapi-ts/cleanup-swr-openapi

Update swr-openapi dependencies and fix types

.changeset/gentle-snails-sort.md

@@ -0,0 +1,5 @@
+---
+"swr-openapi": minor
+---
+
+Update dependencies and adjust paths signature to conform to updated helper signature

packages/swr-openapi/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Hunter Tunnicliff
+Copyright (c) 2024 Hunter Tunnicliff
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

packages/swr-openapi/package.json

@@ -56,8 +56,8 @@
     "version": "pnpm run build"
   },
   "peerDependencies": {
-    "openapi-fetch": "0.12",
-    "openapi-typescript": "7",
+    "openapi-fetch": "workspace:*",
+    "openapi-typescript": "workspace:7.x",
     "react": "18 || 19",
     "swr": "2",
     "typescript": "^5.x"
@@ -68,7 +68,7 @@
     }
   },
   "dependencies": {
-    "openapi-typescript-helpers": "0.0.13",
+    "openapi-typescript-helpers": "workspace:*",
     "type-fest": "4.26.1"
   },
   "devDependencies": {
@@ -79,8 +79,8 @@
     "husky": "9.1.5",
     "lint-staged": "15.2.10",
     "lodash": "4.17.21",
-    "openapi-fetch": "0.12.0",
-    "openapi-typescript": "7.4.0",
+    "openapi-fetch": "workspace:*",
+    "openapi-typescript": "workspace:7.x",
     "react": "18.3.1",
     "swr": "2.2.5",
     "typescript": "5.5.4",

packages/swr-openapi/src/__test__/types.test-d.ts

@@ -22,7 +22,7 @@ type Pet = components["schemas"]["Pet"];
 type PetInvalid = ErrorResponseJSON<paths["/pet/{petId}"]["get"]>;
 type PetStatusInvalid = ErrorResponseJSON<paths["/pet/findByStatus"]["get"]>;
 expectTypeOf<Pet>().toMatchTypeOf<{ name: string }>();
-expectTypeOf<PetInvalid>().toMatchTypeOf<{ message: string }>();
+expectTypeOf<PetInvalid>().toMatchTypeOf<{ message: string } | undefined>();
 expectTypeOf<PetStatusInvalid>().toMatchTypeOf<{ message: string }>();
 
 // Set up hooks
@@ -383,7 +383,7 @@ describe("TypesForRequest", () => {
   it("returns correct error", () => {
     expectTypeOf<GetPet["Error"]>().toEqualTypeOf<PetInvalid>();
     expectTypeOf<FindPetsByStatus["Error"]>().toEqualTypeOf<PetStatusInvalid>();
-    expectTypeOf<FindPetsByTags["Error"]>().toEqualTypeOf<never>();
+    expectTypeOf<FindPetsByTags["Error"]>().toEqualTypeOf<undefined>();
   });
 
   it("returns correct path params", () => {
@@ -430,7 +430,7 @@ describe("TypesForRequest", () => {
   it("returns correct SWR config", () => {
     expectTypeOf<GetPet["SWRConfig"]>().toEqualTypeOf<SWR.SWRConfiguration<Pet, PetInvalid>>();
     expectTypeOf<FindPetsByStatus["SWRConfig"]>().toEqualTypeOf<SWR.SWRConfiguration<Pet[], PetStatusInvalid>>();
-    expectTypeOf<FindPetsByTags["SWRConfig"]>().toEqualTypeOf<SWR.SWRConfiguration<Pet[], never>>();
+    expectTypeOf<FindPetsByTags["SWRConfig"]>().toEqualTypeOf<SWR.SWRConfiguration<Pet[], undefined>>();
   });
 
   it("returns correct SWR response", () => {
@@ -441,7 +441,7 @@ describe("TypesForRequest", () => {
       SWR.SWRResponse<Pet[], PetStatusInvalid, SWR.SWRConfiguration<Pet[], PetStatusInvalid>>
     >();
     expectTypeOf<FindPetsByTags["SWRResponse"]>().toEqualTypeOf<
-      SWR.SWRResponse<Pet[], never, SWR.SWRConfiguration<Pet[], never>>
+      SWR.SWRResponse<Pet[], undefined, SWR.SWRConfiguration<Pet[], undefined>>
     >();
   });
 });

packages/swr-openapi/src/mutate.ts

@@ -6,7 +6,6 @@ import type { PartialDeep } from "type-fest";
 import type { TypesForGetRequest } from "./types.js";
 
 // Types are loose here to support ecosystem utilities like `_.isMatch`
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type CompareFn = (init: any, partialInit: any) => boolean;
 
 /**

packages/swr-openapi/src/types.ts

@@ -10,7 +10,7 @@ type TryKey<T, K extends PropertyKey> = T extends { [Key in K]?: unknown } ? T[K
  * Provides specific types used within a given request
  */
 export type TypesForRequest<
-  Paths extends {},
+  Paths extends Record<string | number, any>,
   Method extends Extract<HttpMethod, keyof Paths[keyof Paths]>,
   Path extends PathsWithMethod<Paths, Method>,
   // ---
@@ -42,6 +42,6 @@ export type TypesForRequest<
  * Uses {@link TypesForRequest}
  */
 export type TypesForGetRequest<
-  Paths extends {},
+  Paths extends Record<string | number, any>,
   Path extends PathsWithMethod<Paths, Extract<"get", keyof Paths[keyof Paths]>>,
 > = TypesForRequest<Paths, Extract<"get", keyof Paths[keyof Paths]>, Path>;