@travetto/model-query 8.0.2 → 8.0.3

package/README.md

@@ -36,12 +36,6 @@ export interface ModelQuerySupport {
    * @param failOnMany Should the query fail on more than one result found, defaults to true
    */
   queryOne<T extends ModelType>(cls: Class<T>, query: ModelQuery<T>, failOnMany?: boolean): Promise<T>;
-  /**
-   * Find the count of matching documents by query.
-   * @param cls The model class
-   * @param query The query to count for
-   */
-  queryCount<T extends ModelType>(cls: Class<T>, query: ModelQuery<T>): Promise<number>;
 }
 ```
 
@@ -150,6 +144,13 @@ export interface ModelQueryAggregateSupport extends ModelQuerySupport {
     field: F,
     query?: ModelQuery<T>
   ): Promise<AggregateResultType<T, F>>;
+
+  /**
+   * Find the count of matching documents by query.
+   * @param cls The model class
+   * @param query The query to count for
+   */
+  countByQuery<T extends ModelType>(cls: Class<T>, query: ModelQuery<T>): Promise<number>;
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-query",
-  "version": "8.0.2",
+  "version": "8.0.3",
   "description": "Datastore abstraction for advanced query support.",
   "keywords": [
     "datastore",
@@ -31,11 +31,11 @@
   },
   "dependencies": {
     "@travetto/di": "^8.0.1",
-    "@travetto/model": "^8.0.2",
+    "@travetto/model": "^8.0.3",
     "@travetto/schema": "^8.0.2"
   },
   "peerDependencies": {
-    "@travetto/test": "^8.0.1"
+    "@travetto/test": "^8.0.2"
   },
   "peerDependenciesMeta": {
     "@travetto/test": {

package/src/types/aggregate.ts

@@ -45,4 +45,11 @@ export interface ModelQueryAggregateSupport extends ModelQuerySupport {
     field: F,
     query?: ModelQuery<T>
   ): Promise<AggregateResultType<T, F>>;
+
+  /**
+   * Find the count of matching documents by query.
+   * @param cls The model class
+   * @param query The query to count for
+   */
+  countByQuery<T extends ModelType>(cls: Class<T>, query: ModelQuery<T>): Promise<number>;
 }

package/src/types/query.ts

@@ -21,10 +21,4 @@ export interface ModelQuerySupport {
    * @param failOnMany Should the query fail on more than one result found, defaults to true
    */
   queryOne<T extends ModelType>(cls: Class<T>, query: ModelQuery<T>, failOnMany?: boolean): Promise<T>;
-  /**
-   * Find the count of matching documents by query.
-   * @param cls The model class
-   * @param query The query to count for
-   */
-  queryCount<T extends ModelType>(cls: Class<T>, query: ModelQuery<T>): Promise<number>;
 }

package/support/test/crud.ts

@@ -1,12 +1,13 @@
 import assert from 'node:assert';
 
-import { Model, type ModelCrudSupport, NotFoundError, UniqueError } from '@travetto/model';
-import { castTo } from '@travetto/runtime';
+import { Model, type ModelCrudSupport, type ModelType, NotFoundError, UniqueError } from '@travetto/model';
+import { castTo, type Class } from '@travetto/runtime';
 import { Suite, Test } from '@travetto/test';
 
 import { BaseModelSuite } from '@travetto/model/support/test/base.ts';
 
-import { QueryIndex } from '../../__index__.ts';
+import type { WhereClause } from '../../__index__.ts';
+import { QueryIndex } from '../../src/model/indexes.ts';
 import type { ModelQueryCrudSupport } from '../../src/types/crud.ts';
 import { Address, BigIntModel, Person, Todo } from './model.ts';
 
@@ -25,6 +26,11 @@ class UniqueUser2 {
 export abstract class ModelQueryCrudSuite extends BaseModelSuite<ModelQueryCrudSupport & ModelCrudSupport> {
   supportsUniqueIndexes = true;
 
+  async countByQuery<T extends ModelType>(cls: Class<T>, query: WhereClause<T>): Promise<number> {
+    const svc = await this.service;
+    return svc.query(cls, { where: query, limit: 10000 }).then(v => v.length);
+  }
+
   @Test({ skip: self => !castTo<ModelQueryCrudSuite>(self).supportsUniqueIndexes })
   async testUnique() {
     const svc = await this.service;
@@ -147,13 +153,13 @@ export abstract class ModelQueryCrudSuite extends BaseModelSuite<ModelQueryCrudS
 
     assert(c === 2);
 
-    assert((await svc.queryCount(Person, {})) === 3);
+    assert((await this.countByQuery(Person, {})) === 3);
 
     const c2 = await svc.deleteByQuery(Person, { where: { age: { $lte: 3 } } });
 
     assert(c2 === 3);
 
-    assert((await svc.queryCount(Person, {})) === 0);
+    assert((await this.countByQuery(Person, {})) === 0);
   }
 
   @Test()
@@ -177,7 +183,7 @@ export abstract class ModelQueryCrudSuite extends BaseModelSuite<ModelQueryCrudS
 
     assert(count === 5);
 
-    assert((await svc.queryCount(Person, { where: { gender: 'm' } })) === 5);
+    assert((await this.countByQuery(Person, { gender: 'm' })) === 5);
 
     const c = await svc.updatePartialByQuery(Person, { where: { age: { $gt: 3 } } }, { gender: 'f' });
 
@@ -185,14 +191,14 @@ export abstract class ModelQueryCrudSuite extends BaseModelSuite<ModelQueryCrudS
 
     assert(c === 2);
 
-    assert((await svc.queryCount(Person, { where: { gender: 'm' } })) === 3);
+    assert((await this.countByQuery(Person, { gender: 'm' })) === 3);
 
     const c2 = await svc.updatePartialByQuery(Person, { where: { gender: 'm' } }, { gender: 'f' });
 
     assert(c2 === 3);
 
-    assert((await svc.queryCount(Person, { where: { gender: 'f' } })) === 5);
-    assert((await svc.queryCount(Person, { where: { gender: 'm' } })) === 0);
+    assert((await this.countByQuery(Person, { gender: 'f' })) === 5);
+    assert((await this.countByQuery(Person, { gender: 'm' })) === 0);
   }
 
   @Test()
@@ -237,7 +243,7 @@ export abstract class ModelQueryCrudSuite extends BaseModelSuite<ModelQueryCrudS
     assert(withOptional.every(x => x.optionalBigInt !== undefined));
 
     // Test count with bigint condition
-    const countResult = await svc.queryCount(BigIntModel, { where: { largeNumber: { $gte: 1000n } } });
+    const countResult = await this.countByQuery(BigIntModel, { largeNumber: { $gte: 1000n } });
     assert(countResult === 2);
   }
 
@@ -285,7 +291,7 @@ export abstract class ModelQueryCrudSuite extends BaseModelSuite<ModelQueryCrudS
     assert(deleted === 2);
 
     // Verify deletions
-    const remaining = await svc.queryCount(BigIntModel, {});
+    const remaining = await this.countByQuery(BigIntModel, {});
     assert(remaining === 3);
 
     const all = await svc.query(BigIntModel, {});

package/support/test/polymorphism.ts

@@ -18,7 +18,9 @@ import { ModelQueryFacetUtil } from '../../src/util/facet.ts';
 import { ModelQuerySuggestUtil } from '../../src/util/suggest.ts';
 
 @Suite()
-export abstract class ModelQueryPolymorphismSuite extends BaseModelSuite<ModelQuerySupport & ModelCrudSupport> {
+export abstract class ModelQueryPolymorphismSuite extends BaseModelSuite<
+  ModelQuerySupport & ModelQueryAggregateSupport & ModelCrudSupport
+> {
   @Test()
   async testQuery() {
     const svc = await this.service;
@@ -36,9 +38,9 @@ export abstract class ModelQueryPolymorphismSuite extends BaseModelSuite<ModelQu
     assert((await svc.query(Doctor, {})).length === 2);
     assert((await svc.query(Engineer, {})).length === 1);
 
-    assert((await svc.queryCount(Worker, { where: { name: 'bob' } })) === 1);
-    assert((await svc.queryCount(Doctor, { where: { name: 'bob' } })) === 1);
-    assert((await svc.queryCount(Engineer, { where: { name: 'bob' } })) === 0);
+    assert((await svc.countByQuery(Worker, { where: { name: 'bob' } })) === 1);
+    assert((await svc.countByQuery(Doctor, { where: { name: 'bob' } })) === 1);
+    assert((await svc.countByQuery(Engineer, { where: { name: 'bob' } })) === 0);
 
     assert((await svc.queryOne(Worker, { where: { name: 'bob' } })) instanceof Doctor);
     await assert.rejects(() => svc.queryOne(Firefighter, { where: { name: 'bob' } }), NotFoundError);
@@ -46,7 +48,7 @@ export abstract class ModelQueryPolymorphismSuite extends BaseModelSuite<ModelQu
 
   @Test({ skip: ModelQueryPolymorphismSuite.ifNot(ModelQueryCrudUtil.isSupported) })
   async testCrudQuery() {
-    const svc: ModelQueryCrudSupport & ModelQuerySupport = castTo(await this.service);
+    const svc: ModelQueryCrudSupport & ModelQueryAggregateSupport & ModelQuerySupport = castTo(await this.service);
     const [doc, doc2, fire, eng] = [
       Doctor.from({ name: 'bob', specialty: 'feet' }),
       Doctor.from({ name: 'nob', specialty: 'eyes' }),
@@ -60,7 +62,7 @@ export abstract class ModelQueryPolymorphismSuite extends BaseModelSuite<ModelQu
     const c = await svc.updatePartialByQuery(Doctor, { where: { specialty: 'feet' } }, { specialty: 'eyes' });
     assert(c === 1);
 
-    assert((await svc.queryCount(Doctor, { where: { specialty: 'eyes' } })) === 2);
+    assert((await svc.countByQuery(Doctor, { where: { specialty: 'eyes' } })) === 2);
 
     const removed = await svc.deleteByQuery(Worker, { where: { name: 'rob' } });
 

package/support/test/query.ts

@@ -6,11 +6,12 @@ import { Suite, Test } from '@travetto/test';
 
 import { BaseModelSuite } from '@travetto/model/support/test/base.ts';
 
+import type { ModelQueryAggregateSupport } from '../../__index__.ts';
 import type { ModelQuerySupport } from '../../src/types/query.ts';
 import { Aged, Location, Names, Note, Person, PersonFamily, Recipe, SimpleList, WithNestedLists, WithNestedNestedLists } from './model.ts';
 
 @Suite()
-export abstract class ModelQuerySuite extends BaseModelSuite<ModelQuerySupport & ModelCrudSupport> {
+export abstract class ModelQuerySuite extends BaseModelSuite<ModelQuerySupport & ModelQueryAggregateSupport & ModelCrudSupport> {
   supportsGeo = true;
 
   @Test()
@@ -38,7 +39,7 @@ export abstract class ModelQuerySuite extends BaseModelSuite<ModelQuerySupport &
     const one2 = await svc.queryOne(Person, { where: { id: { $eq: people[0].id } } });
     assert(one2.id === people[0].id);
 
-    const none = await svc.queryCount(Person, { where: { id: { $ne: people[0].id } } });
+    const none = await svc.countByQuery(Person, { where: { id: { $ne: people[0].id } } });
     assert(none === 3);
 
     const noneIds = await svc.query(Person, { where: { id: { $ne: people[0].id } } });
@@ -331,7 +332,7 @@ export abstract class ModelQuerySuite extends BaseModelSuite<ModelQuerySupport &
 
     await this.saveAll(Location, toAdd);
 
-    assert((await svc.queryCount(Location, {})) === 25);
+    assert((await svc.countByQuery(Location, {})) === 25);
 
     const result = await svc.query(Location, {
       limit: 100,
@@ -382,7 +383,7 @@ export abstract class ModelQuerySuite extends BaseModelSuite<ModelQuerySupport &
       })
     );
 
-    const out = await service.queryCount(Note, {
+    const out = await service.countByQuery(Note, {
       where: {
         entities: {
           id
@@ -413,7 +414,7 @@ export abstract class ModelQuerySuite extends BaseModelSuite<ModelQuerySupport &
       )
     );
 
-    const simple = await service.queryCount(Aged, {
+    const simple = await service.countByQuery(Aged, {
       where: {
         createdAt: {
           $gt: new Date()
@@ -422,7 +423,7 @@ export abstract class ModelQuerySuite extends BaseModelSuite<ModelQuerySupport &
     });
     assert(simple === 5);
 
-    const simple2 = await service.queryCount(Aged, {
+    const simple2 = await service.countByQuery(Aged, {
       where: {
         createdAt: {
           $gt: '-1d'
@@ -431,7 +432,7 @@ export abstract class ModelQuerySuite extends BaseModelSuite<ModelQuerySupport &
     });
     assert(simple2 === 6);
 
-    const simple3 = await service.queryCount(Aged, {
+    const simple3 = await service.countByQuery(Aged, {
       where: {
         createdAt: {
           $gt: '-1296m', // -1.9d
@@ -441,7 +442,7 @@ export abstract class ModelQuerySuite extends BaseModelSuite<ModelQuerySupport &
     });
     assert(simple3 === 3);
 
-    const simple4 = await service.queryCount(Aged, {
+    const simple4 = await service.countByQuery(Aged, {
       where: {
         createdAt: {
           $gt: TimeUtil.fromNow('-144m'), // -0.1d
@@ -463,35 +464,35 @@ export abstract class ModelQuerySuite extends BaseModelSuite<ModelQuerySupport &
       WithNestedLists.from({ names: [], tags: [] })
     ]);
 
-    let total = await service.queryCount(WithNestedLists, {
+    let total = await service.countByQuery(WithNestedLists, {
       where: {
         names: { $exists: true }
       }
     });
     assert(total === 3);
 
-    total = await service.queryCount(WithNestedLists, {
+    total = await service.countByQuery(WithNestedLists, {
       where: {
         names: { $exists: false }
       }
     });
     assert(total === 2);
 
-    total = await service.queryCount(WithNestedLists, {
+    total = await service.countByQuery(WithNestedLists, {
       where: {
         tags: { $exists: false }
       }
     });
     assert(total === 3);
 
-    total = await service.queryCount(WithNestedLists, {
+    total = await service.countByQuery(WithNestedLists, {
       where: {
         tags: { $exists: true }
       }
     });
     assert(total === 2);
 
-    total = await service.queryCount(WithNestedLists, {
+    total = await service.countByQuery(WithNestedLists, {
       where: {
         tags: { $exists: false },
         names: { $exists: false }
@@ -499,7 +500,7 @@ export abstract class ModelQuerySuite extends BaseModelSuite<ModelQuerySupport &
     });
     assert(total === 1);
 
-    total = await service.queryCount(WithNestedLists, {
+    total = await service.countByQuery(WithNestedLists, {
       where: {
         tags: { $exists: true },
         names: { $exists: true }
@@ -520,35 +521,35 @@ export abstract class ModelQuerySuite extends BaseModelSuite<ModelQuerySupport &
       WithNestedNestedLists.from({ sub: {}, tags: [] })
     ]);
 
-    let total = await service.queryCount(WithNestedNestedLists, {
+    let total = await service.countByQuery(WithNestedNestedLists, {
       where: {
         sub: { names: { $exists: true } }
       }
     });
     assert(total === 3);
 
-    total = await service.queryCount(WithNestedNestedLists, {
+    total = await service.countByQuery(WithNestedNestedLists, {
       where: {
         sub: { names: { $exists: false } }
       }
     });
     assert(total === 2);
 
-    total = await service.queryCount(WithNestedNestedLists, {
+    total = await service.countByQuery(WithNestedNestedLists, {
       where: {
         tags: { $exists: false }
       }
     });
     assert(total === 3);
 
-    total = await service.queryCount(WithNestedNestedLists, {
+    total = await service.countByQuery(WithNestedNestedLists, {
       where: {
         tags: { $exists: true }
       }
     });
     assert(total === 2);
 
-    total = await service.queryCount(WithNestedNestedLists, {
+    total = await service.countByQuery(WithNestedNestedLists, {
       where: {
         tags: { $exists: false },
         sub: { names: { $exists: false } }
@@ -556,7 +557,7 @@ export abstract class ModelQuerySuite extends BaseModelSuite<ModelQuerySupport &
     });
     assert(total === 1);
 
-    total = await service.queryCount(WithNestedNestedLists, {
+    total = await service.countByQuery(WithNestedNestedLists, {
       where: {
         tags: { $exists: true },
         sub: { names: { $exists: true } }