feat: add count endpoint

src/runtime/query/match/pipeline.ts

@@ -49,6 +49,11 @@ export function createPipelineFetcher<T> (getContentsList: () => Promise<T[]>) {
       return filteredData[0]
     }
 
+    // return count if query is for count
+    if (params.count) {
+      return (filteredData.length ?? 0) as unknown as T
+    }
+
     return filteredData
   }
 }

src/runtime/query/query.ts

@@ -46,6 +46,10 @@ export const createQuery = <T = ParsedContent>(
       queryParams.surround = { query: surroundQuery, ...options }
       return fetcher(query) as Promise<Array<T>>
     },
+    count: () => {
+      queryParams.count = true
+      return fetcher(query) as Promise<number>
+    },
     // locale
     locale: (_locale: string) => query.where({ _locale })
   }

src/runtime/server/api/query.ts

@@ -37,6 +37,11 @@ export default defineEventHandler(async (event) => {
     return content
   }
 
+  if (query.count) {
+    const count = await serverQueryContent(event, query).count()
+    return count
+  }
+
   const contents = await serverQueryContent(event, query).find()
 
   return contents

src/runtime/types.d.ts

@@ -473,6 +473,11 @@ export interface QueryBuilder<T = ParsedContentMeta> {
    */
   findSurround(query: string | QueryBuilderWhere, options?: Partial<{ before: number; after: number }>): Promise<Array<T>>
 
+  /**
+   * Count matched contents
+   */
+  count(): Promise<number>
+
   /**
    * Filter contents based on locale
    */

test/features/query/query.test.ts

@@ -229,6 +229,47 @@ describe('Database Provider', () => {
     assert(result[2] === null)
   })
 
+  test('Count items', async () => {
+    const fetcher = createPipelineFetcher(() => Promise.resolve([{ id: 1, _path: '/a' }, { id: 2, _path: '/b' }, { id: 3, _path: '/c' }] as any[]))
+
+    const result = await createQuery(fetcher)
+      .count()
+
+    assert(result === 3)
+  })
+
+  test('Count items with where condition', async () => {
+    const fetcher = createPipelineFetcher(() => Promise.resolve([{ id: 1, _path: '/a' }, { id: 2, _path: '/b' }, { id: 3, _path: '/c' }] as any[]))
+
+    const result = await createQuery(fetcher)
+      .where({ _path: { $contains: 'b' } })
+      .count()
+
+    assert(result === 1)
+  })
+
+  test('Count items with where condition and without method', async () => {
+    const fetcher = createPipelineFetcher(() => Promise.resolve([{ id: 1, _path: '/a' }, { id: 2, _path: '/b' }, { id: 3, _path: '/c' }] as any[]))
+
+    const result = await createQuery(fetcher)
+      .where({ _path: { $contains: 'b' } })
+      .without('id')
+      .count()
+
+    assert(result === 1)
+  })
+
+  test('Count items with where condition and only method', async () => {
+    const fetcher = createPipelineFetcher(() => Promise.resolve([{ id: 1, _path: '/a' }, { id: 2, _path: '/b' }, { id: 3, _path: '/c' }] as any[]))
+
+    const result = await createQuery(fetcher)
+      .where({ _path: { $contains: 'b' } })
+      .only(['_path'])
+      .count()
+
+    assert(result === 1)
+  })
+
   test('Chain multiple where conditions', async () => {
     const fetcher = createPipelineFetcher(() => Promise.resolve([{ id: 1, path: '/a' }, { id: 2, path: '/b' }, { id: 3, path: '/c' }] as any[]))
     const query = createQuery(fetcher).where({ id: { $in: [1, 2] } })