Add optional AxiosRequestConfig parameter to typescript-nestjs service functions #20222

GregoryMerlet · 2024-12-02T16:33:27Z

Closes #20221

PR checklist

Read the contribution guidelines.
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
Run the following to build the project and update samples:
```
./mvnw clean package || exit
./bin/generate-samples.sh ./bin/configs/*.yaml || exit
./bin/utils/export_docs_generators.sh || exit
```
(For Windows users, please run the script in Git BASH)
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

TypeScript committee members: @TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04) @joscha (2024/10)

GregoryMerlet · 2025-01-28T09:12:16Z

Hi @TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov @davidgamero @mkusaka @joscha
This would be a great improvement for my team, could someone take a look at it?
Thanks

joscha

I think this makes sense to have? @macjohnny WDYT?

macjohnny · 2024-12-03T10:45:33Z

modules/openapi-generator/src/main/resources/typescript-nestjs/api.service.mustache

     */
    {{#useSingleRequestParameter}}
-    public {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request, {{/allParams.0}}): Observable<AxiosResponse<{{#returnType}}{{{returnType}}}{{#isResponseTypeFile}}|undefined{{/isResponseTypeFile}}{{/returnType}}{{^returnType}}any{{/returnType}}>>;
-    public {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request, {{/allParams.0}}): Observable<any> {
+    public {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request, {{/allParams.0}}options?: AxiosRequestConfig): Observable<AxiosResponse<{{#returnType}}{{{returnType}}}{{#isResponseTypeFile}}|undefined{{/isResponseTypeFile}}{{/returnType}}{{^returnType}}any{{/returnType}}>>;


lets make it a named parameter and a less generic name to avoid clashes with other parameters:

{{nickname}}RequestConfig: {options?: AxiosRequestConfig}

@joscha wdyt?

Yes, good feedback, I like it.

joscha · 2025-01-28T16:09:26Z

modules/openapi-generator/src/main/resources/typescript-nestjs/api.service.mustache

     */
    {{#useSingleRequestParameter}}
-    public {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request, {{/allParams.0}}): Observable<AxiosResponse<{{#returnType}}{{{returnType}}}{{#isResponseTypeFile}}|undefined{{/isResponseTypeFile}}{{/returnType}}{{^returnType}}any{{/returnType}}>>;
-    public {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request, {{/allParams.0}}): Observable<any> {
+    public {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request, {{/allParams.0}}{{nickname}}RequestConfig?: { options?: AxiosRequestConfig }): Observable<AxiosResponse<{{#returnType}}{{{returnType}}}{{#isResponseTypeFile}}|undefined{{/isResponseTypeFile}}{{/returnType}}{{^returnType}}any{{/returnType}}>>;


is there a better name, now that it is a pojo with an options config object?

Suggested change

public {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request, {{/allParams.0}}{{nickname}}RequestConfig?: { options?: AxiosRequestConfig }): Observable<AxiosResponse<{{#returnType}}{{{returnType}}}{{#isResponseTypeFile}}|undefined{{/isResponseTypeFile}}{{/returnType}}{{^returnType}}any{{/returnType}}>>;

public {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request, {{/allParams.0}}{{nickname}}Opts?: { options?: AxiosRequestConfig }): Observable<AxiosResponse<{{#returnType}}{{{returnType}}}{{#isResponseTypeFile}}|undefined{{/isResponseTypeFile}}{{/returnType}}{{^returnType}}any{{/returnType}}>>;

Suggested change

public {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request, {{/allParams.0}}{{nickname}}RequestConfig?: { options?: AxiosRequestConfig }): Observable<AxiosResponse<{{#returnType}}{{{returnType}}}{{#isResponseTypeFile}}|undefined{{/isResponseTypeFile}}{{/returnType}}{{^returnType}}any{{/returnType}}>>;

public {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request, {{/allParams.0}}{{nickname}}Config?: { options?: AxiosRequestConfig }): Observable<AxiosResponse<{{#returnType}}{{{returnType}}}{{#isResponseTypeFile}}|undefined{{/isResponseTypeFile}}{{/returnType}}{{^returnType}}any{{/returnType}}>>;

or something? Given the AxiosRequestConfig is now only one of potentially many items?

Also:

Suggested change

public {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request, {{/allParams.0}}{{nickname}}RequestConfig?: { options?: AxiosRequestConfig }): Observable<AxiosResponse<{{#returnType}}{{{returnType}}}{{#isResponseTypeFile}}|undefined{{/isResponseTypeFile}}{{/returnType}}{{^returnType}}any{{/returnType}}>>;

public {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request, {{/allParams.0}}{{nickname}}RequestConfig?: { config?: AxiosRequestConfig }): Observable<AxiosResponse<{{#returnType}}{{{returnType}}}{{#isResponseTypeFile}}|undefined{{/isResponseTypeFile}}{{/returnType}}{{^returnType}}any{{/returnType}}>>;

given the name of the class/interface?

Yes, it's a good idea, so more like this?

{{nickname}}Opts?: { config?: AxiosRequestConfig }

@macjohnny wdyt ?

macjohnny · 2025-01-28T16:18:54Z

modules/openapi-generator/src/main/resources/typescript-nestjs/api.service.mustache

@@ -291,7 +292,8 @@ export class {{classname}} {
                        responseType: "blob",
        {{/isResponseFile}}
                        withCredentials: this.configuration.withCredentials,
-                        headers: headers
+                        headers: {...headers, ...{{nickname}}RequestConfig?.options?.headers},
+                        ...{{nickname}}RequestConfig?.options,


shouldnt the lines be swapped to make sure the original headers are not completely overwritten if some headers are set in the options?

Oh yes right !

joscha · 2025-01-28T16:57:40Z

modules/openapi-generator/src/main/resources/typescript-nestjs/api.service.mustache

@@ -8,7 +8,7 @@ import { HttpService } from '@nestjs/axios';
 {{^useAxiosHttpModule}}
 import { HttpService, Injectable, Optional } from '@nestjs/common';
 {{/useAxiosHttpModule}}
-import { AxiosResponse } from 'axios';
+import { AxiosRequestConfig, AxiosResponse } from 'axios';


I just noticed: should this be be a type only import if we assume TS > 3.8?

refs #20064

macjohnny

thanks for applying the changes!

GregoryMerlet changed the title ~~feat: add options to service functions~~ optional AxiosRequestConfig parameter to typescript-nestjs service functions Dec 2, 2024

GregoryMerlet changed the title ~~optional AxiosRequestConfig parameter to typescript-nestjs service functions~~ Add optional AxiosRequestConfig parameter to typescript-nestjs service functions Dec 2, 2024

joscha approved these changes Jan 28, 2025

View reviewed changes

macjohnny reviewed Jan 28, 2025

View reviewed changes

GregoryMerlet added 3 commits January 28, 2025 16:51

feat: add options to service functions

cc57936

fix: fix type error

8bb7982

refactor: change options parameter

1b84522

GregoryMerlet force-pushed the fix_issue_20221 branch from a1e86e2 to 1b84522 Compare January 28, 2025 15:53

chore: update samples

be1754b

joscha reviewed Jan 28, 2025

View reviewed changes

macjohnny reviewed Jan 28, 2025

View reviewed changes

GregoryMerlet added 2 commits January 28, 2025 17:26

fix: fix options use order

fb3c75b

refactor: rename options

4eecf29

joscha reviewed Jan 28, 2025

View reviewed changes

refactor: import type

dd81810

macjohnny approved these changes Jan 29, 2025

View reviewed changes

joscha approved these changes Jan 29, 2025

View reviewed changes

macjohnny merged commit 8c337f0 into OpenAPITools:master Jan 29, 2025
16 checks passed

wing328 added this to the 7.12.0 milestone Feb 27, 2025

macjohnny added the Client: TypeScript label Apr 2, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Add optional AxiosRequestConfig parameter to typescript-nestjs service functions #20222

Add optional AxiosRequestConfig parameter to typescript-nestjs service functions #20222

GregoryMerlet commented Dec 2, 2024

Uh oh!

GregoryMerlet commented Jan 28, 2025

Uh oh!

joscha left a comment

Uh oh!

macjohnny Dec 3, 2024

Uh oh!

joscha Jan 28, 2025

Uh oh!

joscha Jan 28, 2025

Uh oh!

GregoryMerlet Jan 28, 2025

Uh oh!

macjohnny Jan 28, 2025

Uh oh!

macjohnny Jan 28, 2025

Uh oh!

GregoryMerlet Jan 28, 2025

Uh oh!

joscha Jan 28, 2025

Uh oh!

macjohnny left a comment

Uh oh!

Uh oh!

Uh oh!

	public {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request, {{/allParams.0}}{{nickname}}RequestConfig?: { options?: AxiosRequestConfig }): Observable<AxiosResponse<{{#returnType}}{{{returnType}}}{{#isResponseTypeFile}}\|undefined{{/isResponseTypeFile}}{{/returnType}}{{^returnType}}any{{/returnType}}>>;
	public {{nickname}}({{#allParams.0}}requestParameters: {{classname}}{{operationIdCamelCase}}Request, {{/allParams.0}}{{nickname}}Opts?: { options?: AxiosRequestConfig }): Observable<AxiosResponse<{{#returnType}}{{{returnType}}}{{#isResponseTypeFile}}\|undefined{{/isResponseTypeFile}}{{/returnType}}{{^returnType}}any{{/returnType}}>>;

Uh oh!

Add optional AxiosRequestConfig parameter to typescript-nestjs service functions #20222

Add optional AxiosRequestConfig parameter to typescript-nestjs service functions #20222

Conversation

GregoryMerlet commented Dec 2, 2024

PR checklist

Uh oh!

GregoryMerlet commented Jan 28, 2025

Uh oh!

joscha left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

macjohnny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!