Add ability to inject our custom multer instance to tsoa

[lalchan]

Sorting

• I'm submitting a ...

  • bug report
  • feature request
  • support request

• I confirm that I

  • used the search to make sure that a similar issue hasn't already been submit

Expected Behavior

Ability to add my own custom multer instance to the tsoa instance as follow:

const multerInstance: Multer.Multer = multer({ ...your config here});

// it could be something like
RegisterRoutes(app, {
    multer: multerInstance
});

since above method seems out of scope for the RegisterRoutes function, we could do something like

RegisterMulter(multerInstance);
RegisterRoutes(app);

the above code would provide tsoa with the themulterInstance which it would use as it's multer instance instead of initializing it's own multer instance.

Current Behavior

Although we can customize the multerOpts using the tsoa.json, it seems to be incomplete as it is incapable of inserting storage engine to the multerOpts, rightfully so as it is a json file. This has caused some issue when i wanted to use multer-s3 as the storage engine for multer and also maintain the single truth in controller idea.

• Using the @UploadedFile decorator will use the tsoa's multer instance, which cannot use multer-s3 is not a valid option.

• Inserting my own multer middleware on top of the decorator will cause the request to fail as two multer instances(my multer-s3 multer instance and tsoa's multer instance) try to read file from the same request.

• Only using the middleware will cause the swagger file to not have information about the file(although this can be mitigated by using this guide, I think this is a tedious and bandaid solution which doesn't follow the tsoa mantra of having single truth controller)

Possible Solution

See Expected Behaviour

P.S. I am new here, if I broke any rules, i apologize in advance.

[github-actions]

Hello there lalchan 👋

Thank you for opening your very first issue in this project.

We will try to get back to you as soon as we can.👀

[WoH]

Would you like to submit a PR for this?
We can probably even deprecate the old way in this case, which is more flexible.
For convenience, the api should probably be RegisterRoutes(app, {multer}), I like that suggestion

[lalchan]

Since I am new to this, I don't know what responsibilities submitting a PR include, will be submitting a PR as soon as I am available to work on this.