add custom properties to request object

[FreeAoi]

Changes

What does this PR change? Link to any related issue(s).
This pull request lets request object attach custom properties like next prop on nextjs environment.

How to Review

It should works
How can a reviewer review your changes? What should be kept in mind for this review?

Checklist

• Unit tests updated
• docs/ updated (if necessary)
• pnpm run update:examples run (only applicable for openapi-typescript)

[changeset-bot]

🦋 Changeset detected

Latest commit: 592b0f6

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
openapi-fetch	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[drwpow]

Thanks for adding. Would it be possible to add a test, to ensure the correct usage is working as intended?

[FreeAoi]

Sure

[FreeAoi]

How I should do the unit test?

[drwpow]

How I should do the unit test?

Inside the main test suite, inside middleware, I’d just write a test that creates example middleware and adds the arbitrary property.

Then from the MSW side, assert that the server received the request with that additional property on it (see the can modify request test) as an example).

The bonus part of adding a test is the types will be validated, too. The code you wrote looks good, and it looks like it achieves the desired result! But adding a test guarantees it works as-advertised, and doesn’t throw any errors in TypeScript either.

[FreeAoi]

Should be ready, check it out and let me know your thoughts

[drwpow]

This is great, thank you! Fantastic test!

[drwpow]

🤔 I’m wondering if we need to add docs for this; this may just be an invisible feature. I’m going to release this, and will skip docs for now, but also open to a PR adding docs if it’s helpful.

[FreeAoi]

Hi, I think write docs for this is not necessary because It is not common (it could be a bad practice in fact) monkeypatching request object.

This pr it's principal objective is let request object support custom properties in cases where frameworks like nextjs modified the request interface