fix(typescript-axios-slim): add response unwrap toggle

Author: scarf005

docs/generators/typescript-axios-slim.md

@@ -42,6 +42,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
 |stringEnums|Generate string enums instead of objects for enum values.| |false|
 |supportsES6|Generate code that conforms to ES6.| |false|
+|unwrapResponseData|Whether generated API methods return payload data directly (`Promise<T>`) instead of the full Axios response (`Promise<AxiosResponse<T>>`). Set to `false` to retain access to response headers and status metadata.| |true|
 |useSquareBracketsInArrayNames|Setting this property to true will add brackets to array attribute names, e.g. my_values[].| |false|
 |withAWSV4Signature|whether to include AWS v4 signature support| |false|
 |withInterfaces|Setting this property to true will generate interfaces next to the default class implementations.| |false|

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptAxiosSlimClientCodegen.java

@@ -17,13 +17,20 @@
 
 package org.openapitools.codegen.languages;
 
+import io.swagger.v3.parser.util.SchemaTypeUtil;
+import org.openapitools.codegen.CliOption;
+
 public class TypeScriptAxiosSlimClientCodegen extends TypeScriptAxiosClientCodegen {
+    public static final String UNWRAP_RESPONSE_DATA = "unwrapResponseData";
+
+    private boolean unwrapResponseData = true;
 
     public TypeScriptAxiosSlimClientCodegen() {
         super();
         outputFolder = "generated-code/typescript-axios-slim";
         embeddedTemplateDir = templateDir = "typescript-axios-slim";
         cliOptions.removeIf(option -> USE_SINGLE_REQUEST_PARAMETER.equals(option.getOpt()));
+        cliOptions.add(new CliOption(UNWRAP_RESPONSE_DATA, "Whether to return payload data directly (`Promise<T>`) instead of the full Axios response.", SchemaTypeUtil.BOOLEAN_TYPE).defaultValue(Boolean.TRUE.toString()));
         additionalProperties.put(USE_SINGLE_REQUEST_PARAMETER, true);
     }
 
@@ -32,6 +39,10 @@ public void processOpts() {
         additionalProperties.put(USE_SINGLE_REQUEST_PARAMETER, true);
         super.processOpts();
         additionalProperties.put(USE_SINGLE_REQUEST_PARAMETER, true);
+        if (additionalProperties.containsKey(UNWRAP_RESPONSE_DATA)) {
+            unwrapResponseData = convertPropertyToBoolean(UNWRAP_RESPONSE_DATA);
+        }
+        writePropertyBack(UNWRAP_RESPONSE_DATA, unwrapResponseData);
     }
 
     @Override

modules/openapi-generator/src/main/resources/typescript-axios-slim/README.mustache

@@ -2,7 +2,7 @@
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
-> `typescript-axios-slim` intentionally differs from `typescript-axios`: it removes `AxiosParamCreator`, `Fp`, and `Factory` layers, always uses a single request-parameter object per operation, and emits direct class methods with request-parameter schema validation.
+> `typescript-axios-slim` intentionally differs from `typescript-axios`: it removes `AxiosParamCreator`, `Fp`, and `Factory` layers, always uses a single request-parameter object per operation, and emits direct class methods with request-parameter schema validation. By default methods resolve payload data directly; set `unwrapResponseData=false` to return full `AxiosResponse` values when you need headers or status metadata.
 
 Environment
 * Node.js

modules/openapi-generator/src/main/resources/typescript-axios-slim/api.mustache

@@ -5,7 +5,7 @@
 
 {{^withSeparateModelsAndApi}}
 import type { Configuration } from './configuration{{importFileExtension}}';
-import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import type { AxiosInstance, RawAxiosRequestConfig, AxiosResponse } from 'axios';
 import globalAxios from 'axios';
 {{#withNodeImports}}
 // URLSearchParams not necessarily used

modules/openapi-generator/src/main/resources/typescript-axios-slim/apiInner.mustache

@@ -5,7 +5,7 @@
 
 
 import type { Configuration } from '{{apiRelativeToRoot}}configuration{{importFileExtension}}';
-import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import type { AxiosInstance, RawAxiosRequestConfig, AxiosResponse } from 'axios';
 import globalAxios from 'axios';
 {{#withNodeImports}}
 // URLSearchParams not necessarily used
@@ -59,7 +59,7 @@ export interface {{classname}}Interface {
      * @deprecated{{/isDeprecated}}
      * @throws {RequiredError}
      */
-    {{nickname}}({{#allParams.0}}requestParameters{{^hasRequiredParams}}?{{/hasRequiredParams}}: {{classname}}{{operationIdCamelCase}}Request, {{/allParams.0}}options?: RawAxiosRequestConfig): Promise<{{{returnType}}}{{^returnType}}void{{/returnType}}>;
+    {{nickname}}({{#allParams.0}}requestParameters{{^hasRequiredParams}}?{{/hasRequiredParams}}: {{classname}}{{operationIdCamelCase}}Request, {{/allParams.0}}options?: RawAxiosRequestConfig): {{#unwrapResponseData}}Promise<{{{returnType}}}{{^returnType}}void{{/returnType}}>{{/unwrapResponseData}}{{^unwrapResponseData}}Promise<AxiosResponse<{{{returnType}}}{{^returnType}}void{{/returnType}}>>{{/unwrapResponseData}};
 
 {{/operation}}
 }
@@ -105,7 +105,7 @@ export class {{classname}} extends BaseAPI {
      * @deprecated{{/isDeprecated}}
      * @throws {RequiredError}
      */
-    public async {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request{{^hasRequiredParams}} = {}{{/hasRequiredParams}}, {{/allParams.0}}options: RawAxiosRequestConfig = {}): Promise<{{{returnType}}}{{^returnType}}void{{/returnType}}> {
+    public async {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request{{^hasRequiredParams}} = {}{{/hasRequiredParams}}, {{/allParams.0}}options: RawAxiosRequestConfig = {}): {{#unwrapResponseData}}Promise<{{{returnType}}}{{^returnType}}void{{/returnType}}>{{/unwrapResponseData}}{{^unwrapResponseData}}Promise<AxiosResponse<{{{returnType}}}{{^returnType}}void{{/returnType}}>>{{/unwrapResponseData}} {
     {{#allParams.0}}
         validateRequestParameters('{{nickname}}', {{nickname}}RequestSchema, requestParameters);
     {{/allParams.0}}
@@ -299,8 +299,8 @@ export class {{classname}} extends BaseAPI {
         const effectiveBasePath = localVarOperationServerBasePath || this.basePath || BASE_PATH;
         localVarRequestOptions.url = (this.axios.defaults.baseURL ? '' : this.configuration?.basePath ?? effectiveBasePath) + toPathString(localVarUrlObj);
 
-        const localVarResponse = await this.axios.request<{{{returnType}}}{{^returnType}}void{{/returnType}}>(localVarRequestOptions);
-        return localVarResponse.data;
+        {{#unwrapResponseData}}const localVarResponse = await this.axios.request<{{{returnType}}}{{^returnType}}void{{/returnType}}>(localVarRequestOptions);
+        return localVarResponse.data;{{/unwrapResponseData}}{{^unwrapResponseData}}return this.axios.request<{{{returnType}}}{{^returnType}}void{{/returnType}}, AxiosResponse<{{{returnType}}}{{^returnType}}void{{/returnType}}>>(localVarRequestOptions);{{/unwrapResponseData}}
     }
     {{^-last}}
 

modules/openapi-generator/src/test/java/org/openapitools/codegen/typescript/axios/TypeScriptAxiosSlimParityTest.java

@@ -131,6 +131,17 @@ public void shouldReturnPayloadDataFromObjectOrientedMethods() throws Exception
         assertTrue(apiSource.contains("return localVarResponse.data;"), "Slim API class should resolve axios response data directly");
     }
 
+    @Test(description = "slim: full axios responses remain available when payload unwrapping is disabled")
+    public void shouldReturnAxiosResponsesWhenPayloadUnwrappingDisabled() throws Exception {
+        IdentitySurface slimSurface = generateIdentity("typescript-axios-slim", EDGE_CASE_SPEC,
+                cfg -> cfg.addAdditionalProperty("unwrapResponseData", false));
+        String apiSource = String.join(" ", slimSurface.apiFiles.values());
+
+        assertFalse(apiSource.contains("return localVarResponse.data;"), "Slim API class should not unwrap payload data when disabled");
+        assertTrue(apiSource.contains("Promise<AxiosResponse<"), "Slim API class should return Promise<AxiosResponse<T>> when payload unwrapping is disabled");
+        assertTrue(apiSource.contains("return this.axios.request<"), "Slim API class should expose the raw axios response when payload unwrapping is disabled");
+    }
+
     @Test(description = "slim: useSingleRequestParameter remains enabled even if configured false")
     public void shouldForceSingleRequestParameterForSlimGenerator() throws Exception {
         Consumer<CodegenConfigurator> forceSingleRequestFalse = cfg -> cfg.addAdditionalProperty("useSingleRequestParameter", false);