fix(medusa): Correct MedusaRequest query type #14100

NicolasGorga · 2025-11-20T16:15:14Z

Summary

What — What changes are introduced in this PR?

Updates MedusaRequest generics in /store/currencies get endpoints.

Why — Why are these changes relevant or necessary?

To align the body and query types to what is actually expected.

How — How have these changes been implemented?

Corrected MedusaRequest generics adding undefined as the first type parameter so the already passed type is correctly mapped to query instead of body.

Testing — How have these changes been tested, or how can the reviewer test the feature?

Examples

Provide examples or code snippets that demonstrate how this feature works, or how it can be used in practice.
This helps with documentation and ensures maintainers can quickly understand and verify the change.

// Example usage

Checklist

Please ensure the following before requesting a review:

I have added a changeset for this PR
- Every non-breaking change should be marked as a patch
- To add a changeset, run yarn changeset and follow the prompts
The changes are covered by relevant tests
I have verified the code works as intended locally
I have linked the related issue(s) if applicable

Additional Context

Add any additional context, related issues, or references that might help the reviewer understand this PR.

closes ENTSUP-279

cursor · 2025-11-20T16:15:18Z

You have run out of free Bugbot PR reviews for this billing cycle. This will reset on December 17.

To receive reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.

changeset-bot · 2025-11-20T16:15:19Z

🦋 Changeset detected

Latest commit: 39aeddf

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

This PR includes changesets to release 74 packages

Name	Type
@medusajs/medusa	Patch
@medusajs/test-utils	Patch
@medusajs/medusa-oas-cli	Patch
integration-tests-http	Patch
@medusajs/analytics	Patch
@medusajs/api-key	Patch
@medusajs/auth	Patch
@medusajs/caching	Patch
@medusajs/cart	Patch
@medusajs/currency	Patch
@medusajs/customer	Patch
@medusajs/file	Patch
@medusajs/fulfillment	Patch
@medusajs/index	Patch
@medusajs/inventory	Patch
@medusajs/link-modules	Patch
@medusajs/locking	Patch
@medusajs/notification	Patch
@medusajs/order	Patch
@medusajs/payment	Patch
@medusajs/pricing	Patch
@medusajs/product	Patch
@medusajs/promotion	Patch
@medusajs/region	Patch
@medusajs/sales-channel	Patch
@medusajs/settings	Patch
@medusajs/stock-location	Patch
@medusajs/store	Patch
@medusajs/tax	Patch
@medusajs/user	Patch
@medusajs/workflow-engine-inmemory	Patch
@medusajs/workflow-engine-redis	Patch
@medusajs/draft-order	Patch
@medusajs/oas-github-ci	Patch
@medusajs/cache-inmemory	Patch
@medusajs/cache-redis	Patch
@medusajs/event-bus-local	Patch
@medusajs/event-bus-redis	Patch
@medusajs/analytics-local	Patch
@medusajs/analytics-posthog	Patch
@medusajs/auth-emailpass	Patch
@medusajs/auth-github	Patch
@medusajs/auth-google	Patch
@medusajs/caching-redis	Patch
@medusajs/file-local	Patch
@medusajs/file-s3	Patch
@medusajs/fulfillment-manual	Patch
@medusajs/locking-postgres	Patch
@medusajs/locking-redis	Patch
@medusajs/notification-local	Patch
@medusajs/notification-sendgrid	Patch
@medusajs/payment-stripe	Patch
@medusajs/core-flows	Patch
@medusajs/framework	Patch
@medusajs/js-sdk	Patch
@medusajs/modules-sdk	Patch
@medusajs/orchestration	Patch
@medusajs/types	Patch
@medusajs/utils	Patch
@medusajs/workflows-sdk	Patch
@medusajs/cli	Patch
@medusajs/deps	Patch
@medusajs/telemetry	Patch
@medusajs/admin-bundler	Patch
@medusajs/admin-sdk	Patch
@medusajs/admin-shared	Patch
@medusajs/admin-vite-plugin	Patch
@medusajs/dashboard	Patch
@medusajs/icons	Patch
@medusajs/toolbox	Patch
@medusajs/ui-preset	Patch
create-medusa-app	Patch
medusa-dev-cli	Patch
@medusajs/ui	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

vercel · 2025-11-20T16:15:20Z

The latest updates on your projects. Learn more about Vercel for GitHub.

8 Skipped Deployments

Project	Deployment	Preview	Updated (UTC)
api-reference	Ignored		Nov 27, 2025 4:34pm
api-reference-v2	Ignored	Preview	Nov 27, 2025 4:34pm
cloud-docs	Ignored	Preview	Nov 27, 2025 4:34pm
docs-ui	Ignored	Preview	Nov 27, 2025 4:34pm
docs-v2	Ignored	Preview	Nov 27, 2025 4:34pm
medusa-docs	Ignored	Preview	Nov 27, 2025 4:34pm
resources-docs	Ignored	Preview	Nov 27, 2025 4:34pm
user-guide	Ignored	Preview	Nov 27, 2025 4:34pm

olivermrbl

pretty sure we have done this all over the place; are you sure this is correct? if so, maybe we need to update more places

NicolasGorga · 2025-11-24T11:09:50Z

pretty sure we have done this all over the place; are you sure this is correct? if so, maybe we need to update more places

I'm positive. Included fixes to all the incorrect usages.

adrien2p

I think it is fine, I am just wondering if it would make sense to do something like this

export interface AuthenticatedMedusaRequest<
  BodyOrQueryFields = unknown,
  QueryFields extends Record<string, unknown> = {}
> extends MedusaRequest<
    {} extends QueryFields ? undefined : BodyOrQueryFields,
    {} extends QueryFields
      ? BodyOrQueryFields & Record<string, unknown>
      : QueryFields
  > {
  auth_context: AuthContext
  publishable_key_context?: PublishableKeyContext
}

export interface MedusaRequest<
  Body = unknown,
  QueryFields extends Record<string, unknown> = {}
> extends Request<
    { [key: string]: string },
    any,
    {} extends QueryFields ? Body : undefined
  > {
  validatedBody: {} extends QueryFields ? undefined : Body
  validatedQuery: {} extends QueryFields
    ? RequestQueryFields
    : RequestQueryFields & QueryFields
//...

Here we would allow for

single template args -> query fields
both -> body, fields

Let me know if that makes sense guys (cc @olivermrbl)

NicolasGorga · 2025-11-25T10:05:35Z

I think it is fine, I am just wondering if it would make sense to do something like this

export interface AuthenticatedMedusaRequest<
  BodyOrQueryFields = unknown,
  QueryFields extends Record<string, unknown> = {}
> extends MedusaRequest<
    {} extends QueryFields ? undefined : BodyOrQueryFields,
    {} extends QueryFields
      ? BodyOrQueryFields & Record<string, unknown>
      : QueryFields
  > {
  auth_context: AuthContext
  publishable_key_context?: PublishableKeyContext
}

export interface MedusaRequest<
  Body = unknown,
  QueryFields extends Record<string, unknown> = {}
> extends Request<
    { [key: string]: string },
    any,
    {} extends QueryFields ? Body : undefined
  > {
  validatedBody: {} extends QueryFields ? undefined : Body
  validatedQuery: {} extends QueryFields
    ? RequestQueryFields
    : RequestQueryFields & QueryFields
//...

Here we would allow for

single template args -> query fields
both -> body, fields

Let me know if that makes sense guys (cc @olivermrbl)

I like this since I think users might not consistently understand that they should put undefined as the first type parameter for requests without a body. Additionally, it is more convenient not to have to do this in these cases and simply specify the query parameter type. Let me know wyt Oli, and I'll proceed with the update.

…ed when only one type param provided

NicolasGorga · 2025-11-26T14:10:47Z

Hey @adrien2p I've updated the types with your suggestion, with a small correction on the MedusaRequest type if you could check?

Also, if you could help me know how we could handle the following error when building in packages/core/framework/src

src/http/utils/validate-body.ts:31:7 - error TS2322: Type 'ZodRawShape' is not assignable to type 'undefined'.

31       req.validatedBody = await zodValidator(schema, req.body)
         ~~~~~~~~~~~~~~~~~


Found 1 error.

This happens when not providing any types. QueryFields is the default value, which treats the Body param as the query one and evaluates to undefined.

olivermrbl

Neat

didn't see the discussion, I think adrien's suggestion makes sense to incorporate if its feasible

NicolasGorga · 2025-11-27T10:41:11Z

Yes, added the changes to the type as per Adrien suggestion, though that introduces the issue I mentioned in my last comment when we don't pass the types and use defaults, while try to assign to validatedBody, since in these cases it is treated as undefined (as per the "if only one type provided, we assume no body and only query"). I will wait for his input :)

adrien2p · 2025-11-27T12:38:49Z

Yes, added the changes to the type as per Adrien suggestion, though that introduces the issue I mentioned in my last comment when we don't pass the types and use defaults, while try to assign to validatedBody, since in these cases it is treated as undefined (as per the "if only one type provided, we assume no body and only query"). I will wait for his input :)

Yeah I ve suggeted undefined but it can be a record or unknown or something like that, the main idea is to route the correct template args to the correct location 👍

NicolasGorga · 2025-11-27T16:39:06Z

I am still having build issues, thinking of how to solve this with the changes we did

NicolasGorga added 2 commits November 20, 2025 16:58

Update store currencies MedusaRequest generics type

d0b6e6f

Add changeset

17288c3

NicolasGorga requested a review from a team as a code owner November 20, 2025 16:15

github-actions bot added type: bug team: medusa labels Nov 20, 2025

olivermrbl reviewed Nov 24, 2025

View reviewed changes

NicolasGorga added 2 commits November 24, 2025 08:07

Fix query types for all MedusaRequest usages

4f3dc77

Update changeset

e959ff5

NicolasGorga requested a review from olivermrbl November 24, 2025 11:10

adrien2p reviewed Nov 25, 2025

View reviewed changes

NicolasGorga changed the title ~~fix(medusa): Correct MedusaRequest generics in /store/currencies endpoint~~ fix(medusa): Correct MedusaRequest query type Nov 26, 2025

NicolasGorga added 3 commits November 26, 2025 11:05

Update Request types to treat type param as query and body as undefin…

a8fb0fa

…ed when only one type param provided

Update MedusaStoreRequest to work with updated MedusaRequest type

40d6b8a

Update test types

6f8320e

olivermrbl previously approved these changes Nov 27, 2025

View reviewed changes

Allow for broader type when QueryParams not provided

39aeddf

adrien2p approved these changes Nov 27, 2025

View reviewed changes

Uh oh!

fix(medusa): Correct MedusaRequest query type #14100

Are you sure you want to change the base?

fix(medusa): Correct MedusaRequest query type #14100

Uh oh!

Conversation

NicolasGorga commented Nov 20, 2025

Summary

Examples

Checklist

Additional Context

Uh oh!

cursor bot commented Nov 20, 2025

Uh oh!

changeset-bot bot commented Nov 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

vercel bot commented Nov 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

olivermrbl left a comment

Choose a reason for hiding this comment

Uh oh!

NicolasGorga commented Nov 24, 2025

Uh oh!

adrien2p left a comment

Choose a reason for hiding this comment

Uh oh!

NicolasGorga commented Nov 25, 2025

Uh oh!

NicolasGorga commented Nov 26, 2025

Uh oh!

olivermrbl left a comment

Choose a reason for hiding this comment

Uh oh!

NicolasGorga commented Nov 27, 2025

Uh oh!

adrien2p commented Nov 27, 2025

Uh oh!

NicolasGorga commented Nov 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

changeset-bot bot commented Nov 20, 2025 •

edited

Loading

vercel bot commented Nov 20, 2025 •

edited

Loading