asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

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

Browse Source 
**What**
Align the index engine API to be similar to the Query API

## Example

```ts
        // 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",
                  },
                },
              },
            },
          },
        })
```
This commit is contained in:
Adrien de Peretti
2024-09-20 12:02:42 +02:00
committed by GitHub
parent 1215a7c094
commit 3084008fc9
40 changed files with 1145 additions and 578 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
integration-tests/modules/.gitignore vendored
View File

@@ -1,4 +1,4 @@
dist/
node_modules
*yarn-error.log
.medusa

118
integration-tests/modules/__tests__/index/search.spec.ts
View File

@@ -58,25 +58,35 @@ medusaIntegrationTestRunner({
// Timeout to allow indexing to finish
await setTimeout(2000)
const [results, count] = await indexEngine.queryAndCount(
{
select: {
product: {
variants: {
prices: true,
const { data: results } = await indexEngine.query<"product">({
fields: [
"product.*",
"product.variants.*",
"product.variants.prices.*",
],
filters: {
product: {
variants: {
prices: {
amount: { $gt: 50 },
},
},
},
where: {
"product.variants.prices.amount": { $gt: 50 },
},
pagination: {
order: {
product: {
variants: {
prices: {
amount: "DESC",
},
},
},
},
},
{
orderBy: [{ "product.variants.prices.amount": "DESC" }],
}
)
})
expect(count).toBe(1)
expect(results.length).toBe(1)
const variants = results[0].variants
@@ -118,26 +128,36 @@ medusaIntegrationTestRunner({
// Timeout to allow indexing to finish
await setTimeout(2000)
const [results, count] = await indexEngine.queryAndCount(
{
select: {
product: {
variants: {
prices: true,
const { data: results } = await indexEngine.query<"product">({
fields: [
"product.*",
"product.variants.*",
"product.variants.prices.*",
],
filters: {
product: {
variants: {
prices: {
amount: { $gt: 50 },
currency_code: { $eq: "AUD" },
},
},
},
where: {
"product.variants.prices.amount": { $gt: 50 },
"product.variants.prices.currency_code": { $eq: "AUD" },
},
pagination: {
order: {
product: {
variants: {
prices: {
amount: "DESC",
},
},
},
},
},
{
orderBy: [{ "product.variants.prices.amount": "DESC" }],
}
)
})
expect(count).toBe(1)
expect(results.length).toBe(1)
const variants = results[0].variants
@@ -179,32 +199,40 @@ medusaIntegrationTestRunner({
await setTimeout(5000)
const queryArgs = [
{
select: {
product: {
variants: {
prices: true,
const queryArgs = {
fields: [
"product.*",
"product.variants.*",
"product.variants.prices.*",
],
filters: {
product: {
variants: {
prices: {
amount: { $gt: 50 },
currency_code: { $eq: "AUD" },
},
},
},
where: {
"product.variants.prices.amount": { $gt: 50 },
"product.variants.prices.currency_code": { $eq: "AUD" },
},
pagination: {
order: {
product: {
variants: {
prices: {
amount: "DESC",
},
},
},
},
},
{
orderBy: [{ "product.variants.prices.amount": "DESC" }],
},
]
}
await indexEngine.queryAndCount(...queryArgs)
await indexEngine.query<"product">(queryArgs)
const [results, count, perf] = await indexEngine.queryAndCount(
...queryArgs
const { data: results, metadata } = await indexEngine.query<"product">(
queryArgs
)
console.log(perf)
})
})
},

2
integration-tests/modules/tsconfig.json
View File

@@ -19,7 +19,7 @@
"skipLibCheck": true,
"downlevelIteration": true // to use ES5 specific tooling
},
"include": ["src"],
"include": ["src", "./medusa/**/*"],
"exclude": [
"./dist/**/*",
"__tests__",