feat: override return types (#30)

Author: 7nohe

README.md

@@ -14,6 +14,23 @@
 $ npm install -D @7nohe/openapi-react-query-codegen
 ```
 
+ Register the command to the `scripts` property in your package.json file.
+
+```json
+{
+  "scripts": {
+    "codegen": "openapi-rq -i ./petstore.yaml -c axios"
+  }
+}
+```
+
+You can also run the command without installing it in your project using the npx command.
+
+```bash
+$ npx --package @7nohe/openapi-react-query-codegen openapi-rq -i ./petstore.yaml -c axios
+```
+
+
 ## Usage
 
 ```

examples/react-app/package.json

@@ -13,19 +13,19 @@
     "test:generated": "tsc ./openapi/queries/index.ts --noEmit --target esnext --moduleResolution node"
   },
   "dependencies": {
-    "@tanstack/react-query": "^5.0.0",
-    "axios": "^1.4.0",
+    "@tanstack/react-query": "^5.4.3",
+    "axios": "^1.6.0",
     "form-data": "~4.0.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "devDependencies": {
-    "@stoplight/prism-cli": "^5.0.0",
+    "@stoplight/prism-cli": "^5.5.1",
     "@types/react": "^18.2.6",
     "@types/react-dom": "^18.2.4",
-    "@vitejs/plugin-react": "^4.0.0",
+    "@vitejs/plugin-react": "^4.1.0",
     "npm-run-all": "^4.1.5",
-    "typescript": "^5.0.4",
-    "vite": "^4.3.8"
+    "typescript": "^5.2.2",
+    "vite": "^4.5.0"
   }
 }

examples/react-app/src/App.tsx

@@ -4,34 +4,33 @@ import {
   useDefaultClientFindPets,
   useDefaultClientFindPetsKey,
 } from "../openapi/queries";
-import { useState } from 'react';
-import { queryClient } from './queryClient';
+import { useState } from "react";
+import { queryClient } from "./queryClient";
 
 function App() {
-
   const [tags, _setTags] = useState<string[]>([]);
   const [limit, _setLimit] = useState<number>(10);
 
-  const { data, error, refetch } = useDefaultClientFindPets(
-    { tags, limit },
-  );
+  const { data, error, refetch } = useDefaultClientFindPets({ tags, limit });
 
   const { mutate: addPet } = useDefaultClientAddPet();
 
-  if (error) return (
-  <div>
-    <p>Failed to fetch pets</p>
-    <button onClick={() => refetch()}>Retry</button>
-  </div>
-  );
+  if (error)
+    return (
+      <div>
+        <p>Failed to fetch pets</p>
+        <button onClick={() => refetch()}>Retry</button>
+      </div>
+    );
 
   return (
     <div className="App">
       <h1>Pet List</h1>
       <ul>
-        {data instanceof Array && data?.map((pet, index) => (
-          <li key={pet.id + "-" + index}>{pet.name}</li>
-        ))}
+        {data instanceof Array &&
+          data?.map((pet, index) => (
+            <li key={pet.id + "-" + index}>{pet.name}</li>
+          ))}
       </ul>
       <button
         onClick={() => {
@@ -44,8 +43,7 @@ function App() {
                 queryClient.invalidateQueries({
                   queryKey: [useDefaultClientFindPetsKey],
                 });
-                console.log("success")
-
+                console.log("success");
               },
               onError: (error) => console.error(error),
             }

package.json

@@ -36,7 +36,7 @@
     "commander": "^11.1.0",
     "glob": "^10.2.5",
     "openapi-typescript-codegen": "^0.25.0",
-    "typescript": "^5.0.4"
+    "typescript": "^5.2.2"
   },
   "peerDependencies": {
     "commander": ">= 11 < 12",

pnpm-lock.yaml

@@ -1,12 +1,14 @@
 import ts from "typescript";
-import { sync }  from "glob";
+import { sync } from "glob";
 import { join } from "path";
 import fs from "fs";
 import { createUseQuery } from "./createUseQuery";
 import { createUseMutation } from "./createUseMutation";
 
 export const createExports = (generatedClientsPath: string) => {
-  const services = sync(join(generatedClientsPath, 'services', '*.ts').replace(/\\/g, '/'));
+  const services = sync(
+    join(generatedClientsPath, "services", "*.ts").replace(/\\/g, "/")
+  );
   const nodes = services.map((servicePath) =>
     ts.createSourceFile(
       servicePath, // fileName
@@ -29,7 +31,6 @@ export const createExports = (generatedClientsPath: string) => {
         ) as ts.MethodDeclaration[];
         return methods
           .map((method) => {
-            const methodName = method.name?.getText(node)!;
             const methodBlock = method
               .getChildren(node)
               .find((child) => child.kind === ts.SyntaxKind.Block) as ts.Block;