swaggie 1.0.2-test.3 → 1.0.2-test.5

package/README.md

@@ -116,13 +116,13 @@ Sample configuration looks like this:
 The following templates are bundled with Swaggie:
 
 ```
-axios          Default template. Recommended for React / Vue / similar frameworks. Uses axios
-xior           Lightweight and modern alternative to axios. Uses [xior](https://github.com/suhaotian/xior#intro)
-swr-axios      Template that embraces SRW for GET requests and as a fallback uses axios.
-tanstack-query Template that uses TanStack Query for GET requests and as a fallback uses xior.
-fetch          Template similar to axios, but with fetch API instead. Recommended for React / Vue / similar frameworks
-ng1            Template for Angular 1 (this is for the old one)
-ng2            Template for Angular 2+ (uses HttpClient, InjectionTokens, etc)
+axios       Default template. Recommended for React / Vue / similar frameworks. Uses axios
+xior        Lightweight and modern alternative to axios. Uses [xior](https://github.com/suhaotian/xior#intro)
+swr-axios   SWR for GET requests with axios as backend
+tsq-xior    TanStack Query for GET requests with xior as backend
+fetch       Barebone fetch API. Recommended for React / Vue / similar frameworks
+ng1         Angular 1 client (this is for the old one)
+ng2         Angular 2+ client (uses HttpClient, InjectionTokens, etc)
 ```
 
 If you want to use your own template, you can use the path to your template for the `-t` parameter:

package/dist/cli.js

@@ -32,7 +32,10 @@ program
     process.env.OPEN_API_OUT
   )
   .option('-b, --baseUrl <string>', 'Base URL that will be used as a default value in the clients')
-  .option('-t, --template <string>', 'Template used forgenerating API client. Default: "axios"')
+  .option(
+    '-t, --template <string>',
+    'Template used forgenerating API client. Default: "axios". Other: "fetch", "ng1", "ng2", "swr-axios", "xior", "tsq-xior"'
+  )
   .option('--preferAny', 'Use "any" type instead of "unknown"')
   .option(
     '--servicePrefix <string>',

package/dist/types.d.ts

@@ -29,7 +29,7 @@ export interface FullAppOptions extends ClientOptions {
     /** Path to the configuration file that contains actual config to be used */
     config?: string;
 }
-export type Template = 'axios' | 'fetch' | 'ng1' | 'ng2' | 'swr-axios' | 'xior' | 'tanstack-query';
+export type Template = 'axios' | 'fetch' | 'ng1' | 'ng2' | 'swr-axios' | 'xior' | 'tsq-xior';
 export type HttpMethod = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch';
 export type DateSupport = 'string' | 'Date';
 export type ArrayFormat = 'indices' | 'repeat' | 'brackets';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swaggie",
-  "version": "1.0.2-test.3",
+  "version": "1.0.2-test.5",
   "description": "Generate TypeScript REST client code from an OpenAPI spec",
   "author": {
     "name": "Piotr Dabrowski",
@@ -61,8 +61,8 @@
     "@types/chai": "5.0.1",
     "@types/js-yaml": "4.0.9",
     "@types/mocha": "10.0.10",
-    "@types/node": "22.13.1",
-    "chai": "5.1.2",
+    "@types/node": "22.13.4",
+    "chai": "5.2.0",
     "mocha": "11.1.0",
     "openapi-types": "^12.1.3",
     "sucrase": "3.35.0",

package/templates/{tanstack-query → tsq-xior}/queryOperation.ejs

@@ -6,13 +6,16 @@
    * @param $config (optional) Additional configuration for TanStack Query
    * @param $httpConfig (optional) Additional configuration for xior request (actually executes the request)
    */
-export function <%= it.rqOpName %>(<% it.parameters.forEach((parameter) => { %>
+export function <%= it.rqOpName %><TData = <%~ it.returnType %>, TError = Error>(<% it.parameters.forEach((parameter) => { %>
   <%= parameter.name %>: <%~ parameter.type %> <%= parameter.optional ? ' | null | undefined' : '' %>,
     <% }); %>
-$config?: UseQueryOptions<<%~ it.returnType %>, Error, <%~ it.returnType %>>,
+$config?: Omit<
+  UseQueryOptions<<%~ it.returnType %>, TError, TData>,
+  'queryKey' | 'queryFn'
+>,
     $httpConfig?: XiorRequestConfig
   ) {
-  return useQuery({
+  return useQuery<<%~ it.returnType %>, TError, TData>({
     queryKey: ['<%= it.clientName %>', '<%= it.opKey %>', <% it.query.forEach((parameter) => { %><%= parameter.name %>, <% }); %>],
     queryFn: () => <%= it.clientName %>Client.<%= it.name %>(<% it.parameters.forEach((parameter) => { %>
 <%= parameter.name %>, <% }); %>$httpConfig).then(res => res.data),