swagger-typescript-api 13.12.5 → 13.13.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "13.12.5",
+  "version": "13.13.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",

package/templates/default/procedure-call.ejs

@@ -46,9 +46,21 @@ const rawWrapperArgs = config.extractRequestParams ?
         requestConfigParam,
     ])
 
+// Before sorting, promote any optional arg that has a defaultValue and is
+// followed by a required arg to "positionally required". The sort still pushes
+// truly-optional (`?:`) args to the end, but defaultable args ahead of a
+// required arg stay in declaration order, so callers' positional arguments
+// don't silently shift when a previously-required query becomes optional.
+const positionedWrapperArgs = rawWrapperArgs.map((arg, i) => {
+    if (arg.optional && arg.defaultValue && rawWrapperArgs.slice(i + 1).some(a => !a.optional)) {
+        return { ...arg, optional: false };
+    }
+    return arg;
+})
+
 const wrapperArgs = _
     // Sort by optionality
-    .sortBy(rawWrapperArgs, [o => o.optional])
+    .sortBy(positionedWrapperArgs, [o => o.optional])
     .map(argToTmpl)
     .join(', ')
 

package/templates/default/route-types.ejs

@@ -5,7 +5,7 @@ const dataContracts = config.modular ? _.map(modelTypes, "name") : [];
 %>
 
 <% if (dataContracts.length) { %>
-import { <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %>"
+import <%~ config.typeOnlyImports ? "type " : "" %>{ <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %><%~ config.importFileExtension %>"
 <% } %>
 
 <%

package/templates/modular/api.ejs

@@ -4,17 +4,18 @@ const { _, pascalCase, require } = utils;
 const apiClassName = pascalCase(route.moduleName);
 const routes = route.routes;
 const dataContracts = _.map(modelTypes, "name");
+const importExt = config.importFileExtension;
+const typeModifier = config.typeOnlyImports ? "type " : "";
+// ContentType is a pure type only for the "union" style; otherwise it is a runtime value.
+const contentTypeSpecifier = config.enumStyle === "union" ? "type ContentType" : "ContentType";
+const httpClientSpecifiers = ["HttpClient", `${typeModifier}RequestParams`, contentTypeSpecifier, `${typeModifier}HttpResponse`].join(", ");
 %>
 
 <% 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 %>";
-<% } %>
+import { <%~ httpClientSpecifiers %> } from "./<%~ config.fileNames.httpClient %><%~ importExt %>";
 <% if (dataContracts.length) { %>
-import { <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %>"
+import <%~ typeModifier %>{ <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %><%~ importExt %>"
 <% } %>
 
 export class <%= apiClassName %><SecurityDataType = unknown><% if (!config.singleHttpClient) { %> extends HttpClient<SecurityDataType> <% } %> {

package/templates/modular/procedure-call.ejs

@@ -46,9 +46,21 @@ const rawWrapperArgs = config.extractRequestParams ?
         requestConfigParam,
     ])
 
+// Before sorting, promote any optional arg that has a defaultValue and is
+// followed by a required arg to "positionally required". The sort still pushes
+// truly-optional (`?:`) args to the end, but defaultable args ahead of a
+// required arg stay in declaration order, so callers' positional arguments
+// don't silently shift when a previously-required query becomes optional.
+const positionedWrapperArgs = rawWrapperArgs.map((arg, i) => {
+    if (arg.optional && arg.defaultValue && rawWrapperArgs.slice(i + 1).some(a => !a.optional)) {
+        return { ...arg, optional: false };
+    }
+    return arg;
+})
+
 const wrapperArgs = _
     // Sort by optionality
-    .sortBy(rawWrapperArgs, [o => o.optional])
+    .sortBy(positionedWrapperArgs, [o => o.optional])
     .map(argToTmpl)
     .join(', ')
 

package/templates/modular/route-types.ejs

@@ -6,7 +6,7 @@ const dataContracts = config.modular ? _.map(modelTypes, "name") : [];
 
 %>
 <% if (dataContracts.length) { %>
-import { <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %>"
+import <%~ config.typeOnlyImports ? "type " : "" %>{ <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %><%~ config.importFileExtension %>"
 <% } %>
 
 export namespace <%~ pascalCase(moduleName) %> {