@travetto/model-query 3.0.0-rc.3 → 3.0.0-rc.6

package/README.md

@@ -1,5 +1,5 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
-<!-- Please modify https://github.com/travetto/travetto/tree/main/module/model-query/doc.ts and execute "npx trv doc" to rebuild -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/model-query/DOC.ts and execute "npx trv doc" to rebuild -->
 # Data Model Querying
 ## Datastore abstraction for advanced query support.
 
@@ -241,41 +241,53 @@ To enforce that these contracts are honored, the module provides shared test sui
 ```typescript
 import { Suite } from '@travetto/test';
 
-import { ModelQuerySuite } from '@travetto/model-query/test-support/query';
-import { ModelQueryCrudSuite } from '@travetto/model-query/test-support/crud';
-import { ModelQueryFacetSuite } from '@travetto/model-query/test-support/facet';
-import { ModelQueryPolymorphismSuite } from '@travetto/model-query/test-support/polymorphism';
-import { ModelQuerySuggestSuite } from '@travetto/model-query/test-support/suggest';
+import { ModelQuerySuite } from '@travetto/model-query/support/test/query';
+import { ModelQueryCrudSuite } from '@travetto/model-query/support/test/crud';
+import { ModelQueryFacetSuite } from '@travetto/model-query/support/test/facet';
+import { ModelQueryPolymorphismSuite } from '@travetto/model-query/support/test/polymorphism';
+import { ModelQuerySuggestSuite } from '@travetto/model-query/support/test/suggest';
+import { ModelQueryCrudSupport } from '@travetto/model-query/src/service/crud';
+import { ModelQuerySuggestSupport } from '@travetto/model-query/src/service/suggest';
+import { ModelQueryFacetSupport } from '@travetto/model-query/src/service/facet';
+import { Config } from '@travetto/config';
+import { Injectable } from '@travetto/di';
 
-import { MongoModelConfig, MongoModelService } from '..';
+import { QueryModelService } from './query-service';
+
+@Config()
+class CustomModelConfig { }
+
+@Injectable()
+class CustomModelService extends QueryModelService implements ModelQueryCrudSupport, ModelQueryFacetSupport, ModelQuerySuggestSupport {
+}
 
 @Suite()
-export class MongoQuerySuite extends ModelQuerySuite {
-  serviceClass = MongoModelService;
-  configClass = MongoModelConfig;
+export class CustomQuerySuite extends ModelQuerySuite {
+  serviceClass = CustomModelService;
+  configClass = CustomModelConfig;
 }
 
 @Suite()
-export class MongoQueryCrudSuite extends ModelQueryCrudSuite {
-  serviceClass = MongoModelService;
-  configClass = MongoModelConfig;
+export class CustomQueryCrudSuite extends ModelQueryCrudSuite {
+  serviceClass = CustomModelService;
+  configClass = CustomModelConfig;
 }
 
 @Suite()
-export class MongoQueryFacetSuite extends ModelQueryFacetSuite {
-  serviceClass = MongoModelService;
-  configClass = MongoModelConfig;
+export class CustomQueryFacetSuite extends ModelQueryFacetSuite {
+  serviceClass = CustomModelService;
+  configClass = CustomModelConfig;
 }
 
 @Suite()
-export class MongoQueryPolymorphismSuite extends ModelQueryPolymorphismSuite {
-  serviceClass = MongoModelService;
-  configClass = MongoModelConfig;
+export class CustomQueryPolymorphismSuite extends ModelQueryPolymorphismSuite {
+  serviceClass = CustomModelService;
+  configClass = CustomModelConfig;
 }
 
 @Suite()
-export class MongoQuerySuggestSuite extends ModelQuerySuggestSuite {
-  serviceClass = MongoModelService;
-  configClass = MongoModelConfig;
+export class CustomQuerySuggestSuite extends ModelQuerySuggestSuite {
+  serviceClass = CustomModelService;
+  configClass = CustomModelConfig;
 }
 ```

package/package.json

@@ -1,7 +1,6 @@
 {
   "name": "@travetto/model-query",
-  "displayName": "Data Model Querying",
-  "version": "3.0.0-rc.3",
+  "version": "3.0.0-rc.6",
   "description": "Datastore abstraction for advanced query support.",
   "keywords": [
     "datastore",
@@ -18,24 +17,30 @@
     "name": "Travetto Framework"
   },
   "files": [
-    "index.ts",
+    "__index__.ts",
     "src",
-    "test-support"
+    "support"
   ],
-  "main": "index.ts",
+  "main": "__index__.ts",
   "repository": {
     "url": "https://github.com/travetto/travetto.git",
     "directory": "module/model-query"
   },
   "dependencies": {
-    "@travetto/di": "^3.0.0-rc.3",
-    "@travetto/model": "^3.0.0-rc.3",
-    "@travetto/schema": "^3.0.0-rc.3"
+    "@travetto/di": "^3.0.0-rc.6",
+    "@travetto/model": "^3.0.0-rc.6",
+    "@travetto/schema": "^3.0.0-rc.6"
   },
-  "docDependencies": {
-    "@travetto/model-mongo": true,
-    "@travetto/model-elasticsearch": true,
-    "@travetto/model-sql": true
+  "peerDependencies": {
+    "@travetto/test": "^3.0.0-rc.6"
+  },
+  "peerDependenciesMeta": {
+    "@travetto/test": {
+      "optional": true
+    }
+  },
+  "travetto": {
+    "displayName": "Data Model Querying"
   },
   "publishConfig": {
     "access": "public"

package/src/internal/model/point.ts

@@ -1,4 +1,4 @@
-import { Util } from '@travetto/base';
+import { DataUtil } from '@travetto/base';
 
 export class PointImpl {
   static validateSchema(input: unknown): 'type' | undefined {
@@ -7,8 +7,10 @@ export class PointImpl {
   }
   static bindSchema(input: unknown): [number, number] | undefined {
     if (Array.isArray(input) && input.length === 2) {
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      return input.map(x => Util.coerceType(x, Number, false)) as [number, number];
+      return [
+        DataUtil.coerceType(input[0], Number, false),
+        DataUtil.coerceType(input[1], Number, false)
+      ];
     }
   }
 }

package/src/internal/query/tokenizer.ts

@@ -1,4 +1,4 @@
-import { Util } from '@travetto/base';
+import { TimeUtil } from '@travetto/base';
 import { Token, TokenizeState, TokenType } from './types';
 
 const OPEN_PARENS = 0x28, CLOSE_PARENS = 0x29, OPEN_BRACKET = 0x5b, CLOSE_BRACKET = 0x5d, COMMA = 0x2c;
@@ -61,7 +61,7 @@ export class QueryLanguageTokenizer {
         value = parseInt(text, 10);
       } else if (/^-?\d+[.]\d+$/.test(text)) {
         value = parseFloat(text);
-      } else if (Util.isTimeSpan(text)) {
+      } else if (TimeUtil.isTimeSpan(text)) {
         value = text;
       } else {
         state.mode = 'identifier';

package/src/internal/query/verifier.ts

@@ -1,5 +1,5 @@
 import { SchemaRegistry, ValidationResultError, ValidationError } from '@travetto/schema';
-import { Class, Util } from '@travetto/base';
+import { Class, ObjectUtil } from '@travetto/base';
 
 import { ModelQuery, Query, PageableModelQuery } from '../../model/query';
 
@@ -37,12 +37,12 @@ const MULTIPLE_KEYS_ALLOWED = new Set([
 /**
  * Query verification service.  Used to verify the query is valid before running.
  */
-class $QueryVerifier {
+export class QueryVerifier {
 
   /**
    * Internal mapping for various clauses
    */
-  #mapping = [
+  static #mapping = [
     [SELECT, 'processSelectClause'] as const,
     [WHERE, 'processWhereClause'] as const,
     [SORT, 'processSortClause'] as const,
@@ -51,7 +51,7 @@ class $QueryVerifier {
   /**
    * Handle generic clauses
    */
-  processGenericClause<T>(state: State, cls: Class<T>, val: object, handler: ProcessingHandler): void {
+  static processGenericClause<T>(state: State, cls: Class<T>, val: object, handler: ProcessingHandler): void {
     const view = SchemaRegistry.getViewSchema(cls);
 
     if (val === undefined || val === null) {
@@ -102,14 +102,14 @@ class $QueryVerifier {
   /**
    * Ensure types match
    */
-  typesMatch(declared: string, actual: string | undefined): boolean {
+  static typesMatch(declared: string, actual: string | undefined): boolean {
     return declared === actual;
   }
 
   /**
    * Check operator clause
    */
-  checkOperatorClause(state: State, declaredType: SimpleType, value: unknown, allowed: Record<string, Set<string>>, isArray: boolean): void {
+  static checkOperatorClause(state: State, declaredType: SimpleType, value: unknown, allowed: Record<string, Set<string>>, isArray: boolean): void {
     if (isArray) {
       if (Array.isArray(value)) {
         // Handle array literal
@@ -120,7 +120,7 @@ class $QueryVerifier {
       }
     }
 
-    if (!Util.isPlainObject(value)) {
+    if (!ObjectUtil.isPlainObject(value)) {
       // Handle literal
       const actualType = TypeUtil.getActualType(value);
       if (!this.typesMatch(declaredType, actualType)) {
@@ -173,7 +173,7 @@ class $QueryVerifier {
   /**
    * Process where clause
    */
-  processWhereClause<T>(st: State, cls: Class<T>, passed: object): void {
+  static processWhereClause<T>(st: State, cls: Class<T>, passed: object): void {
     return this.processGenericClause(st, cls, passed, {
       preMember: (state: State, value: Record<string, unknown>) => {
         const keys = Object.keys(value);
@@ -196,7 +196,7 @@ class $QueryVerifier {
             return true;
           }
         } else if (firstKey === '$not') {
-          if (Util.isPlainObject(sub)) {
+          if (ObjectUtil.isPlainObject(sub)) {
             this.processWhereClause(state, cls, sub);
             return true;
           } else {
@@ -215,14 +215,14 @@ class $QueryVerifier {
   /**
    * Handle group by clause
    */
-  processGroupByClause(state: State, value: object): void {
+  static processGroupByClause(state: State, value: object): void {
 
   }
 
   /**
    * Handle sort clause
    */
-  processSortClause<T>(st: State, cls: Class<T>, passed: object): void {
+  static processSortClause<T>(st: State, cls: Class<T>, passed: object): void {
     return this.processGenericClause(st, cls, passed, {
       onSimpleType: (state, type, value) => {
         if (value === 1 || value === -1 || typeof value === 'boolean') {
@@ -236,7 +236,7 @@ class $QueryVerifier {
   /**
    * Handle select clause
    */
-  processSelectClause<T>(st: State, cls: Class<T>, passed: object): void {
+  static processSelectClause<T>(st: State, cls: Class<T>, passed: object): void {
     return this.processGenericClause(st, cls, passed, {
       onSimpleType: (state, type, value) => {
         const actual = TypeUtil.getActualType(value);
@@ -269,7 +269,7 @@ class $QueryVerifier {
   /**
    * Verify the query
    */
-  verify<T>(cls: Class<T>, query: ModelQuery<T> | Query<T> | PageableModelQuery<T>): void {
+  static verify<T>(cls: Class<T>, query: ModelQuery<T> | Query<T> | PageableModelQuery<T>): void {
     const errors: ValidationError[] = [];
 
     const state = {
@@ -314,6 +314,4 @@ class $QueryVerifier {
       throw new ValidationResultError(errors);
     }
   }
-}
-
-export const QueryVerifier = new $QueryVerifier();
+}

package/src/internal/service/query.ts

@@ -1,4 +1,4 @@
-import { Class, AppError, Util } from '@travetto/base';
+import { Class, AppError, TimeUtil } from '@travetto/base';
 import { ModelRegistry, NotFoundError } from '@travetto/model';
 import { ModelType } from '@travetto/model/src/types/model';
 import { SchemaRegistry } from '@travetto/schema';
@@ -21,7 +21,7 @@ export class ModelQueryUtil {
   static resolveComparator(val: unknown): unknown {
     if (typeof val === 'string') {
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      return Util.timeFromNow(val as '1m');
+      return TimeUtil.timeFromNow(val as '1m');
     } else {
       return val;
     }

package/src/model/where-clause.ts

@@ -1,5 +1,4 @@
-import { Primitive as Prim } from '@travetto/base/src/internal/global-types';
-import { TimeSpan } from '@travetto/base/src/util';
+import { TimeSpan, Primitive } from '@travetto/base';
 
 /**
  * Point as [number,number] with validation and binding support
@@ -8,13 +7,13 @@ import { TimeSpan } from '@travetto/base/src/util';
  */
 export type Point = [number, number];
 
-export type Primitive = Prim | Point;
-export type PrimitiveArray = Primitive[];
+export type QueryPrimitive = Primitive | Point;
+export type QueryPrimitiveArray = QueryPrimitive[];
 export type DistanceUnit = 'mi' | 'm' | 'km' | 'ft' | 'rad';
 
 export type ValidFieldNames<T> = {
   [K in keyof T]:
-  (T[K] extends (Primitive | undefined) ? K :
+  (T[K] extends (QueryPrimitive | undefined) ? K :
     (T[K] extends (Function | undefined) ? never :
       K))
 }[keyof T];

package/support/doc.support.ts

@@ -0,0 +1,29 @@
+import { readFileSync } from 'fs';
+
+import { RootIndex } from '@travetto/manifest';
+import { d } from '@travetto/doc';
+import { AllTypeMap } from '@travetto/doc/src/nodes';
+
+export const Links = {
+  QueryCrud: d.SnippetLink('Query Crud', '@travetto/model-query/src/service/crud.ts', /export interface/),
+  QueryFacet: d.SnippetLink('Facet', '@travetto/model-query/src/service/facet.ts', /export interface/),
+  QuerySuggest: d.SnippetLink('Suggest', '@travetto/model-query/src/service/suggest.ts', /export interface/),
+  Query: d.SnippetLink('Query', '@travetto/model-query/src/service/query.ts', /export interface/),
+};
+
+export const ModelQueryTypes = (file: string | Function): AllTypeMap['SnippetLink'][] => {
+  if (typeof file !== 'string') {
+    file = RootIndex.getFunctionMetadata(file)!.source;
+  }
+  const contents = readFileSync(file, 'utf8');
+  const found: AllTypeMap['SnippetLink'][] = [];
+  const seen = new Set();
+  for (const [, key] of contents.matchAll(/Model(Query(Suggest|Facet|Crud)?)Support/g)) {
+    if (!seen.has(key)) {
+      seen.add(key);
+      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+      found.push(Links[key as keyof typeof Links]);
+    }
+  }
+  return found;
+};

package/{test-support → support/test}/crud.ts

@@ -1,11 +1,11 @@
-import * as assert from 'assert';
+import assert from 'assert';
 
 import { Suite, Test } from '@travetto/test';
-import { BaseModelSuite } from '@travetto/model/test-support/base';
+import { BaseModelSuite } from '@travetto/model/support/test/base';
 import { ModelCrudSupport } from '@travetto/model/src/service/crud';
 
 import { Address, Person } from './types';
-import { ModelQueryCrudSupport } from '../src/service/crud';
+import { ModelQueryCrudSupport } from '../../src/service/crud';
 
 @Suite()
 export abstract class ModelQueryCrudSuite extends BaseModelSuite<ModelQueryCrudSupport & ModelCrudSupport> {

package/{test-support → support/test}/facet.ts

@@ -1,11 +1,11 @@
-import * as assert from 'assert';
+import assert from 'assert';
 
 import { ModelCrudSupport } from '@travetto/model';
-import { BaseModelSuite } from '@travetto/model/test-support/base';
+import { BaseModelSuite } from '@travetto/model/support/test/base';
 import { Suite, Test } from '@travetto/test';
 
 import { Person } from './types';
-import { ModelQueryFacetSupport } from '../src/service/facet';
+import { ModelQueryFacetSupport } from '../../src/service/facet';
 
 const pick = <T>(arr: T[]): T => arr[Math.trunc(Math.random() * arr.length)]!;
 

package/{test-support → support/test}/polymorphism.ts

@@ -1,17 +1,17 @@
-import * as assert from 'assert';
+import assert from 'assert';
 
 import { Suite, Test } from '@travetto/test';
-import { BaseModelSuite } from '@travetto/model/test-support/base';
+import { BaseModelSuite } from '@travetto/model/support/test/base';
 import { ModelCrudSupport } from '@travetto/model/src/service/crud';
-import { Doctor, Engineer, Worker, Firefighter } from '@travetto/model/test-support/polymorphism';
+import { Doctor, Engineer, Worker, Firefighter } from '@travetto/model/support/test/polymorphism';
 import { NotFoundError } from '@travetto/model/src/error/not-found';
 
-import { ModelQueryCrudSupport } from '../src/service/crud';
-import { ModelQuerySupport } from '../src/service/query';
-import { ModelQueryFacetSupport } from '../src/service/facet';
-import { ModelQuerySuggestSupport } from '../src/service/suggest';
+import { ModelQueryCrudSupport } from '../../src/service/crud';
+import { ModelQuerySupport } from '../../src/service/query';
+import { ModelQueryFacetSupport } from '../../src/service/facet';
+import { ModelQuerySuggestSupport } from '../../src/service/suggest';
 
-import { isQueryCrudSupported, isQueryFacetSupported, isQuerySuggestSupported } from '../src/internal/service/common';
+import { isQueryCrudSupported, isQueryFacetSupported, isQuerySuggestSupported } from '../../src/internal/service/common';
 
 @Suite()
 export abstract class ModelQueryPolymorphismSuite extends BaseModelSuite<ModelQuerySupport & ModelCrudSupport> {

package/{test-support → support/test}/query.ts

@@ -1,13 +1,14 @@
-import * as assert from 'assert';
+import assert from 'assert';
 
 import { Suite, Test } from '@travetto/test';
-import { BaseModelSuite } from '@travetto/model/test-support/base';
+import { BaseModelSuite } from '@travetto/model/support/test/base';
 import { ModelCrudSupport } from '@travetto/model/src/service/crud';
-import { Util } from '@travetto/base';
+import { TimeUtil } from '@travetto/base';
 
-import { ModelQuerySupport } from '../src/service/query';
 import { Aged, Location, Names, Note, Person, SimpleList } from './types';
 
+import { ModelQuerySupport } from '../../src/service/query';
+
 @Suite()
 export abstract class ModelQuerySuite extends BaseModelSuite<ModelQuerySupport & ModelCrudSupport> {
 
@@ -253,7 +254,7 @@ export abstract class ModelQuerySuite extends BaseModelSuite<ModelQuerySupport &
   async verifyDateRange() {
     const service = await this.service;
     await this.saveAll(Aged, (['-5d', '-4d', '-3d', '-2d', '-1d', '0d', '1d', '2d', '3d', '4d', '5d'] as const).map(delta =>
-      Aged.from({ createdAt: Util.timeFromNow(delta) })
+      Aged.from({ createdAt: TimeUtil.timeFromNow(delta) })
     ));
 
     const simple = await service.queryCount(Aged, {
@@ -290,7 +291,7 @@ export abstract class ModelQuerySuite extends BaseModelSuite<ModelQuerySupport &
       where: {
         createdAt: {
           $gt: new Date(),
-          $lt: Util.timeFromNow('3d')
+          $lt: TimeUtil.timeFromNow('3d')
         }
       }
     });

package/{test-support → support/test}/suggest.ts

@@ -1,11 +1,11 @@
-import * as assert from 'assert';
+import assert from 'assert';
 
 import { ModelCrudSupport } from '@travetto/model';
-import { BaseModelSuite } from '@travetto/model/test-support/base';
+import { BaseModelSuite } from '@travetto/model/support/test/base';
 import { Suite, Test } from '@travetto/test';
 
 import { Person } from './types';
-import { ModelQuerySuggestSupport } from '../src/service/suggest';
+import { ModelQuerySuggestSupport } from '../../src/service/suggest';
 
 @Suite()
 export abstract class ModelQuerySuggestSuite extends BaseModelSuite<ModelQuerySuggestSupport & ModelCrudSupport> {

package/{test-support → support/test}/types.ts

@@ -1,7 +1,7 @@
 import { Precision, Schema, Text } from '@travetto/schema';
 import { Model, ModelType } from '@travetto/model';
 
-import { Point } from '../src/model/where-clause';
+import { Point } from '../../src/model/where-clause';
 
 @Schema()
 export class Address {