QueryBuilderParams type error

[eduardosada]

Environment

---

• Operating System: Linux
• Node Version: v16.14.2
• Nuxt Version: 3.0.0-rc.9
• Nitro Version: 0.5.2
• Package Manager: npm@7.17.0
• Builder: vite
• User Config: target, typescript, modules, runtimeConfig
• Runtime Modules: @nuxt/content@2.1.0

• Build Modules: -

Reproduction

https://stackblitz.com/edit/nuxt-starter-eqgbnv?file=pages%2Findex.vue

Describe the bug

The where property on Type QueryBuilderParams is incorrectly marked as an array.

Consider the following code:

<script setup lang="ts">
import type { QueryBuilderParams } from '@nuxt/content/dist/runtime/types';

let query: QueryBuilderParams = {
  where: { _draft: { $eq: false } },
};
</script>

Running nuxi typecheck will throw an error:

Nuxi 3.0.0-rc.9
pages/index.vue:13:12 - error TS2322: Type '{ _draft: { $eq: false; }; }' is not assignable to type 'QueryBuilderWhere[]'.
  Object literal may only specify known properties, and '_draft' does not exist in type 'QueryBuilderWhere[]'.

13   where: { _draft: { $eq: false } },
              ~~~~~~~~~~~~~~~~~~~~~~

  node_modules/@nuxt/content/dist/runtime/types.d.ts:418:3
    418   where?: QueryBuilderWhere[]
          ~~~~~
    The expected type comes from property 'where' which is declared here on type 'QueryBuilderParams'

Found 1 error in pages/index.vue:13

Additional context

No response

Logs

No response

[farnabaz]

Just wrap your condition in an array.

<script setup lang="ts">
import type { QueryBuilderParams } from '@nuxt/content/dist/runtime/types';

let query: QueryBuilderParams = {
  where: [{ _draft: { $eq: false } }],
};
</script>

The where field in the QueryBuilderParams is an array. We have done this especially to simplify joining multiple conditions.

[eduardosada]

Thanks @farnabaz

Try it yourself:

https://stackblitz.com/edit/nuxt-starter-xzi3df?file=pages%2Findex.vue

If you put where: [{ _draft: { $eq: false } }], doesn't throw a type error but the filter doesn't work. If you put where: { _draft: { $eq: false } }, the filter is working but the type check is failing.

[farnabaz]

I see, thanks for clarifying. I've missed that you are using ContentList.

Types should update to fix this.