swaggie 1.0.1 → 1.0.2-test.2

package/README.md

@@ -116,12 +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.
-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      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)
 ```
 
 If you want to use your own template, you can use the path to your template for the `-t` parameter:

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';
+export type Template = 'axios' | 'fetch' | 'ng1' | 'ng2' | 'swr-axios' | 'xior' | 'tanstack-query';
 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.1",
+  "version": "1.0.2-test.2",
   "description": "Generate TypeScript REST client code from an OpenAPI spec",
   "author": {
     "name": "Piotr Dabrowski",
@@ -51,21 +51,21 @@
   ],
   "dependencies": {
     "case": "^1.6.3",
-    "commander": "^12.1.0",
-    "eta": "^3.4.0",
+    "commander": "^13.1.0",
+    "eta": "^3.5.0",
     "js-yaml": "^4.1.0",
     "nanocolors": "^0.2.0",
-    "undici": "^6.19.2"
+    "undici": "^7.3.0"
   },
   "devDependencies": {
-    "@types/chai": "4.3.16",
+    "@types/chai": "5.0.1",
     "@types/js-yaml": "4.0.9",
-    "@types/mocha": "10.0.7",
-    "@types/node": "20.14.9",
-    "chai": "4.4.1",
-    "mocha": "10.6.0",
+    "@types/mocha": "10.0.10",
+    "@types/node": "22.13.1",
+    "chai": "5.1.2",
+    "mocha": "11.1.0",
     "openapi-types": "^12.1.3",
     "sucrase": "3.35.0",
-    "typescript": "5.5.3"
+    "typescript": "5.7.3"
   }
 }

package/templates/tanstack-query/baseClient.ejs

@@ -0,0 +1,25 @@
+/* tslint:disable */
+/* eslint-disable */
+//----------------------
+// <auto-generated>
+//   Generated using Swaggie (https://github.com/yhnavein/swaggie)
+//   Please avoid doing any manual changes in this file
+// </auto-generated>
+//----------------------
+// ReSharper disable InconsistentNaming
+// deno-lint-ignore-file
+
+import xior, { type XiorResponse, type XiorRequestConfig, encodeParams } from "xior";
+import { QueryClient, type UndefinedInitialDataOptions, useQuery } from '@tanstack/react-query';
+
+export const queryClient = new QueryClient();
+
+export const http = xior.create({
+  baseURL: '<%= it.baseUrl || '' %>',
+  paramsSerializer: (params) =>
+    encodeParams(params, true, null, {
+      allowDots: <%= it.allowDots %>,
+      arrayFormat: '<%= it.arrayFormat %>',
+    }),
+});
+

package/templates/tanstack-query/client.ejs

@@ -0,0 +1,22 @@
+export const <%= it.camelCaseName %>Client = {
+  <% it.operations.forEach((operation) => { %>
+<%~ include('operation.ejs', operation); %>
+
+<% }); %>
+};
+
+
+<% var getOperations = it.operations.filter((o) => o.method === 'GET');
+if(getOperations.length > 0) { %>
+  <% getOperations.forEach((operation) => {
+  var opName = operation.name;
+  if(opName.toLowerCase().startsWith("get")) {
+    opName = opName.substring(3);
+  }
+  opName[0] = opName[0].toUpperCase();
+  var customName = "use" + it.clientName + opName;
+  var queryOperation = Object.assign({ rqOpName: customName, opKey: it.clientName + opName, clientName: it.camelCaseName }, operation); %>
+<%~ include('queryOperation.ejs', queryOperation); %>
+
+  <% }); %>
+<% } %>

package/templates/tanstack-query/operation.ejs

@@ -0,0 +1,44 @@
+  /**
+<% it.parameters.forEach((parameter) => { %>
+   * @param <%= parameter.name %> <%= parameter.optional ? '(optional)' : '' %> <%= parameter.name !== parameter.originalName ? `(API name: ${parameter.originalName})` : '' %>
+
+<% }); -%>
+   */
+  <%= it.name %>(<% it.parameters.forEach((parameter) => { %>
+<%= parameter.name %>: <%~ parameter.type %> <%= parameter.optional ? '| null | undefined' : '' %>,
+    <% }); %>
+$config?: XiorRequestConfig
+  ): Promise<XiorResponse<<%~ it.returnType %>>> {
+    const url = `<%= it.url %>`;
+
+    return http.request<<%~ it.returnType %>>({
+      url: url,
+      method: '<%= it.method %>',
+<% if(it.body) { %>
+<% if(it.body.contentType === 'urlencoded') { %>
+      data: new URLSearchParams(<%= it.body.name %> as any),
+<% } else { %>
+      data: <%= it.body.name %>,
+<% } %>
+<% } %>
+<% if(it.query && it.query.length > 0) { %>
+      params: {
+    <% it.query.forEach((parameter) => { %>
+    '<%= parameter.originalName %>': <%= parameter.name %>,
+    <% }); %>
+  },
+<% } %>
+<% if(it.headers && it.headers.length > 0) { %>
+      headers: {
+  <% it.headers.forEach((parameter) => { %>
+    <% if (parameter.value) { %>
+  '<%= parameter.originalName %>': '<%= parameter.value %>',
+    <% } else { %>
+  '<%= parameter.originalName %>': <%= parameter.name %>,
+    <% } %>
+  <% }); %>
+},
+<% } %>
+      ...$config,
+    });
+  },

package/templates/tanstack-query/queryOperation.ejs

@@ -0,0 +1,21 @@
+/**
+<% it.parameters.forEach((parameter) => { %>
+   * @param <%= parameter.name %> <%= parameter.optional ? '(optional)' : '' %> <%= parameter.name !== parameter.originalName ? `(API name: ${parameter.originalName})` : '' %>
+
+<% }); -%>
+   * @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) => { %>
+  <%= parameter.name %>: <%~ parameter.type %> <%= parameter.optional ? ' | null | undefined' : '' %>,
+    <% }); %>
+$config?: UndefinedInitialDataOptions<<%~ it.returnType %>, Error, <%~ it.returnType %>>,
+    $httpConfig?: XiorRequestConfig
+  ) {
+  return useQuery({
+    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),
+    ...$config
+  });
+}