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.

Sign up for GitHub

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

Jump to bottom

feat(index): Provide a similar API to Query #9193

Merged
merged 16 commits into from
Sep 20, 2024
Merged

feat(index): Provide a similar API to Query #9193

merged 16 commits into from
Sep 20, 2024

Conversation

adrien2p
Copy link
Member

@adrien2p adrien2p commented Sep 19, 2024 •
edited
Loading

What
Align the index engine API to be similar to the Query API

Example

        // Benefit from the same level of typing like the remote query

        const { data, metadata } = await indexEngine.query<'product'>({
          fields: [
            "product.*",
            "product.variants.*",
            "product.variants.prices.*",
          ],
          filters: {
            product: {
              variants: {
                prices: {
                  amount: { $gt: 50 },
                },
              },
            },
          },
          pagination: {
            order: {
              product: {
                variants: {
                  prices: {
                    amount: "DESC",
                  },
                },
              },
            },
          },
        })

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Sep 19, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: 04efaa9

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

@vercel Vercel
Copy link

vercel bot commented Sep 19, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
medusa-dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 20, 2024 9:48am
6 Skipped Deployments
Name Status Preview Comments Updated (UTC)
api-reference ⬜️ Ignored (Inspect) Sep 20, 2024 9:48am
api-reference-v2 ⬜️ Ignored (Inspect) Visit Preview Sep 20, 2024 9:48am
docs-ui ⬜️ Ignored (Inspect) Visit Preview Sep 20, 2024 9:48am
docs-v2 ⬜️ Ignored (Inspect) Visit Preview Sep 20, 2024 9:48am
medusa-docs ⬜️ Ignored (Inspect) Visit Preview Sep 20, 2024 9:48am
resources-docs ⬜️ Ignored (Inspect) Visit Preview Sep 20, 2024 9:48am

@adrien2p adrien2p marked this pull request as ready for review September 19, 2024 12:07
@adrien2p adrien2p requested a review from a team as a code owner September 19, 2024 12:07
olivermrbl
olivermrbl approved these changes Sep 19, 2024
View reviewed changes
Copy link
Contributor

@olivermrbl olivermrbl left a comment

Choose a reason for hiding this comment

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

Nice work, few comments 💪

packages/modules/index/package.json Outdated Show resolved Hide resolved
packages/modules/index/src/services/index-module-service.ts Outdated Show resolved Hide resolved
packages/modules/index/src/types/index.ts Outdated Show resolved Hide resolved
carlos-r-l-rodrigues
carlos-r-l-rodrigues approved these changes Sep 20, 2024
View reviewed changes
Copy link
Contributor

@carlos-r-l-rodrigues carlos-r-l-rodrigues left a comment

Choose a reason for hiding this comment

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

🔥 🔥 🔥

@kodiakhq kodiakhq bot merged commit 3084008 into develop Sep 20, 2024
23 checks passed
@kodiakhq kodiakhq bot deleted the feat/index-api-similar-to-query branch September 20, 2024 10:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@carlos-r-l-rodrigues carlos-r-l-rodrigues carlos-r-l-rodrigues approved these changes

@olivermrbl olivermrbl olivermrbl approved these changes

@christiananese christiananese Awaiting requested review from christiananese christiananese is a code owner automatically assigned from medusajs/engineering

@fPolic fPolic Awaiting requested review from fPolic fPolic is a code owner automatically assigned from medusajs/engineering

@kasperkristensen kasperkristensen Awaiting requested review from kasperkristensen kasperkristensen is a code owner automatically assigned from medusajs/engineering

Assignees
No one assigned
Labels
automerge team: medusa type: feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@adrien2p @carlos-r-l-rodrigues @olivermrbl