Skip to content
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

Preserve model.enum case in generated query-entry-points.d.ts #11354

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

dominicrathbone
Copy link

@dominicrathbone dominicrathbone commented Feb 6, 2025

A field defined using model.enum does not have it's case preserved in the corresponding generated TS types in /.medusa/types/query-entry-points.d.ts, resulting in:

  • if a value corresponding with the values in model.enum is used in query.graph, a compile error is thrown.
  • if a value corresponding to the values generated in query-entry-points.d.ts is used, the downstream graphql query generated is incorrect.

This reserves some of the changes in #8985

Example

// model
export const example = model.define('example', {
    id: model.id().primaryKey(),
    status: model.enum(['pending', 'accepted', 'rejected']).default('pending')
})
// query-entry-points.d.ts
export enum ExampleStatusEnum {
  Pending = 'PENDING',
  Accepted = 'ACCEPTED',
  Rejected = 'REJECTED'
}
// query
enum ExampleStatusEnum {
    Pending = 'pending',
    Accepted = 'accepted',
    Rejected = 'rejected'
}

query.graph({
    entity: 'example',
    fields: ['id', 'status'],
    filters: {
        status: ExampleStatusEnum.Pending // Compilation error thrown
    }
})

A field defined using `model.enum` does not have it's case preserved in the corresponding generated TS types in `/.medusa/types/query-entry-points.d.ts`, resulting in:
* if a value corresponding with the values in `model.enum` is used in `query.graph`, a compile error is thrown.
* if a value corresponding to the values generated in `query-entry-points.d.ts` is used, the downstream graphql query generated is incorrect.
Copy link

changeset-bot bot commented Feb 6, 2025

⚠️ No Changeset found

Latest commit: 1b345b9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link

vercel bot commented Feb 6, 2025

@dominicrathbone is attempting to deploy a commit to the medusajs Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant