@empathyco/x-components 6.0.0-alpha.232 → 6.0.0-alpha.234
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.
- package/CHANGELOG.md +21 -0
- package/core/index.js +1 -0
- package/core/index.js.map +1 -1
- package/docs/API-reference/api/x-components.aimutations.md +9 -9
- package/docs/API-reference/api/x-components.aimutations.setsuggestionssearchstatus.md +13 -0
- package/docs/API-reference/api/{x-components.aimutations.setsuggestionsloading.md → x-components.aimutations.setsuggestionsstatus.md} +4 -4
- package/docs/API-reference/api/x-components.aistate.md +9 -9
- package/docs/API-reference/api/{x-components.aistate.suggestionssearchloading.md → x-components.aistate.suggestionssearchstatus.md} +4 -4
- package/docs/API-reference/api/{x-components.aistate.suggestionsloading.md → x-components.aistate.suggestionsstatus.md} +4 -4
- package/docs/API-reference/api/x-components.cancelfetchandsavepartialresultsenrichment.md +17 -0
- package/docs/API-reference/api/x-components.cancelfetchandsaveresultsenrichment.md +17 -0
- package/docs/API-reference/api/x-components.defaultresultsenrichmentservice._constructor_.md +13 -0
- package/docs/API-reference/api/x-components.defaultresultsenrichmentservice.fetchresults.md +52 -0
- package/docs/API-reference/api/x-components.defaultresultsenrichmentservice.instance.md +13 -0
- package/docs/API-reference/api/x-components.defaultresultsenrichmentservice.md +164 -0
- package/docs/API-reference/api/x-components.defaultresultsenrichmentservice.store.md +11 -0
- package/docs/API-reference/api/x-components.defaultresultsenrichmentservice.updateresults.md +66 -0
- package/docs/API-reference/api/x-components.fetchandsavepartialresultsenrichment.md +66 -0
- package/docs/API-reference/api/x-components.fetchandsavepartialresultsenrichmentwire.md +13 -0
- package/docs/API-reference/api/x-components.fetchandsaveresultsenrichment.md +66 -0
- package/docs/API-reference/api/x-components.fetchandsaveresultsenrichmentwire.md +13 -0
- package/docs/API-reference/api/x-components.hierarchicalfilter.md +1 -0
- package/docs/API-reference/api/x-components.md +88 -0
- package/docs/API-reference/api/x-components.recommendationsactions.cancelfetchandsaverecommendationsenrichment.md +13 -0
- package/docs/API-reference/api/x-components.recommendationsactions.fetchandsaverecommendationsenrichment.md +13 -0
- package/docs/API-reference/api/x-components.recommendationsactions.md +38 -0
- package/docs/API-reference/api/x-components.recommendationsmutations.md +19 -0
- package/docs/API-reference/api/x-components.recommendationsmutations.updaterecommendationsfromenrichment.md +13 -0
- package/docs/API-reference/api/x-components.resultsenrichmentservice.fetchresults.md +13 -0
- package/docs/API-reference/api/x-components.resultsenrichmentservice.md +77 -0
- package/docs/API-reference/api/x-components.resultsenrichmentservice.updateresults.md +13 -0
- package/docs/API-reference/api/x-components.searchactions.fetchandsavepartialresultsenrichment.md +13 -0
- package/docs/API-reference/api/x-components.searchactions.fetchandsaveresultsenrichment.md +13 -0
- package/docs/API-reference/api/x-components.searchactions.md +38 -0
- package/docs/API-reference/api/x-components.searchmutations.md +38 -0
- package/docs/API-reference/api/x-components.searchmutations.updatepartialresultsfromenrichment.md +13 -0
- package/docs/API-reference/api/x-components.searchmutations.updateresultsfromenrichment.md +13 -0
- package/docs/API-reference/api/x-components.searchxevents.md +19 -0
- package/docs/API-reference/api/x-components.searchxevents.partialresultschanged.md +13 -0
- package/docs/API-reference/api/x-components.simplefilter.md +1 -0
- package/docs/API-reference/api/x-components.snippetcallbacks.md +1 -0
- package/js/index.js +4 -1
- package/js/index.js.map +1 -1
- package/js/services/results-enrichment.service.js +37 -0
- package/js/services/results-enrichment.service.js.map +1 -0
- package/js/x-modules/ai/components/ai-overview.vue.js.map +1 -1
- package/js/x-modules/ai/components/ai-overview.vue2.js +3 -2
- package/js/x-modules/ai/components/ai-overview.vue2.js.map +1 -1
- package/js/x-modules/ai/store/actions/fetch-and-save-ai-suggestions-search.action.js +2 -2
- package/js/x-modules/ai/store/actions/fetch-and-save-ai-suggestions-search.action.js.map +1 -1
- package/js/x-modules/ai/store/actions/fetch-and-save-ai-suggestions.action.js +3 -3
- package/js/x-modules/ai/store/actions/fetch-and-save-ai-suggestions.action.js.map +1 -1
- package/js/x-modules/ai/store/module.js +6 -6
- package/js/x-modules/ai/store/module.js.map +1 -1
- package/js/x-modules/recommendations/store/actions/fetch-and-save-recommendations-enrichment.action.js +30 -0
- package/js/x-modules/recommendations/store/actions/fetch-and-save-recommendations-enrichment.action.js.map +1 -0
- package/js/x-modules/recommendations/store/module.js +7 -0
- package/js/x-modules/recommendations/store/module.js.map +1 -1
- package/js/x-modules/recommendations/wiring.js +9 -0
- package/js/x-modules/recommendations/wiring.js.map +1 -1
- package/js/x-modules/search/store/actions/fetch-and-save-partial-results-enrichment.action.js +33 -0
- package/js/x-modules/search/store/actions/fetch-and-save-partial-results-enrichment.action.js.map +1 -0
- package/js/x-modules/search/store/actions/fetch-and-save-results-enrichment.action.js +28 -0
- package/js/x-modules/search/store/actions/fetch-and-save-results-enrichment.action.js.map +1 -0
- package/js/x-modules/search/store/emitters.js +1 -0
- package/js/x-modules/search/store/emitters.js.map +1 -1
- package/js/x-modules/search/store/module.js +15 -0
- package/js/x-modules/search/store/module.js.map +1 -1
- package/js/x-modules/search/wiring.js +17 -1
- package/js/x-modules/search/wiring.js.map +1 -1
- package/package.json +2 -2
- package/report/x-components.api.json +1030 -103
- package/report/x-components.api.md +64 -10
- package/search/index.js +3 -1
- package/types/src/components/snippet-callbacks.vue.d.ts +1 -0
- package/types/src/components/snippet-callbacks.vue.d.ts.map +1 -1
- package/types/src/services/index.d.ts +1 -0
- package/types/src/services/index.d.ts.map +1 -1
- package/types/src/services/results-enrichment.service.d.ts +31 -0
- package/types/src/services/results-enrichment.service.d.ts.map +1 -0
- package/types/src/services/services.types.d.ts +21 -0
- package/types/src/services/services.types.d.ts.map +1 -1
- package/types/src/x-modules/ai/components/ai-overview.vue.d.ts.map +1 -1
- package/types/src/x-modules/ai/store/module.d.ts.map +1 -1
- package/types/src/x-modules/ai/store/types.d.ts +11 -10
- package/types/src/x-modules/ai/store/types.d.ts.map +1 -1
- package/types/src/x-modules/facets/components/filters/hierarchical-filter.vue.d.ts +1 -0
- package/types/src/x-modules/facets/components/filters/hierarchical-filter.vue.d.ts.map +1 -1
- package/types/src/x-modules/facets/components/filters/simple-filter.vue.d.ts +1 -0
- package/types/src/x-modules/facets/components/filters/simple-filter.vue.d.ts.map +1 -1
- package/types/src/x-modules/recommendations/store/actions/fetch-and-save-recommendations-enrichment.action.d.ts +17 -0
- package/types/src/x-modules/recommendations/store/actions/fetch-and-save-recommendations-enrichment.action.d.ts.map +1 -0
- package/types/src/x-modules/recommendations/store/module.d.ts.map +1 -1
- package/types/src/x-modules/recommendations/store/types.d.ts +17 -0
- package/types/src/x-modules/recommendations/store/types.d.ts.map +1 -1
- package/types/src/x-modules/recommendations/wiring.d.ts +3 -0
- package/types/src/x-modules/recommendations/wiring.d.ts.map +1 -1
- package/types/src/x-modules/search/events.types.d.ts +6 -1
- package/types/src/x-modules/search/events.types.d.ts.map +1 -1
- package/types/src/x-modules/search/store/actions/fetch-and-save-partial-results-enrichment.action.d.ts +17 -0
- package/types/src/x-modules/search/store/actions/fetch-and-save-partial-results-enrichment.action.d.ts.map +1 -0
- package/types/src/x-modules/search/store/actions/fetch-and-save-results-enrichment.action.d.ts +17 -0
- package/types/src/x-modules/search/store/actions/fetch-and-save-results-enrichment.action.d.ts.map +1 -0
- package/types/src/x-modules/search/store/actions/index.d.ts +2 -0
- package/types/src/x-modules/search/store/actions/index.d.ts.map +1 -1
- package/types/src/x-modules/search/store/emitters.d.ts +1 -0
- package/types/src/x-modules/search/store/emitters.d.ts.map +1 -1
- package/types/src/x-modules/search/store/module.d.ts.map +1 -1
- package/types/src/x-modules/search/store/types.d.ts +24 -0
- package/types/src/x-modules/search/store/types.d.ts.map +1 -1
- package/types/src/x-modules/search/wiring.d.ts +16 -0
- package/types/src/x-modules/search/wiring.d.ts.map +1 -1
- package/docs/API-reference/api/x-components.aimutations.setsuggestionssearchloading.md +0 -13
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,27 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [6.0.0-alpha.234](https://github.com/empathyco/x/compare/@empathyco/x-components@6.0.0-alpha.233...@empathyco/x-components@6.0.0-alpha.234) (2026-04-06)
|
|
7
|
+
|
|
8
|
+
### ⚠ BREAKING CHANGES
|
|
9
|
+
|
|
10
|
+
* **ai:** The AI module now uses RequestStatus type instead of boolean loading states. Users should:
|
|
11
|
+
* Update from `suggestionsLoading: boolean` to `suggestionsStatus: RequestStatus`.
|
|
12
|
+
* Update from `setSuggestionsSearchLoading: boolean` to `setSuggestionsSearchStatus: RequestStatus`.
|
|
13
|
+
* Adjust computed properties accordingly.
|
|
14
|
+
|
|
15
|
+
### Code Refactoring
|
|
16
|
+
|
|
17
|
+
* **ai:** replace boolean loading states with RequestStatus type (#2068)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
## [6.0.0-alpha.233](https://github.com/empathyco/x/compare/@empathyco/x-components@6.0.0-alpha.232...@empathyco/x-components@6.0.0-alpha.233) (2026-04-02)
|
|
21
|
+
|
|
22
|
+
### Features
|
|
23
|
+
|
|
24
|
+
* define result enrichment for Results, PartialResults and Recommendations (#2065)
|
|
25
|
+
|
|
26
|
+
|
|
6
27
|
## [6.0.0-alpha.232](https://github.com/empathyco/x/compare/@empathyco/x-components@6.0.0-alpha.231...@empathyco/x-components@6.0.0-alpha.232) (2026-04-01)
|
|
7
28
|
|
|
8
29
|
### Bug Fixes
|
package/core/index.js
CHANGED
|
@@ -165,6 +165,7 @@ export { isSimpleSelector, registerStoreEmitters } from '../js/plugins/x-emitter
|
|
|
165
165
|
export { XPlugin, xPlugin } from '../js/plugins/x-plugin.js';
|
|
166
166
|
export { assertXPluginOptionsAreValid, getGetterPath } from '../js/plugins/x-plugin.utils.js';
|
|
167
167
|
export { DirectionalFocusNavigationService } from '../js/services/directional-focus-navigation.service.js';
|
|
168
|
+
export { DefaultResultsEnrichmentService } from '../js/services/results-enrichment.service.js';
|
|
168
169
|
export { mergeConfig, setConfig } from '../js/store/utils/config-store.utils.js';
|
|
169
170
|
export { createFetchAndSaveActions } from '../js/store/utils/fetch-and-save-action.utils.js';
|
|
170
171
|
export { cleanGettersProxyCache, getGettersProxy, getGettersProxyFromModule } from '../js/store/utils/getters-proxy.utils.js';
|
package/core/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|
|
@@ -209,7 +209,7 @@ Sets the selected filters of the module.
|
|
|
209
209
|
</td></tr>
|
|
210
210
|
<tr><td>
|
|
211
211
|
|
|
212
|
-
[
|
|
212
|
+
[setSuggestionsSearch](./x-components.aimutations.setsuggestionssearch.md)
|
|
213
213
|
|
|
214
214
|
|
|
215
215
|
</td><td>
|
|
@@ -217,18 +217,18 @@ Sets the selected filters of the module.
|
|
|
217
217
|
|
|
218
218
|
</td><td>
|
|
219
219
|
|
|
220
|
-
(
|
|
220
|
+
(suggestionsSearch: AiSuggestionSearch\[\]) => void
|
|
221
221
|
|
|
222
222
|
|
|
223
223
|
</td><td>
|
|
224
224
|
|
|
225
|
-
Sets the
|
|
225
|
+
Sets the suggestions search from the suggestions search response.
|
|
226
226
|
|
|
227
227
|
|
|
228
228
|
</td></tr>
|
|
229
229
|
<tr><td>
|
|
230
230
|
|
|
231
|
-
[
|
|
231
|
+
[setSuggestionsSearchStatus](./x-components.aimutations.setsuggestionssearchstatus.md)
|
|
232
232
|
|
|
233
233
|
|
|
234
234
|
</td><td>
|
|
@@ -236,18 +236,18 @@ Sets the loading for the suggestions response.
|
|
|
236
236
|
|
|
237
237
|
</td><td>
|
|
238
238
|
|
|
239
|
-
(
|
|
239
|
+
(status: [RequestStatus](./x-components.requeststatus.md)<!-- -->) => void
|
|
240
240
|
|
|
241
241
|
|
|
242
242
|
</td><td>
|
|
243
243
|
|
|
244
|
-
Sets the
|
|
244
|
+
Sets the status for the suggestions search response.
|
|
245
245
|
|
|
246
246
|
|
|
247
247
|
</td></tr>
|
|
248
248
|
<tr><td>
|
|
249
249
|
|
|
250
|
-
[
|
|
250
|
+
[setSuggestionsStatus](./x-components.aimutations.setsuggestionsstatus.md)
|
|
251
251
|
|
|
252
252
|
|
|
253
253
|
</td><td>
|
|
@@ -255,12 +255,12 @@ Sets the suggestions search from the suggestions search response.
|
|
|
255
255
|
|
|
256
256
|
</td><td>
|
|
257
257
|
|
|
258
|
-
(
|
|
258
|
+
(status: [RequestStatus](./x-components.requeststatus.md)<!-- -->) => void
|
|
259
259
|
|
|
260
260
|
|
|
261
261
|
</td><td>
|
|
262
262
|
|
|
263
|
-
Sets the
|
|
263
|
+
Sets the status for the suggestions response.
|
|
264
264
|
|
|
265
265
|
|
|
266
266
|
</td></tr>
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [AiMutations](./x-components.aimutations.md) > [setSuggestionsSearchStatus](./x-components.aimutations.setsuggestionssearchstatus.md)
|
|
4
|
+
|
|
5
|
+
## AiMutations.setSuggestionsSearchStatus property
|
|
6
|
+
|
|
7
|
+
Sets the status for the suggestions search response.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
setSuggestionsSearchStatus: (status: RequestStatus) => void;
|
|
13
|
+
```
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [AiMutations](./x-components.aimutations.md) > [
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [AiMutations](./x-components.aimutations.md) > [setSuggestionsStatus](./x-components.aimutations.setsuggestionsstatus.md)
|
|
4
4
|
|
|
5
|
-
## AiMutations.
|
|
5
|
+
## AiMutations.setSuggestionsStatus property
|
|
6
6
|
|
|
7
|
-
Sets the
|
|
7
|
+
Sets the status for the suggestions response.
|
|
8
8
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
|
|
12
|
+
setSuggestionsStatus: (status: RequestStatus) => void;
|
|
13
13
|
```
|
|
@@ -205,7 +205,7 @@ The dictionary of selected filters, used to perform the AI requests. The key is
|
|
|
205
205
|
</td></tr>
|
|
206
206
|
<tr><td>
|
|
207
207
|
|
|
208
|
-
[
|
|
208
|
+
[suggestionsSearch](./x-components.aistate.suggestionssearch.md)
|
|
209
209
|
|
|
210
210
|
|
|
211
211
|
</td><td>
|
|
@@ -213,18 +213,18 @@ The dictionary of selected filters, used to perform the AI requests. The key is
|
|
|
213
213
|
|
|
214
214
|
</td><td>
|
|
215
215
|
|
|
216
|
-
|
|
216
|
+
AiSuggestionSearch\[\]
|
|
217
217
|
|
|
218
218
|
|
|
219
219
|
</td><td>
|
|
220
220
|
|
|
221
|
-
|
|
221
|
+
The results per query retrieved by the suggestion search endpoint
|
|
222
222
|
|
|
223
223
|
|
|
224
224
|
</td></tr>
|
|
225
225
|
<tr><td>
|
|
226
226
|
|
|
227
|
-
[
|
|
227
|
+
[suggestionsSearchStatus](./x-components.aistate.suggestionssearchstatus.md)
|
|
228
228
|
|
|
229
229
|
|
|
230
230
|
</td><td>
|
|
@@ -232,18 +232,18 @@ Loading state for the suggestions response
|
|
|
232
232
|
|
|
233
233
|
</td><td>
|
|
234
234
|
|
|
235
|
-
|
|
235
|
+
[RequestStatus](./x-components.requeststatus.md)
|
|
236
236
|
|
|
237
237
|
|
|
238
238
|
</td><td>
|
|
239
239
|
|
|
240
|
-
|
|
240
|
+
Status for the suggestions search response
|
|
241
241
|
|
|
242
242
|
|
|
243
243
|
</td></tr>
|
|
244
244
|
<tr><td>
|
|
245
245
|
|
|
246
|
-
[
|
|
246
|
+
[suggestionsStatus](./x-components.aistate.suggestionsstatus.md)
|
|
247
247
|
|
|
248
248
|
|
|
249
249
|
</td><td>
|
|
@@ -251,12 +251,12 @@ The results per query retrieved by the suggestion search endpoint
|
|
|
251
251
|
|
|
252
252
|
</td><td>
|
|
253
253
|
|
|
254
|
-
|
|
254
|
+
[RequestStatus](./x-components.requeststatus.md)
|
|
255
255
|
|
|
256
256
|
|
|
257
257
|
</td><td>
|
|
258
258
|
|
|
259
|
-
|
|
259
|
+
Status for the suggestions response
|
|
260
260
|
|
|
261
261
|
|
|
262
262
|
</td></tr>
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [AiState](./x-components.aistate.md) > [
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [AiState](./x-components.aistate.md) > [suggestionsSearchStatus](./x-components.aistate.suggestionssearchstatus.md)
|
|
4
4
|
|
|
5
|
-
## AiState.
|
|
5
|
+
## AiState.suggestionsSearchStatus property
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Status for the suggestions search response
|
|
8
8
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
|
|
12
|
+
suggestionsSearchStatus: RequestStatus;
|
|
13
13
|
```
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [AiState](./x-components.aistate.md) > [
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [AiState](./x-components.aistate.md) > [suggestionsStatus](./x-components.aistate.suggestionsstatus.md)
|
|
4
4
|
|
|
5
|
-
## AiState.
|
|
5
|
+
## AiState.suggestionsStatus property
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Status for the suggestions response
|
|
8
8
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
|
|
12
|
+
suggestionsStatus: RequestStatus;
|
|
13
13
|
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [cancelFetchAndSavePartialResultsEnrichment](./x-components.cancelfetchandsavepartialresultsenrichment.md)
|
|
4
|
+
|
|
5
|
+
## cancelFetchAndSavePartialResultsEnrichment() function
|
|
6
|
+
|
|
7
|
+
Default implementation for action.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
cancelFetchAndSavePartialResultsEnrichment: () => void
|
|
13
|
+
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
void
|
|
17
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [cancelFetchAndSaveResultsEnrichment](./x-components.cancelfetchandsaveresultsenrichment.md)
|
|
4
|
+
|
|
5
|
+
## cancelFetchAndSaveResultsEnrichment() function
|
|
6
|
+
|
|
7
|
+
Default implementation for action.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
cancelFetchAndSaveResultsEnrichment: () => void
|
|
13
|
+
```
|
|
14
|
+
**Returns:**
|
|
15
|
+
|
|
16
|
+
void
|
|
17
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [DefaultResultsEnrichmentService](./x-components.defaultresultsenrichmentservice.md) > [(constructor)](./x-components.defaultresultsenrichmentservice._constructor_.md)
|
|
4
|
+
|
|
5
|
+
## DefaultResultsEnrichmentService.(constructor)
|
|
6
|
+
|
|
7
|
+
Constructs a new instance of the `DefaultResultsEnrichmentService` class
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
constructor();
|
|
13
|
+
```
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [DefaultResultsEnrichmentService](./x-components.defaultresultsenrichmentservice.md) > [fetchResults](./x-components.defaultresultsenrichmentservice.fetchresults.md)
|
|
4
|
+
|
|
5
|
+
## DefaultResultsEnrichmentService.fetchResults() method
|
|
6
|
+
|
|
7
|
+
Fetches the enrichment results.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
fetchResults(_: Result[]): Promise<any[]>;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
<table><thead><tr><th>
|
|
18
|
+
|
|
19
|
+
Parameter
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
</th><th>
|
|
23
|
+
|
|
24
|
+
Type
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
</th><th>
|
|
28
|
+
|
|
29
|
+
Description
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
</th></tr></thead>
|
|
33
|
+
<tbody><tr><td>
|
|
34
|
+
|
|
35
|
+
\_
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
</td><td>
|
|
39
|
+
|
|
40
|
+
Result\[\]
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
</td><td>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
</td></tr>
|
|
47
|
+
</tbody></table>
|
|
48
|
+
|
|
49
|
+
**Returns:**
|
|
50
|
+
|
|
51
|
+
Promise<any\[\]>
|
|
52
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [DefaultResultsEnrichmentService](./x-components.defaultresultsenrichmentservice.md) > [instance](./x-components.defaultresultsenrichmentservice.instance.md)
|
|
4
|
+
|
|
5
|
+
## DefaultResultsEnrichmentService.instance property
|
|
6
|
+
|
|
7
|
+
Global instance of the [ResultsEnrichmentService](./x-components.resultsenrichmentservice.md)<!-- -->.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
static instance: ResultsEnrichmentService;
|
|
13
|
+
```
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [DefaultResultsEnrichmentService](./x-components.defaultresultsenrichmentservice.md)
|
|
4
|
+
|
|
5
|
+
## DefaultResultsEnrichmentService class
|
|
6
|
+
|
|
7
|
+
Default implementation for the [ResultsEnrichmentService](./x-components.resultsenrichmentservice.md)<!-- -->.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare class DefaultResultsEnrichmentService implements ResultsEnrichmentService
|
|
13
|
+
```
|
|
14
|
+
**Implements:** [ResultsEnrichmentService](./x-components.resultsenrichmentservice.md)
|
|
15
|
+
|
|
16
|
+
## Constructors
|
|
17
|
+
|
|
18
|
+
<table><thead><tr><th>
|
|
19
|
+
|
|
20
|
+
Constructor
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
</th><th>
|
|
24
|
+
|
|
25
|
+
Modifiers
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</th><th>
|
|
29
|
+
|
|
30
|
+
Description
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
</th></tr></thead>
|
|
34
|
+
<tbody><tr><td>
|
|
35
|
+
|
|
36
|
+
[(constructor)()](./x-components.defaultresultsenrichmentservice._constructor_.md)
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
</td><td>
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
</td><td>
|
|
43
|
+
|
|
44
|
+
Constructs a new instance of the `DefaultResultsEnrichmentService` class
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
</td></tr>
|
|
48
|
+
</tbody></table>
|
|
49
|
+
|
|
50
|
+
## Properties
|
|
51
|
+
|
|
52
|
+
<table><thead><tr><th>
|
|
53
|
+
|
|
54
|
+
Property
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
</th><th>
|
|
58
|
+
|
|
59
|
+
Modifiers
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
</th><th>
|
|
63
|
+
|
|
64
|
+
Type
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
</th><th>
|
|
68
|
+
|
|
69
|
+
Description
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
</th></tr></thead>
|
|
73
|
+
<tbody><tr><td>
|
|
74
|
+
|
|
75
|
+
[instance](./x-components.defaultresultsenrichmentservice.instance.md)
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
</td><td>
|
|
79
|
+
|
|
80
|
+
`static`
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
</td><td>
|
|
84
|
+
|
|
85
|
+
[ResultsEnrichmentService](./x-components.resultsenrichmentservice.md)
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
</td><td>
|
|
89
|
+
|
|
90
|
+
Global instance of the [ResultsEnrichmentService](./x-components.resultsenrichmentservice.md)<!-- -->.
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
</td></tr>
|
|
94
|
+
<tr><td>
|
|
95
|
+
|
|
96
|
+
[store](./x-components.defaultresultsenrichmentservice.store.md)
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
</td><td>
|
|
100
|
+
|
|
101
|
+
`protected`
|
|
102
|
+
|
|
103
|
+
`readonly`
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
</td><td>
|
|
107
|
+
|
|
108
|
+
Store<[RootXStoreState](./x-components.rootxstorestate.md)<!-- -->>
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
</td><td>
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
</td></tr>
|
|
115
|
+
</tbody></table>
|
|
116
|
+
|
|
117
|
+
## Methods
|
|
118
|
+
|
|
119
|
+
<table><thead><tr><th>
|
|
120
|
+
|
|
121
|
+
Method
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
</th><th>
|
|
125
|
+
|
|
126
|
+
Modifiers
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
</th><th>
|
|
130
|
+
|
|
131
|
+
Description
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
</th></tr></thead>
|
|
135
|
+
<tbody><tr><td>
|
|
136
|
+
|
|
137
|
+
[fetchResults(\_)](./x-components.defaultresultsenrichmentservice.fetchresults.md)
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
</td><td>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
</td><td>
|
|
144
|
+
|
|
145
|
+
Fetches the enrichment results.
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
</td></tr>
|
|
149
|
+
<tr><td>
|
|
150
|
+
|
|
151
|
+
[updateResults(\_, \_\_)](./x-components.defaultresultsenrichmentservice.updateresults.md)
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
</td><td>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
</td><td>
|
|
158
|
+
|
|
159
|
+
Updates the results with the enrichment results. Updates via mutation.
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
</td></tr>
|
|
163
|
+
</tbody></table>
|
|
164
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [DefaultResultsEnrichmentService](./x-components.defaultresultsenrichmentservice.md) > [store](./x-components.defaultresultsenrichmentservice.store.md)
|
|
4
|
+
|
|
5
|
+
## DefaultResultsEnrichmentService.store property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
protected get store(): Store<RootXStoreState>;
|
|
11
|
+
```
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [DefaultResultsEnrichmentService](./x-components.defaultresultsenrichmentservice.md) > [updateResults](./x-components.defaultresultsenrichmentservice.updateresults.md)
|
|
4
|
+
|
|
5
|
+
## DefaultResultsEnrichmentService.updateResults() method
|
|
6
|
+
|
|
7
|
+
Updates the results with the enrichment results. Updates via mutation.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
updateResults(_: Result[], __: any[]): void;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
<table><thead><tr><th>
|
|
18
|
+
|
|
19
|
+
Parameter
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
</th><th>
|
|
23
|
+
|
|
24
|
+
Type
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
</th><th>
|
|
28
|
+
|
|
29
|
+
Description
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
</th></tr></thead>
|
|
33
|
+
<tbody><tr><td>
|
|
34
|
+
|
|
35
|
+
\_
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
</td><td>
|
|
39
|
+
|
|
40
|
+
Result\[\]
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
</td><td>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
</td></tr>
|
|
47
|
+
<tr><td>
|
|
48
|
+
|
|
49
|
+
\_\_
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
</td><td>
|
|
53
|
+
|
|
54
|
+
any\[\]
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
</td><td>
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
</td></tr>
|
|
61
|
+
</tbody></table>
|
|
62
|
+
|
|
63
|
+
**Returns:**
|
|
64
|
+
|
|
65
|
+
void
|
|
66
|
+
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [fetchAndSavePartialResultsEnrichment](./x-components.fetchandsavepartialresultsenrichment.md)
|
|
4
|
+
|
|
5
|
+
## fetchAndSavePartialResultsEnrichment() function
|
|
6
|
+
|
|
7
|
+
Default implementation for [SearchActions.fetchAndSavePartialResultsEnrichment](./x-components.searchactions.fetchandsavepartialresultsenrichment.md) action.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
fetchAndSavePartialResultsEnrichment: (context: SearchActionContext, request: PartialResult[]) => void | Promise<void>
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
<table><thead><tr><th>
|
|
18
|
+
|
|
19
|
+
Parameter
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
</th><th>
|
|
23
|
+
|
|
24
|
+
Type
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
</th><th>
|
|
28
|
+
|
|
29
|
+
Description
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
</th></tr></thead>
|
|
33
|
+
<tbody><tr><td>
|
|
34
|
+
|
|
35
|
+
context
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
</td><td>
|
|
39
|
+
|
|
40
|
+
[SearchActionContext](./x-components.searchactioncontext.md)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
</td><td>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
</td></tr>
|
|
47
|
+
<tr><td>
|
|
48
|
+
|
|
49
|
+
request
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
</td><td>
|
|
53
|
+
|
|
54
|
+
PartialResult\[\]
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
</td><td>
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
</td></tr>
|
|
61
|
+
</tbody></table>
|
|
62
|
+
|
|
63
|
+
**Returns:**
|
|
64
|
+
|
|
65
|
+
void \| Promise<void>
|
|
66
|
+
|