@travetto/model-query 8.0.0-alpha.14 → 8.0.0-alpha.16

package/README.md

@@ -86,7 +86,7 @@ export interface ModelQueryFacetSupport extends ModelQuerySupport {
    * @param field The field to facet on
    * @param query Additional query filtering
    */
-  facet<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, query?: ModelQuery<T>): Promise<ModelQueryFacet[]>;
+  facetByQuery<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, query?: ModelQuery<T>): Promise<ModelQueryFacet[]>;
 }
 ```
 
@@ -104,7 +104,7 @@ export interface ModelQuerySuggestSupport extends ModelQuerySupport {
    * @param prefix The search prefix for the given field
    * @param query A query to filter the search on, in addition to the prefix
    */
-  suggest<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, prefix?: string, query?: PageableModelQuery<T>): Promise<T[]>;
+  suggestByQuery<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, prefix?: string, query?: PageableModelQuery<T>): Promise<T[]>;
   /**
    * Suggest distinct values for a given cls and a given field
    *
@@ -113,7 +113,7 @@ export interface ModelQuerySuggestSupport extends ModelQuerySupport {
    * @param prefix The search prefix for the given field
    * @param query A query to filter the search on, in addition to the prefix
    */
-  suggestValues<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, prefix?: string, query?: PageableModelQuery<T>): Promise<string[]>;
+  suggestValuesByQuery<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, prefix?: string, query?: PageableModelQuery<T>): Promise<string[]>;
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-query",
-  "version": "8.0.0-alpha.14",
+  "version": "8.0.0-alpha.16",
   "type": "module",
   "description": "Datastore abstraction for advanced query support.",
   "keywords": [
@@ -27,12 +27,12 @@
     "directory": "module/model-query"
   },
   "dependencies": {
-    "@travetto/di": "^8.0.0-alpha.12",
-    "@travetto/model": "^8.0.0-alpha.13",
-    "@travetto/schema": "^8.0.0-alpha.13"
+    "@travetto/di": "^8.0.0-alpha.14",
+    "@travetto/model": "^8.0.0-alpha.15",
+    "@travetto/schema": "^8.0.0-alpha.15"
   },
   "peerDependencies": {
-    "@travetto/test": "^8.0.0-alpha.12"
+    "@travetto/test": "^8.0.0-alpha.14"
   },
   "peerDependenciesMeta": {
     "@travetto/test": {

package/src/model/where-clause.ts

@@ -1,10 +1,11 @@
-import type { Primitive, ValidFields, TimeSpan } from '@travetto/runtime';
+import type { Primitive, ValidFields, TimeSpan, ValidTypedFields } from '@travetto/runtime';
 import type { Point } from '@travetto/schema';
 
 export type QueryPrimitive = Primitive | Date | Point;
 export type QueryPrimitiveArray = QueryPrimitive[];
 export type DistanceUnit = 'mi' | 'm' | 'km' | 'ft' | 'rad';
 export type RetainQueryPrimitiveFields<T> = Pick<T, ValidFields<T, QueryPrimitive>>;
+export type ValidStringFields<T> = ValidTypedFields<T, String | string | string[] | String[] | undefined>;
 
 type General<T> = {
   $eq?: T;
@@ -67,11 +68,3 @@ export type WhereClauseRaw<T> =
  * Full where clause, typed against the input type T
  */
 export type WhereClause<T> = WhereClauseRaw<RetainQueryPrimitiveFields<T>>;
-
-/**
- * Provides all the valid string type fields from a given type T
- */
-export type ValidStringFields<T> = {
-  [K in Extract<keyof T, string>]:
-  (T[K] extends (String | string | string[] | String[] | undefined) ? K : never)
-}[Extract<keyof T, string>];

package/src/types/facet.ts

@@ -18,5 +18,5 @@ export interface ModelQueryFacetSupport extends ModelQuerySupport {
    * @param field The field to facet on
    * @param query Additional query filtering
    */
-  facet<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, query?: ModelQuery<T>): Promise<ModelQueryFacet[]>;
+  facetByQuery<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, query?: ModelQuery<T>): Promise<ModelQueryFacet[]>;
 }

package/src/types/suggest.ts

@@ -18,7 +18,7 @@ export interface ModelQuerySuggestSupport extends ModelQuerySupport {
    * @param prefix The search prefix for the given field
    * @param query A query to filter the search on, in addition to the prefix
    */
-  suggest<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, prefix?: string, query?: PageableModelQuery<T>): Promise<T[]>;
+  suggestByQuery<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, prefix?: string, query?: PageableModelQuery<T>): Promise<T[]>;
   /**
    * Suggest distinct values for a given cls and a given field
    *
@@ -27,5 +27,5 @@ export interface ModelQuerySuggestSupport extends ModelQuerySupport {
    * @param prefix The search prefix for the given field
    * @param query A query to filter the search on, in addition to the prefix
    */
-  suggestValues<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, prefix?: string, query?: PageableModelQuery<T>): Promise<string[]>;
+  suggestValuesByQuery<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, prefix?: string, query?: PageableModelQuery<T>): Promise<string[]>;
 }

package/src/util/facet.ts

@@ -6,5 +6,5 @@ export class ModelQueryFacetUtil {
   /**
    * Type guard for determining if service supports query facet operations
    */
-  static isSupported = hasFunction<ModelQueryFacetSupport>('facet');
+  static isSupported = hasFunction<ModelQueryFacetSupport>('facetByQuery');
 }

package/src/util/suggest.ts

@@ -14,7 +14,7 @@ export class ModelQuerySuggestUtil {
   /**
    * Type guard for determining if service supports query suggest operations
    */
-  static isSupported = hasFunction<ModelQuerySuggestSupport>('suggest');
+  static isSupported = hasFunction<ModelQuerySuggestSupport>('suggestByQuery');
 
   /**
    * Build regex for suggesting

package/support/test/facet.ts

@@ -36,7 +36,7 @@ export abstract class ModelQueryFacetSuite extends BaseModelSuite<ModelQueryFace
 
     assert(saved === 50);
 
-    const results = await svc.facet(Person, 'gender');
+    const results = await svc.facetByQuery(Person, 'gender');
 
     assert(results.length === 2);
     assert(results[0].count >= results[1].count);
@@ -51,7 +51,7 @@ export abstract class ModelQueryFacetSuite extends BaseModelSuite<ModelQueryFace
       names[el.name!] = (names[el.name!] || 0) + 1;
     }
 
-    const nameFacet = await svc.facet(Person, 'name');
+    const nameFacet = await svc.facetByQuery(Person, 'name');
     assert(Object.keys(names).length === nameFacet.length);
   }
 }

package/support/test/polymorphism.ts

@@ -83,15 +83,15 @@ export abstract class ModelQueryPolymorphismSuite extends BaseModelSuite<ModelQu
     await this.saveAll(Worker, [doc, doc2, fire, eng]);
     assert(await this.getSize(Worker) === 4);
 
-    assert((await svc.suggest(Worker, 'name', '')).length === 4);
-    assert((await svc.suggestValues(Worker, 'name', '')).length === 4);
-    assert((await svc.suggest(Worker, 'name', 'r')).length === 1);
-    assert((await svc.suggest(Worker, 'name', 'r'))[0] instanceof Firefighter);
-    assert((await svc.suggest(Doctor, 'name', 'r')).length === 0);
-    assert((await svc.suggest(Firefighter, 'name', 'r')).length === 1);
-
-    assert((await svc.suggestValues(Firefighter, 'name', 'r')).length === 1);
-    assert((await svc.suggestValues(Firefighter, 'name', 'r'))[0] === 'rob');
+    assert((await svc.suggestByQuery(Worker, 'name', '')).length === 4);
+    assert((await svc.suggestValuesByQuery(Worker, 'name', '')).length === 4);
+    assert((await svc.suggestByQuery(Worker, 'name', 'r')).length === 1);
+    assert((await svc.suggestByQuery(Worker, 'name', 'r'))[0] instanceof Firefighter);
+    assert((await svc.suggestByQuery(Doctor, 'name', 'r')).length === 0);
+    assert((await svc.suggestByQuery(Firefighter, 'name', 'r')).length === 1);
+
+    assert((await svc.suggestValuesByQuery(Firefighter, 'name', 'r')).length === 1);
+    assert((await svc.suggestValuesByQuery(Firefighter, 'name', 'r'))[0] === 'rob');
   }
 
   @Test({ skip: ModelQueryPolymorphismSuite.ifNot(ModelQueryFacetUtil.isSupported) })
@@ -107,8 +107,8 @@ export abstract class ModelQueryPolymorphismSuite extends BaseModelSuite<ModelQu
     await this.saveAll(Worker, [doc, doc2, fire, eng]);
     assert(await this.getSize(Worker) === 4);
 
-    assert((await svc.facet(Worker, 'name')).length === 4);
-    const docFacet = await svc.facet(Doctor, 'specialty');
+    assert((await svc.facetByQuery(Worker, 'name')).length === 4);
+    const docFacet = await svc.facetByQuery(Doctor, 'specialty');
     assert.deepStrictEqual(docFacet, [{ count: 2, key: 'eyes' }]);
   }
 }

package/support/test/suggest.ts

@@ -33,13 +33,13 @@ export abstract class ModelQuerySuggestSuite extends BaseModelSuite<ModelQuerySu
 
     await this.#loadPeople();
 
-    let suggested = await service.suggestValues(Person, 'name', 'bo');
+    let suggested = await service.suggestValuesByQuery(Person, 'name', 'bo');
     assert(suggested.length === 2);
 
-    suggested = await service.suggestValues(Person, 'name', 'b');
+    suggested = await service.suggestValuesByQuery(Person, 'name', 'b');
     assert(suggested.length === 3);
 
-    suggested = await service.suggestValues(Person, 'name', 'b', {
+    suggested = await service.suggestValuesByQuery(Person, 'name', 'b', {
       where: {
         address: {
           street2: {
@@ -57,7 +57,7 @@ export abstract class ModelQuerySuggestSuite extends BaseModelSuite<ModelQuerySu
 
     await this.#loadPeople();
 
-    const suggestedEntities = await service.suggest(Person, 'name', 'bo');
+    const suggestedEntities = await service.suggestByQuery(Person, 'name', 'bo');
 
     assert(suggestedEntities.length === 2);
     assert(suggestedEntities[0].name === 'Bo');