@travetto/model-query 5.0.0 → 5.0.1

package/README.md

@@ -57,14 +57,14 @@ export interface ModelQueryCrudSupport extends ModelCrudSupport, ModelQuerySuppo
    * @param data The data
    * @param query The additional query to validate
   */
-  updateOneWithQuery<T extends ModelType>(cls: Class<T>, data: T, query: ModelQuery<T>): Promise<T>;
+  updateByQuery<T extends ModelType>(cls: Class<T>, data: T, query: ModelQuery<T>): Promise<T>;
   /**
-   * Update/replace all with partial data, by query
+   * Update all with partial data, by query
    * @param cls The model class
    * @param query The query to search for
    * @param data The partial data
    */
-  updateByQuery<T extends ModelType>(cls: Class<T>, query: ModelQuery<T>, data: Partial<T>): Promise<number>;
+  updatePartialByQuery<T extends ModelType>(cls: Class<T>, query: ModelQuery<T>, data: Partial<T>): Promise<number>;
   /**
    * Delete all by query
    * @param cls The model class

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-query",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "description": "Datastore abstraction for advanced query support.",
   "keywords": [
     "datastore",
@@ -26,12 +26,12 @@
     "directory": "module/model-query"
   },
   "dependencies": {
-    "@travetto/di": "^5.0.0",
-    "@travetto/model": "^5.0.0",
-    "@travetto/schema": "^5.0.0"
+    "@travetto/di": "^5.0.1",
+    "@travetto/model": "^5.0.1",
+    "@travetto/schema": "^5.0.1"
   },
   "peerDependencies": {
-    "@travetto/test": "^5.0.0"
+    "@travetto/test": "^5.0.1"
   },
   "peerDependenciesMeta": {
     "@travetto/test": {

package/src/internal/service/common.ts

@@ -1,3 +1,4 @@
+import { hasFunction } from '@travetto/runtime';
 import type { ModelQueryCrudSupport } from '../../service/crud';
 import type { ModelQueryFacetSupport } from '../../service/facet';
 import type { ModelQuerySupport } from '../../service/query';
@@ -10,32 +11,20 @@ export class ModelQuerySuggestSupportTarget { }
 
 /**
  * Type guard for determining if service supports query operations
- * @param o
  */
-export function isQuerySupported(o: unknown): o is ModelQuerySupport {
-  return !!o && typeof o === 'object' && 'query' in o && !!o.query;
-}
+export const isQuerySupported = hasFunction<ModelQuerySupport>('query');
 
 /**
  * Type guard for determining if service supports query crud operations
- * @param o
  */
-export function isQueryCrudSupported(o: unknown): o is ModelQueryCrudSupport {
-  return !!o && typeof o === 'object' && 'deleteByQuery' in o && !!o.deleteByQuery;
-}
+export const isQueryCrudSupported = hasFunction<ModelQueryCrudSupport>('deleteByQuery');
 
 /**
  * Type guard for determining if service supports query facet operations
- * @param o
  */
-export function isQueryFacetSupported(o: unknown): o is ModelQueryFacetSupport {
-  return !!o && typeof o === 'object' && 'facet' in o && !!o.facet;
-}
+export const isQueryFacetSupported = hasFunction<ModelQueryFacetSupport>('facet');
 
 /**
  * Type guard for determining if service supports query suggest operations
- * @param o
  */
-export function isQuerySuggestSupported(o: unknown): o is ModelQuerySuggestSupport {
-  return !!o && typeof o === 'object' && 'suggest' in o && !!o.suggest;
-}
+export const isQuerySuggestSupported = hasFunction<ModelQuerySuggestSupport>('suggest');

package/src/service/crud.ts

@@ -15,14 +15,14 @@ export interface ModelQueryCrudSupport extends ModelCrudSupport, ModelQuerySuppo
    * @param data The data
    * @param query The additional query to validate
   */
-  updateOneWithQuery<T extends ModelType>(cls: Class<T>, data: T, query: ModelQuery<T>): Promise<T>;
+  updateByQuery<T extends ModelType>(cls: Class<T>, data: T, query: ModelQuery<T>): Promise<T>;
   /**
-   * Update/replace all with partial data, by query
+   * Update all with partial data, by query
    * @param cls The model class
    * @param query The query to search for
    * @param data The partial data
    */
-  updateByQuery<T extends ModelType>(cls: Class<T>, query: ModelQuery<T>, data: Partial<T>): Promise<number>;
+  updatePartialByQuery<T extends ModelType>(cls: Class<T>, query: ModelQuery<T>, data: Partial<T>): Promise<number>;
   /**
    * Delete all by query
    * @param cls The model class

package/support/test/crud.ts

@@ -19,7 +19,7 @@ export abstract class ModelQueryCrudSuite extends BaseModelSuite<ModelQueryCrudS
     assert(todo1.id);
     assert(todo1.version === 0);
 
-    const todo1v2 = await svc.updateOneWithQuery(Todo, Todo.from({
+    const todo1v2 = await svc.updateByQuery(Todo, Todo.from({
       id: todo1.id,
       text: `${todo1.text}!!`,
       version: todo1.version + 1
@@ -29,7 +29,7 @@ export abstract class ModelQueryCrudSuite extends BaseModelSuite<ModelQueryCrudS
     assert(todo1v2.version > todo1.version);
 
     await assert.rejects(
-      () => svc.updateOneWithQuery(Todo, Todo.from({
+      () => svc.updateByQuery(Todo, Todo.from({
         id: todo1.id,
         text: `${todo1.text}!!`,
         version: todo1.version + 1
@@ -40,7 +40,7 @@ export abstract class ModelQueryCrudSuite extends BaseModelSuite<ModelQueryCrudS
 
     const todo2 = await svc.create(Todo, Todo.from({ text: 'bob2' }));
 
-    const result = await svc.updateOneWithQuery(Todo, Todo.from({
+    const result = await svc.updateByQuery(Todo, Todo.from({
       id: todo2.id,
       text: `${todo1.text}!!`,
       version: todo1.version + 1
@@ -60,7 +60,7 @@ export abstract class ModelQueryCrudSuite extends BaseModelSuite<ModelQueryCrudS
 
     const todo1v = ['a', 'b', 'c', 'd', 'e'].map(x => Todo.from({ ...todo1, text: `${todo1.text}-${x}`, version: todo1.version + 1 }));
 
-    const promises = todo1v.map(x => svc.updateOneWithQuery(Todo, x, { where: { version: todo1.version } }));
+    const promises = todo1v.map(x => svc.updateByQuery(Todo, x, { where: { version: todo1.version } }));
 
     const results = await Promise.allSettled(promises);
     const rejected = results.filter(x => x.status === 'rejected');
@@ -81,7 +81,7 @@ export abstract class ModelQueryCrudSuite extends BaseModelSuite<ModelQueryCrudS
     assert.deepStrictEqual(todo2, succeeded.value);
 
     const promises2 = ['a', 'b', 'c', 'd', 'e'].map(x => Todo.from({ ...todo2, text: `${todo2.text}-${x}`, version: todo2.version + 2 }));
-    const results2 = await Promise.allSettled(promises2.map(x => svc.updateOneWithQuery(Todo, x, { where: { version: todo2.version + 1 } })));
+    const results2 = await Promise.allSettled(promises2.map(x => svc.updateByQuery(Todo, x, { where: { version: todo2.version + 1 } })));
     for (const el of results2) {
       assert(el.status === 'rejected');
       assert(el.reason instanceof NotFoundError);
@@ -137,7 +137,7 @@ export abstract class ModelQueryCrudSuite extends BaseModelSuite<ModelQueryCrudS
 
     assert(await svc.queryCount(Person, { where: { gender: 'm' } }) === 5);
 
-    const c = await svc.updateByQuery(Person, { where: { age: { $gt: 3 } } }, { gender: 'f' });
+    const c = await svc.updatePartialByQuery(Person, { where: { age: { $gt: 3 } } }, { gender: 'f' });
 
     assert((await svc.query(Person, {}))[0].address.street1 === 'street1');
 
@@ -145,7 +145,7 @@ export abstract class ModelQueryCrudSuite extends BaseModelSuite<ModelQueryCrudS
 
     assert(await svc.queryCount(Person, { where: { gender: 'm' } }) === 3);
 
-    const c2 = await svc.updateByQuery(Person, { where: { gender: 'm' } }, { gender: 'f' });
+    const c2 = await svc.updatePartialByQuery(Person, { where: { gender: 'm' } }, { gender: 'f' });
 
     assert(c2 === 3);
 

package/support/test/polymorphism.ts

@@ -55,7 +55,7 @@ export abstract class ModelQueryPolymorphismSuite extends BaseModelSuite<ModelQu
     await this.saveAll(Worker, [doc, doc2, fire, eng]);
     assert(await this.getSize(Worker) === 4);
 
-    const c = await svc.updateByQuery(Doctor, { where: { specialty: 'feet' } }, { specialty: 'eyes' });
+    const c = await svc.updatePartialByQuery(Doctor, { where: { specialty: 'feet' } }, { specialty: 'eyes' });
     assert(c === 1);
 
     assert((await svc.queryCount(Doctor, { where: { specialty: 'eyes' } })) === 2);