@travetto/model-elasticsearch 6.0.0-rc.1 → 6.0.0-rc.3

package/README.md

@@ -13,17 +13,18 @@ npm install @travetto/model-elasticsearch
 yarn add @travetto/model-elasticsearch
 ```
 
-This module provides an [elasticsearch](https://elastic.co)-based implementation of the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.").  This source allows the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") module to read, write and query against [elasticsearch](https://elastic.co). In development mode, [ElasticsearchModelService](https://github.com/travetto/travetto/tree/main/module/model-elasticsearch/src/service.ts#L37) will also modify the [elasticsearch](https://elastic.co) schema in real time to minimize impact to development. 
+This module provides an [elasticsearch](https://elastic.co)-based implementation of the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.").  This source allows the [Data Modeling Support](https://github.com/travetto/travetto/tree/main/module/model#readme "Datastore abstraction for core operations.") module to read, write and query against [elasticsearch](https://elastic.co). In development mode, [ElasticsearchModelService](https://github.com/travetto/travetto/tree/main/module/model-elasticsearch/src/service.ts#L30) will also modify the [elasticsearch](https://elastic.co) schema in real time to minimize impact to development. 
 
 Supported features:
-   *  [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/service/crud.ts#L11)
-   *  [Bulk](https://github.com/travetto/travetto/tree/main/module/model/src/service/bulk.ts#L19)
-   *  [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/service/expiry.ts#L11)
-   *  [Indexed](https://github.com/travetto/travetto/tree/main/module/model/src/service/indexed.ts#L12)
-   *  [Query Crud](https://github.com/travetto/travetto/tree/main/module/model-query/src/service/crud.ts#L11)
-   *  [Facet](https://github.com/travetto/travetto/tree/main/module/model-query/src/service/facet.ts#L12)
-   *  [Query](https://github.com/travetto/travetto/tree/main/module/model-query/src/service/query.ts#L10)
-   *  [Suggest](https://github.com/travetto/travetto/tree/main/module/model-query/src/service/suggest.ts#L12)
+   *  [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/types/crud.ts#L11)
+   *  [Bulk](https://github.com/travetto/travetto/tree/main/module/model/src/types/bulk.ts#L64)
+   *  [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/types/expiry.ts#L10)
+   *  [Indexed](https://github.com/travetto/travetto/tree/main/module/model/src/types/indexed.ts#L11)
+   *  [Query Crud](https://github.com/travetto/travetto/tree/main/module/model-query/src/types/crud.ts#L11)
+   *  [Facet](https://github.com/travetto/travetto/tree/main/module/model-query/src/types/facet.ts#L14)
+   *  [Query](https://github.com/travetto/travetto/tree/main/module/model-query/src/types/query.ts#L10)
+   *  [Suggest](https://github.com/travetto/travetto/tree/main/module/model-query/src/types/suggest.ts#L12)
+
 Out of the box, by installing the module, everything should be wired up by default.If you need to customize any aspect of the source or config, you can override and register it with the [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.") module.
 
 **Code: Wiring up a custom Model Source**
@@ -45,15 +46,6 @@ where the [ElasticsearchModelConfig](https://github.com/travetto/travetto/tree/m
 
 **Code: Structure of ElasticsearchModelConfig**
 ```typescript
-import { TimeSpan } from '@travetto/runtime';
-import { Config } from '@travetto/config';
-import { Field } from '@travetto/schema';
-
-import { EsSchemaConfig } from './internal/types';
-
-/**
- * Elasticsearch model config
- */
 @Config('model.elasticsearch')
 export class ElasticsearchModelConfig {
   /**

package/__index__.ts

@@ -1,2 +1,2 @@
-export * from './src/config';
-export * from './src/service';
+export * from './src/config.ts';
+export * from './src/service.ts';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/model-elasticsearch",
-  "version": "6.0.0-rc.1",
+  "version": "6.0.0-rc.3",
   "description": "Elasticsearch backing for the travetto model module, with real-time modeling support for Elasticsearch mappings.",
   "keywords": [
     "elasticsearch",
@@ -27,11 +27,11 @@
     "directory": "module/model-elasticsearch"
   },
   "dependencies": {
-    "@elastic/elasticsearch": "^8.17.0",
-    "@travetto/cli": "^6.0.0-rc.1",
-    "@travetto/config": "^6.0.0-rc.1",
-    "@travetto/model": "^6.0.0-rc.1",
-    "@travetto/model-query": "^6.0.0-rc.1"
+    "@elastic/elasticsearch": "^8.18.1",
+    "@travetto/cli": "^6.0.0-rc.3",
+    "@travetto/config": "^6.0.0-rc.2",
+    "@travetto/model": "^6.0.0-rc.2",
+    "@travetto/model-query": "^6.0.0-rc.2"
   },
   "travetto": {
     "displayName": "Elasticsearch Model Source"

package/src/config.ts

@@ -2,7 +2,7 @@ import { TimeSpan } from '@travetto/runtime';
 import { Config } from '@travetto/config';
 import { Field } from '@travetto/schema';
 
-import { EsSchemaConfig } from './internal/types';
+import { EsSchemaConfig } from './internal/types.ts';
 
 /**
  * Elasticsearch model config

package/src/index-manager.ts

@@ -1,12 +1,11 @@
 import { Client, estypes } from '@elastic/elasticsearch';
 
 import { Class } from '@travetto/runtime';
-import { ModelRegistry, ModelType } from '@travetto/model';
-import { ModelStorageSupport } from '@travetto/model/src/service/storage';
+import { ModelRegistry, ModelType, ModelStorageSupport } from '@travetto/model';
 import { SchemaChange } from '@travetto/schema';
 
-import { ElasticsearchModelConfig } from './config';
-import { ElasticsearchSchemaUtil } from './internal/schema';
+import { ElasticsearchModelConfig } from './config.ts';
+import { ElasticsearchSchemaUtil } from './internal/schema.ts';
 
 /**
  * Manager for elasticsearch indices and schemas

package/src/internal/query.ts

@@ -1,14 +1,11 @@
 import { estypes } from '@elastic/elasticsearch';
 
 import { castTo, Class, TypedObject } from '@travetto/runtime';
-import { WhereClause, SelectClause, SortClause, Query } from '@travetto/model-query';
-import { ModelQueryUtil } from '@travetto/model-query/src/internal/service/query';
-import { ModelRegistry } from '@travetto/model/src/registry/model';
-import { IndexConfig } from '@travetto/model/src/registry/types';
-import { ModelType } from '@travetto/model/src/types/model';
+import { WhereClause, SelectClause, SortClause, Query, ModelQueryUtil } from '@travetto/model-query';
+import { IndexConfig, ModelType, ModelRegistry } from '@travetto/model';
 import { DataUtil, SchemaRegistry } from '@travetto/schema';
 
-import { EsSchemaConfig } from './types';
+import { EsSchemaConfig } from './types.ts';
 
 /**
  * Support tools for dealing with elasticsearch specific requirements

package/src/internal/schema.ts

@@ -1,11 +1,12 @@
 import { estypes } from '@elastic/elasticsearch';
 
-import { Class } from '@travetto/runtime';
+import { Class, toConcrete } from '@travetto/runtime';
 import { ModelRegistry } from '@travetto/model';
-import { PointImpl } from '@travetto/model-query/src/internal/model/point';
-import { DataUtil, SchemaRegistry } from '@travetto/schema';
+import { Point, DataUtil, SchemaRegistry } from '@travetto/schema';
 
-import { EsSchemaConfig } from './types';
+import { EsSchemaConfig } from './types.ts';
+
+const PointImpl = toConcrete<Point>();
 
 /**
  * Utils for ES Schema management

package/src/service.ts

@@ -2,8 +2,8 @@ import { Client, errors, estypes } from '@elastic/elasticsearch';
 
 import {
   ModelCrudSupport, BulkOp, BulkResponse, ModelBulkSupport, ModelExpirySupport,
-  ModelIndexedSupport, ModelType, ModelStorageSupport, NotFoundError, ModelRegistry,
-  OptionalId
+  ModelIndexedSupport, ModelType, ModelStorageSupport, NotFoundError, ModelRegistry, OptionalId,
+  ModelCrudUtil, ModelIndexedUtil, ModelStorageUtil, ModelExpiryUtil, ModelBulkUtil
 } from '@travetto/model';
 import { ShutdownManager, type DeepPartial, type Class, castTo, asFull, TypedObject, asConstructable } from '@travetto/runtime';
 import { SchemaChange, BindUtil } from '@travetto/schema';
@@ -11,24 +11,17 @@ import { Injectable } from '@travetto/di';
 import {
   ModelQuery, ModelQueryCrudSupport, ModelQueryFacetSupport,
   ModelQuerySupport, PageableModelQuery, Query, ValidStringFields,
-  QueryVerifier
+  QueryVerifier, ModelQuerySuggestSupport,
+  ModelQueryUtil, ModelQuerySuggestUtil, ModelQueryCrudUtil,
+  ModelQueryFacet,
 } from '@travetto/model-query';
 
-import { ModelCrudUtil } from '@travetto/model/src/internal/service/crud';
-import { ModelIndexedUtil } from '@travetto/model/src/internal/service/indexed';
-import { ModelStorageUtil } from '@travetto/model/src/internal/service/storage';
-import { ModelQueryUtil } from '@travetto/model-query/src/internal/service/query';
-import { ModelQuerySuggestUtil } from '@travetto/model-query/src/internal/service/suggest';
-import { ModelExpiryUtil } from '@travetto/model/src/internal/service/expiry';
-import { ModelQueryExpiryUtil } from '@travetto/model-query/src/internal/service/expiry';
-import { ModelQuerySuggestSupport } from '@travetto/model-query/src/service/suggest';
-import { ModelBulkUtil } from '@travetto/model/src/internal/service/bulk';
-
-import { ElasticsearchModelConfig } from './config';
-import { EsBulkError } from './internal/types';
-import { ElasticsearchQueryUtil } from './internal/query';
-import { ElasticsearchSchemaUtil } from './internal/schema';
-import { IndexManager } from './index-manager';
+
+import { ElasticsearchModelConfig } from './config.ts';
+import { EsBulkError } from './internal/types.ts';
+import { ElasticsearchQueryUtil } from './internal/query.ts';
+import { ElasticsearchSchemaUtil } from './internal/schema.ts';
+import { IndexManager } from './index-manager.ts';
 
 /**
  * Elasticsearch model source.
@@ -57,12 +50,12 @@ export class ElasticsearchModelService implements
       query = undefined;
     }
     try {
-      const res = await this.client.search<T>({
+      const result = await this.client.search<T>({
         ...this.manager.getIdentity(cls),
         ...search,
         query
       });
-      return res;
+      return result;
     } catch (err) {
       if (err instanceof errors.ResponseError && err.meta.body && typeof err.meta.body === 'object' && 'error' in err.meta.body) {
         console.error(err.meta.body.error);
@@ -138,8 +131,8 @@ export class ElasticsearchModelService implements
 
   async get<T extends ModelType>(cls: Class<T>, id: string): Promise<T> {
     try {
-      const res = await this.client.get<T>({ ...this.manager.getIdentity(cls), id });
-      return this.postLoad(cls, res);
+      const result = await this.client.get<T>({ ...this.manager.getIdentity(cls), id });
+      return this.postLoad(cls, result);
     } catch {
       throw new NotFoundError(cls, id);
     }
@@ -149,12 +142,12 @@ export class ElasticsearchModelService implements
     ModelCrudUtil.ensureNotSubType(cls);
 
     try {
-      const res = await this.client.delete({
+      const result = await this.client.delete({
         ...this.manager.getIdentity(cls),
         id,
         refresh: true,
       });
-      if (res.result === 'not_found') {
+      if (result.result === 'not_found') {
         throw new NotFoundError(cls, id);
       }
     } catch (err) {
@@ -299,7 +292,7 @@ export class ElasticsearchModelService implements
       return acc;
     }, []);
 
-    const res = await this.client.bulk({
+    const result = await this.client.bulk({
       operations: body,
       refresh: true
     });
@@ -318,8 +311,8 @@ export class ElasticsearchModelService implements
 
     type Count = keyof typeof out['counts'];
 
-    for (let i = 0; i < res.items.length; i++) {
-      const item = res.items[i];
+    for (let i = 0; i < result.items.length; i++) {
+      const item = result.items[i];
       const [k] = TypedObject.keys(item);
       const v = item[k]!;
       if (v.error) {
@@ -353,27 +346,27 @@ export class ElasticsearchModelService implements
 
   // Expiry
   deleteExpired<T extends ModelType>(cls: Class<T>): Promise<number> {
-    return ModelQueryExpiryUtil.deleteExpired(this, cls);
+    return ModelQueryCrudUtil.deleteExpired(this, cls);
   }
 
   // Indexed
   async getByIndex<T extends ModelType>(cls: Class<T>, idx: string, body: DeepPartial<T>): Promise<T> {
     const { key } = ModelIndexedUtil.computeIndexKey(cls, idx, body);
-    const res = await this.execSearch<T>(cls, {
+    const result = await this.execSearch<T>(cls, {
       query: ElasticsearchQueryUtil.getSearchQuery(cls,
         ElasticsearchQueryUtil.extractWhereTermQuery(cls,
           ModelIndexedUtil.projectIndex(cls, idx, body))
       )
     });
-    if (!res.hits.hits.length) {
+    if (!result.hits.hits.length) {
       throw new NotFoundError(`${cls.name}: ${idx}`, key);
     }
-    return this.postLoad(cls, res.hits.hits[0]);
+    return this.postLoad(cls, result.hits.hits[0]);
   }
 
   async deleteByIndex<T extends ModelType>(cls: Class<T>, idx: string, body: DeepPartial<T>): Promise<void> {
     const { key } = ModelIndexedUtil.computeIndexKey(cls, idx, body);
-    const res = await this.client.deleteByQuery({
+    const result = await this.client.deleteByQuery({
       index: this.manager.getIdentity(cls).index,
       query: ElasticsearchQueryUtil.getSearchQuery(cls,
         ElasticsearchQueryUtil.extractWhereTermQuery(cls,
@@ -381,7 +374,7 @@ export class ElasticsearchModelService implements
       ),
       refresh: true
     });
-    if (res.deleted) {
+    if (result.deleted) {
       return;
     }
     throw new NotFoundError(`${cls.name}: ${idx}`, key);
@@ -444,8 +437,8 @@ export class ElasticsearchModelService implements
     await QueryVerifier.verify(cls, query);
 
     const req = ElasticsearchQueryUtil.getSearchObject(cls, { ...query, limit: 0 }, this.config.schemaConfig);
-    const res: number | { value: number } = (await this.execSearch(cls, req)).hits.total || { value: 0 };
-    return typeof res !== 'number' ? res.value : res;
+    const result: number | { value: number } = (await this.execSearch(cls, req)).hits.total || { value: 0 };
+    return typeof result !== 'number' ? result.value : result;
   }
 
   // Query Crud
@@ -471,7 +464,7 @@ export class ElasticsearchModelService implements
     const copy = BindUtil.bindSchemaToObject(cls, asFull<T>({}), item);
 
     try {
-      const res = await this.client.updateByQuery({
+      const result = await this.client.updateByQuery({
         ...this.manager.getIdentity(cls),
         refresh: true,
         query: search.query,
@@ -479,7 +472,7 @@ export class ElasticsearchModelService implements
         script: ElasticsearchSchemaUtil.generateReplaceScript(castTo(copy))
       });
 
-      if (res.version_conflicts || res.updated === undefined || res.updated === 0) {
+      if (result.version_conflicts || result.updated === undefined || result.updated === 0) {
         throw new NotFoundError(cls, id);
       }
     } catch (err) {
@@ -497,12 +490,12 @@ export class ElasticsearchModelService implements
     await QueryVerifier.verify(cls, query);
 
     const { sort: _, ...q } = ElasticsearchQueryUtil.getSearchObject(cls, query, this.config.schemaConfig, false);
-    const res = await this.client.deleteByQuery({
+    const result = await this.client.deleteByQuery({
       ...this.manager.getIdentity(cls),
       ...q,
       refresh: true,
     });
-    return res.deleted ?? 0;
+    return result.deleted ?? 0;
   }
 
   async updatePartialByQuery<T extends ModelType>(cls: Class<T>, query: ModelQuery<T>, data: Partial<T>): Promise<number> {
@@ -512,14 +505,14 @@ export class ElasticsearchModelService implements
     const script = ElasticsearchSchemaUtil.generateUpdateScript(item);
 
     const search = ElasticsearchQueryUtil.getSearchObject(cls, query, this.config.schemaConfig);
-    const res = await this.client.updateByQuery({
+    const result = await this.client.updateByQuery({
       ...this.manager.getIdentity(cls),
       refresh: true,
       query: search.query,
       script,
     });
 
-    return res.updated ?? 0;
+    return result.updated ?? 0;
   }
 
   // Query Facet
@@ -528,8 +521,8 @@ export class ElasticsearchModelService implements
 
     const q = ModelQuerySuggestUtil.getSuggestQuery<T>(cls, field, prefix, query);
     const search = ElasticsearchQueryUtil.getSearchObject(cls, q);
-    const res = await this.execSearch(cls, search);
-    const all = await Promise.all(res.hits.hits.map(x => this.postLoad(cls, x)));
+    const result = await this.execSearch(cls, search);
+    const all = await Promise.all(result.hits.hits.map(x => this.postLoad(cls, x)));
     return ModelQuerySuggestUtil.combineSuggestResults(cls, field, prefix, all, (x, v) => v, query && query.limit);
   }
 
@@ -541,13 +534,13 @@ export class ElasticsearchModelService implements
       ...query
     });
     const search = ElasticsearchQueryUtil.getSearchObject(cls, q);
-    const res = await this.execSearch(cls, search);
-    const all = await Promise.all(res.hits.hits.map(x => castTo<T>(({ [field]: field === 'id' ? x._id : x._source![field] }))));
+    const result = await this.execSearch(cls, search);
+    const all = await Promise.all(result.hits.hits.map(x => castTo<T>(({ [field]: field === 'id' ? x._id : x._source![field] }))));
     return ModelQuerySuggestUtil.combineSuggestResults(cls, field, prefix, all, x => x, query && query.limit);
   }
 
   // Facet
-  async facet<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, query?: ModelQuery<T>): Promise<{ key: string, count: number }[]> {
+  async facet<T extends ModelType>(cls: Class<T>, field: ValidStringFields<T>, query?: ModelQuery<T>): Promise<ModelQueryFacet[]> {
     await QueryVerifier.verify(cls, query);
 
     const q = ElasticsearchQueryUtil.getSearchObject(cls, query ?? {}, this.config.schemaConfig);
@@ -560,8 +553,8 @@ export class ElasticsearchModelService implements
       size: 0
     };
 
-    const res = await this.execSearch(cls, search);
-    const { buckets } = castTo<estypes.AggregationsStringTermsAggregate>('buckets' in res.aggregations![field] ? res.aggregations![field] : { buckets: [] });
+    const result = await this.execSearch(cls, search);
+    const { buckets } = castTo<estypes.AggregationsStringTermsAggregate>('buckets' in result.aggregations![field] ? result.aggregations![field] : { buckets: [] });
     const out = Array.isArray(buckets) ? buckets.map(b => ({ key: b.key, count: b.doc_count })) : [];
     return out;
   }