Skip to content

feat(typescript-axios): injectable FormData #7455

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

petermetz
Copy link
Contributor

Signed-off-by: Peter Somogyvari [email protected]

Added an optional parameter to the constructor parameters of the Configuration class so that a user defind FormData constructor can be injected in execution environments where FormData is not supported by default (e.g. NodeJS).

This issue is tracking the same problem which I also had and thus this PR was born:
#2939

I tested it by using the generator on a project I'm a maintainer of where we use the tool (thank you very much for the all your work)

What this enables is code like this in my NodeJS test cases:

import FormData from "form-data";

const configuration: Configuration = new Configuration({
  formDataCtor: FormData,
  ...
});
const apiClient = new DefaultApi(configuration);

// now apiClient can work with multipart form data endpoints from 
// NodeJS not just the browser (assuming the npm `form-data` 
// module works as advertised of course).

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.
  • If contributing template-only or documentation-only changes which will change sample output, build the project beforehand.
  • Run the shell script ./bin/generate-samples.shto update all Petstore samples related to your fix. 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*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc technical committee for Typescript and NodeJS:

@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)

@CodeNinjai (2017/07) @frol (2017/07) @cliffano (2017/07)

Copy link
Member

@macjohnny macjohnny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@macjohnny macjohnny merged commit 2768021 into OpenAPITools:master Sep 21, 2020
@macjohnny macjohnny added this to the 5.0.0 milestone Sep 21, 2020
sapphi-red added a commit to sapphi-red/openapi-generator that referenced this pull request Sep 22, 2020
To avoid requiring TypeScript above 3.7.2.
refs OpenAPITools#7455
macjohnny pushed a commit that referenced this pull request Sep 25, 2020
To avoid requiring TypeScript above 3.7.2.
refs #7455
@petermetz petermetz deleted the feat/typescript-axios/injectable-formdata branch December 17, 2020 21:13
fgnass pushed a commit to oazapfts/oazapfts that referenced this pull request Mar 5, 2021
* Allow to return blob for binary data

* Generic param not needed

* Deduplicate

* Improve return type heuristic

* Assume text for content type "text/*"
* Assume text for empty responses (backwards-compatbility)
* Rest will map to Blob

* Consolidate functions to determine response type

* Ensure proper typing for optimistic API

* Improve result type detection

* Allow to customize FormData constructor

Inspired by
* OpenAPITools/openapi-generator#7455
* OpenAPITools/openapi-generator#2939

* Fix defaults.formDataConstructor

* || instead of ??
phryneas pushed a commit to phryneas/oazapfts that referenced this pull request Mar 5, 2021
* Allow to return blob for binary data

* Generic param not needed

* Deduplicate

* Improve return type heuristic

* Assume text for content type "text/*"
* Assume text for empty responses (backwards-compatbility)
* Rest will map to Blob

* Consolidate functions to determine response type

* Ensure proper typing for optimistic API

* Improve result type detection

* Allow to customize FormData constructor

Inspired by
* OpenAPITools/openapi-generator#7455
* OpenAPITools/openapi-generator#2939

* Fix defaults.formDataConstructor

* || instead of ??

(cherry picked from commit cf90725)
fgnass added a commit to oazapfts/oazapfts that referenced this pull request Mar 5, 2021
* convert generateApi function to class

* add reset method

* export methods

* update TS to 4.1.2

* cleanup, make some properties public

* fix: remove special chars (closes #42, #48)

(cherry picked from commit 25d67ba)

* feat(#52): support Blobs

* Allow to return blob for binary data

* Generic param not needed

* Deduplicate

* Improve return type heuristic

* Assume text for content type "text/*"
* Assume text for empty responses (backwards-compatbility)
* Rest will map to Blob

* Consolidate functions to determine response type

* Ensure proper typing for optimistic API

* Improve result type detection

* Allow to customize FormData constructor

Inspired by
* OpenAPITools/openapi-generator#7455
* OpenAPITools/openapi-generator#2939

* Fix defaults.formDataConstructor

* || instead of ??

(cherry picked from commit cf90725)

Co-authored-by: Felix Gnass <[email protected]>
Co-authored-by: Philipp Katz <[email protected]>
@sambacha sambacha mentioned this pull request Mar 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants