swagger-typescript-api 13.9.3 → 13.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "13.9.3",
+  "version": "13.11.0",
   "description": "Generate the API client for Fetch or Axios from an OpenAPI Specification",
   "homepage": "https://github.com/acacode/swagger-typescript-api",
   "bugs": "https://github.com/acacode/swagger-typescript-api/issues",
@@ -46,7 +46,7 @@
   "dependencies": {
     "@apidevtools/swagger-parser": "12.1.0",
     "@biomejs/js-api": "4.0.0",
-    "@biomejs/wasm-nodejs": "2.4.15",
+    "@biomejs/wasm-nodejs": "2.4.16",
     "@types/swagger-schema-official": "^2.0.25",
     "c12": "^3.3.3",
     "citty": "^0.2.1",
@@ -63,17 +63,17 @@
     "yummies": "7.19.4"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.4.15",
+    "@biomejs/biome": "2.4.16",
     "@changesets/changelog-github": "0.7.0",
     "@changesets/cli": "2.31.0",
     "@tsconfig/node20": "20.1.9",
     "@tsconfig/strictest": "2.0.8",
-    "@types/node": "25.9.0",
+    "@types/node": "25.9.1",
     "@types/swagger2openapi": "7.0.4",
     "axios": "1.16.1",
     "tsdown": "0.21.10",
     "typedoc": "0.28.19",
-    "vitest": "4.1.6"
+    "vitest": "4.1.7"
   },
   "engines": {
     "node": ">=20"

package/templates/base/content-type-accessors.ejs

@@ -0,0 +1,18 @@
+<%
+const { config } = it;
+const isUnion = config.enumStyle === "union";
+
+// camelCase keys (Json, FormData, …) are used by http-client templates as CT.Json, CT.FormData, …
+// They mirror the ContentType property names so the access pattern is identical regardless of enumStyle.
+const v = {
+  Json:       isUnion ? '"application/json"'                  : "ContentType.Json",
+  JsonApi:    isUnion ? '"application/vnd.api+json"'          : "ContentType.JsonApi",
+  FormData:   isUnion ? '"multipart/form-data"'               : "ContentType.FormData",
+  UrlEncoded: isUnion ? '"application/x-www-form-urlencoded"' : "ContentType.UrlEncoded",
+  Text:       isUnion ? '"text/plain"'                        : "ContentType.Text",
+};
+
+// UPPER_SNAKE aliases (JSON, FORM_DATA, …) are used by procedure-call templates as
+// requestContentKind["JSON"], matching the CONTENT_KIND constants produced by schema-routes.ts.
+return { ...v, JSON: v.Json, JSON_API: v.JsonApi, FORM_DATA: v.FormData, URL_ENCODED: v.UrlEncoded, TEXT: v.Text };
+%>

package/templates/base/data-contracts.ejs

@@ -25,6 +25,16 @@ const dataContractTemplates = {
   type: (contract) => {
     return `type ${contract.name}${buildGenerics(contract)} = ${contract.content}`;
   },
+  const: (contract) => {
+    const entries = contract.$content
+      .map(({ key, value }) => `  ${key}: ${value}`)
+      .join(',\n');
+    const typeExport = contract.internal ? '' : 'export ';
+    return (
+      `const ${contract.name} = {\n${entries},\n} as const\n` +
+      `${typeExport}type ${contract.name} = (typeof ${contract.name})[keyof typeof ${contract.name}]`
+    );
+  },
 }
 %>
 

package/templates/base/enum-data-contract.ejs

@@ -3,7 +3,12 @@ const { contract, utils, config } = it;
 const { formatDescription, require, _ } = utils;
 const { name, $content } = contract;
 %>
-<% if (config.generateUnionEnums) { %>
+<% if (config.enumStyle === "const") { %>
+  export const <%~ name %> = {
+    <%~ _.map($content, ({ key, value }) => `${key}: ${value}`).join(",\n    ") %>
+  } as const;
+  export type <%~ name %> = (typeof <%~ name %>)[keyof typeof <%~ name %>];
+<% } else if (config.enumStyle === "union") { %>
   export type <%~ name %> = <%~ _.map($content, ({ value }) => value).join(" | ") %>
 <% } else { %>
   export enum <%~ name %> {

package/templates/base/http-clients/axios-http-client.ejs

@@ -1,5 +1,6 @@
 <%
 const { apiConfig, generateResponses, config } = it;
+const CT = includeFile("@base/content-type-accessors", { config });
 %>
 
 import type { AxiosInstance, AxiosRequestConfig, HeadersDefaults, ResponseType, AxiosResponse } from "axios";
@@ -30,6 +31,18 @@ export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequest
   format?: ResponseType;
 }
 
+<% if (config.enumStyle === "const") { %>
+export const ContentType = {
+  Json: "application/json",
+  JsonApi: "application/vnd.api+json",
+  FormData: "multipart/form-data",
+  UrlEncoded: "application/x-www-form-urlencoded",
+  Text: "text/plain",
+} as const;
+export type ContentType = (typeof ContentType)[keyof typeof ContentType];
+<% } else if (config.enumStyle === "union") { %>
+export type ContentType = "application/json" | "application/vnd.api+json" | "multipart/form-data" | "application/x-www-form-urlencoded" | "text/plain";
+<% } else { %>
 export enum ContentType {
   Json = "application/json",
   JsonApi = "application/vnd.api+json",
@@ -37,6 +50,7 @@ export enum ContentType {
   UrlEncoded = "application/x-www-form-urlencoded",
   Text = "text/plain",
 }
+<% } %>
 
 export class HttpClient<SecurityDataType = unknown> {
     public instance: AxiosInstance;
@@ -116,11 +130,11 @@ export class HttpClient<SecurityDataType = unknown> {
         const requestParams = this.mergeRequestParams(params, secureParams);
         const responseFormat = (format || this.format) || undefined;
 
-        if (type === ContentType.FormData && body && body !== null && typeof body === "object") {
+        if (type === <%~ CT.FormData %> && body && body !== null && typeof body === "object") {
           body = this.createFormData(body as Record<string, unknown>);
         }
 
-        if (type === ContentType.Text && body && body !== null && typeof body !== "string") {
+        if (type === <%~ CT.Text %> && body && body !== null && typeof body !== "string") {
           body = JSON.stringify(body);
         }
 

package/templates/base/http-clients/fetch-http-client.ejs

@@ -1,5 +1,6 @@
 <%
 const { apiConfig, generateResponses, config } = it;
+const CT = includeFile("@base/content-type-accessors", { config });
 %>
 
 export type QueryParamsType = Record<string | number, any>;
@@ -41,6 +42,18 @@ export interface HttpResponse<D extends unknown, E extends unknown = unknown> ex
 
 type CancelToken = Symbol | string | number;
 
+<% if (config.enumStyle === "const") { %>
+export const ContentType = {
+    Json: "application/json",
+    JsonApi: "application/vnd.api+json",
+    FormData: "multipart/form-data",
+    UrlEncoded: "application/x-www-form-urlencoded",
+    Text: "text/plain",
+} as const;
+export type ContentType = (typeof ContentType)[keyof typeof ContentType];
+<% } else if (config.enumStyle === "union") { %>
+export type ContentType = "application/json" | "application/vnd.api+json" | "multipart/form-data" | "application/x-www-form-urlencoded" | "text/plain";
+<% } else { %>
 export enum ContentType {
     Json = "application/json",
     JsonApi = "application/vnd.api+json",
@@ -48,6 +61,7 @@ export enum ContentType {
     UrlEncoded = "application/x-www-form-urlencoded",
     Text = "text/plain",
 }
+<% } %>
 
 export class HttpClient<SecurityDataType = unknown> {
     public baseUrl: string = "<%~ apiConfig.baseUrl %>";
@@ -103,10 +117,10 @@ export class HttpClient<SecurityDataType = unknown> {
     }
 
     private contentFormatters: Record<ContentType, (input: any) => any> = {
-        [ContentType.Json]: (input:any) => input !== null && (typeof input === "object" || typeof input === "string") ? JSON.stringify(input) : input,
-        [ContentType.JsonApi]: (input:any) => input !== null && (typeof input === "object" || typeof input === "string") ? JSON.stringify(input) : input,
-        [ContentType.Text]: (input:any) => input !== null && typeof input !== "string" ? JSON.stringify(input) : input,
-        [ContentType.FormData]: (input: any) => {
+        [<%~ CT.Json %>]: (input:any) => input !== null && (typeof input === "object" || typeof input === "string") ? JSON.stringify(input) : input,
+        [<%~ CT.JsonApi %>]: (input:any) => input !== null && (typeof input === "object" || typeof input === "string") ? JSON.stringify(input) : input,
+        [<%~ CT.Text %>]: (input:any) => input !== null && typeof input !== "string" ? JSON.stringify(input) : input,
+        [<%~ CT.FormData %>]: (input: any) => {
             if (input instanceof FormData) {
                 return input;
             }
@@ -124,7 +138,7 @@ export class HttpClient<SecurityDataType = unknown> {
                 return formData;
             }, new FormData());
         },
-        [ContentType.UrlEncoded]: (input: any) => this.toQueryString(input),
+        [<%~ CT.UrlEncoded %>]: (input: any) => this.toQueryString(input),
     }
 
     protected mergeRequestParams(params1: RequestParams, params2?: RequestParams): RequestParams {
@@ -181,7 +195,7 @@ export class HttpClient<SecurityDataType = unknown> {
         const secureParams = ((typeof secure === 'boolean' ? secure : this.baseApiParams.secure) && this.securityWorker && await this.securityWorker(this.securityData)) || {};
         const requestParams = this.mergeRequestParams(params, secureParams);
         const queryString = query && this.toQueryString(query);
-        const payloadFormatter = this.contentFormatters[type || ContentType.Json];
+        const payloadFormatter = this.contentFormatters[type || <%~ CT.Json %>];
         const responseFormat = format || requestParams.format;
 
         return this.customFetch(
@@ -190,7 +204,7 @@ export class HttpClient<SecurityDataType = unknown> {
             ...requestParams,
             headers: {
             ...(requestParams.headers || {}),
-            ...(type && type !== ContentType.FormData ? { "Content-Type": type } : {}),
+            ...(type && type !== <%~ CT.FormData %> ? { "Content-Type": type } : {}),
             },
             signal: (cancelToken ? this.createAbortSignal(cancelToken) : requestParams.signal) || null,
             body: typeof body === "undefined" || body === null ? null : payloadFormatter(body),

package/templates/default/procedure-call.ejs

@@ -31,8 +31,9 @@ const rawWrapperArgs = config.extractRequestParams ?
     _.compact([
         requestParams && {
           name: extractedRequestParamsName,
-          optional: false,
+          optional: route.request.requestParamsOptional,
           type: getInlineParseContent(requestParams),
+          defaultValue: route.request.requestParamsOptional ? '{}' : undefined,
         },
         ...(!requestParams ? pathParams : []),
         payload,
@@ -52,13 +53,7 @@ const wrapperArgs = _
     .join(', ')
 
 // RequestParams["type"]
-const requestContentKind = {
-    "JSON": "ContentType.Json",
-    "JSON_API": "ContentType.JsonApi",
-    "URL_ENCODED": "ContentType.UrlEncoded",
-    "FORM_DATA": "ContentType.FormData",
-    "TEXT": "ContentType.Text",
-}
+const requestContentKind = includeFile("@base/content-type-accessors", { config });
 // RequestParams["format"]
 const responseContentKind = {
     "JSON": '"json"',

package/templates/modular/api.ejs

@@ -8,7 +8,11 @@ const dataContracts = _.map(modelTypes, "name");
 
 <% if (config.httpClientType === config.constants.HTTP_CLIENT.AXIOS) { %> import type { AxiosRequestConfig, AxiosResponse } from "axios"; <% } %>
 
+<% if (config.enumStyle === "union") { %>
+import { HttpClient, RequestParams, type ContentType, HttpResponse } from "./<%~ config.fileNames.httpClient %>";
+<% } else { %>
 import { HttpClient, RequestParams, ContentType, HttpResponse } from "./<%~ config.fileNames.httpClient %>";
+<% } %>
 <% if (dataContracts.length) { %>
 import { <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %>"
 <% } %>

package/templates/modular/procedure-call.ejs

@@ -31,8 +31,9 @@ const rawWrapperArgs = config.extractRequestParams ?
     _.compact([
         requestParams && {
           name: extractedRequestParamsName,
-          optional: false,
+          optional: route.request.requestParamsOptional,
           type: getInlineParseContent(requestParams),
+          defaultValue: route.request.requestParamsOptional ? '{}' : undefined,
         },
         ...(!requestParams ? pathParams : []),
         payload,
@@ -52,13 +53,7 @@ const wrapperArgs = _
     .join(', ')
 
 // RequestParams["type"]
-const requestContentKind = {
-    "JSON": "ContentType.Json",
-    "JSON_API": "ContentType.JsonApi",
-    "URL_ENCODED": "ContentType.UrlEncoded",
-    "FORM_DATA": "ContentType.FormData",
-    "TEXT": "ContentType.Text",
-}
+const requestContentKind = includeFile("@base/content-type-accessors", { config });
 // RequestParams["format"]
 const responseContentKind = {
     "JSON": '"json"',