@travetto/model-elasticsearch 3.0.2 → 3.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +6 -11
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -1,6 +1,7 @@
1
1
  <!-- This file was generated by @travetto/doc and should not be modified directly -->
2
- <!-- Please modify https://github.com/travetto/travetto/tree/main/module/model-elasticsearch/DOC.ts and execute "npx trv doc" to rebuild -->
2
+ <!-- Please modify https://github.com/travetto/travetto/tree/main/module/model-elasticsearch/DOC.tsx and execute "npx trv doc" to rebuild -->
3
3
  # Elasticsearch Model Source
4
+
4
5
  ## Elasticsearch backing for the travetto model module, with real-time modeling support for Elasticsearch mappings.
5
6
 
6
7
  **Install: @travetto/model-elasticsearch**
@@ -12,10 +13,9 @@ npm install @travetto/model-elasticsearch
12
13
  yarn add @travetto/model-elasticsearch
13
14
  ```
14
15
 
15
- 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#L43) will also modify the [elasticsearch](https://elastic.co) schema in real time to minimize impact to development.
16
+ 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#L43) will also modify the [elasticsearch](https://elastic.co) schema in real time to minimize impact to development.
16
17
 
17
18
  Supported features:
18
-
19
19
  * [CRUD](https://github.com/travetto/travetto/tree/main/module/model/src/service/crud.ts#L11)
20
20
  * [Bulk](https://github.com/travetto/travetto/tree/main/module/model/src/service/bulk.ts#L19)
21
21
  * [Expiry](https://github.com/travetto/travetto/tree/main/module/model/src/service/expiry.ts#L11)
@@ -24,11 +24,8 @@ Supported features:
24
24
  * [Facet](https://github.com/travetto/travetto/tree/main/module/model-query/src/service/facet.ts#L12)
25
25
  * [Query](https://github.com/travetto/travetto/tree/main/module/model-query/src/service/query.ts#L10)
26
26
  * [Suggest](https://github.com/travetto/travetto/tree/main/module/model-query/src/service/suggest.ts#L12)
27
+ 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.
27
28
 
28
- 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
29
- 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.
30
-
31
-
32
29
  **Code: Wiring up a custom Model Source**
33
30
  ```typescript
34
31
  import { InjectableFactory } from '@travetto/di';
@@ -44,9 +41,8 @@ export class Init {
44
41
  }
45
42
  ```
46
43
 
47
- where the [ElasticsearchModelConfig](https://github.com/travetto/travetto/tree/main/module/model-elasticsearch/src/config.ts#L11) is defined by:
44
+ where the [ElasticsearchModelConfig](https://github.com/travetto/travetto/tree/main/module/model-elasticsearch/src/config.ts#L11) is defined by:
48
45
 
49
-
50
46
  **Code: Structure of ElasticsearchModelConfig**
51
47
  ```typescript
52
48
  import { TimeSpan } from '@travetto/base';
@@ -114,5 +110,4 @@ export class ElasticsearchModelConfig {
114
110
  }
115
111
  ```
116
112
 
117
- Additionally, you can see that the class is registered with the [@Config](https://github.com/travetto/travetto/tree/main/module/config/src/decorator.ts#L13) annotation, and so these values can be overridden using the
118
- standard [Configuration](https://github.com/travetto/travetto/tree/main/module/config#readme "Configuration support")resolution paths.
113
+ Additionally, you can see that the class is registered with the [@Config](https://github.com/travetto/travetto/tree/main/module/config/src/decorator.ts#L13) annotation, and so these values can be overridden using the standard [Configuration](https://github.com/travetto/travetto/tree/main/module/config#readme "Configuration support") resolution paths.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@travetto/model-elasticsearch",
3
- "version": "3.0.2",
3
+ "version": "3.0.3",
4
4
  "description": "Elasticsearch backing for the travetto model module, with real-time modeling support for Elasticsearch mappings.",
5
5
  "keywords": [
6
6
  "elasticsearch",
@@ -28,12 +28,12 @@
28
28
  },
29
29
  "dependencies": {
30
30
  "@elastic/elasticsearch": "^7.17.0",
31
- "@travetto/config": "^3.0.2",
32
- "@travetto/model": "^3.0.2",
33
- "@travetto/model-query": "^3.0.2"
31
+ "@travetto/config": "^3.0.3",
32
+ "@travetto/model": "^3.0.3",
33
+ "@travetto/model-query": "^3.0.3"
34
34
  },
35
35
  "peerDependencies": {
36
- "@travetto/command": "^3.0.2"
36
+ "@travetto/command": "^3.0.3"
37
37
  },
38
38
  "peerDependenciesMeta": {
39
39
  "@travetto/command": {