npm - @empathyco/x-components - Versions diffs - 3.0.0-alpha.239 → 3.0.0-alpha.240 - Mend

@empathyco/x-components 3.0.0-alpha.239 → 3.0.0-alpha.240

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 (33) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file. See
 [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+## [3.0.0-alpha.240](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.239...@empathyco/x-components@3.0.0-alpha.240) (2022-12-02)
+### Features
+- **history-queries:** Hide history queries with no results (#865)
+  ([58f155d](https://github.com/empathyco/x/commit/58f155d2eefe1676646d320c9f310ad1d28aab5e))
+# Change Log
+All notable changes to this project will be documented in this file. See
+[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 ## [3.0.0-alpha.239](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.238...@empathyco/x-components@3.0.0-alpha.239) (2022-12-01)
 **Note:** Version bump only for package @empathyco/x-components

package/design-system/full-theme.css CHANGED Viewed

@@ -2840,21 +2840,6 @@
   --x-number-zoom-scale-picture: 1.1;
   --x-number-zoom-duration-picture: 0.3s;
 }
-.x-progress-bar {
-  display: inline-block;
-  overflow: hidden;
-  background-color: var(--x-color-background-progress-bar-default);
-  border-color: var(--x-color-border-progress-bar-default);
-  border-style: solid;
-  border-width: var(--x-size-border-width-progress-bar-default);
-  border-radius: var(--x-size-border-radius-progress-bar-default);
-}
-.x-progress-bar__line {
-  height: var(--x-size-height-progress-bar-line-default);
-  width: var(--x-size-width-progress-bar-line-default);
-  border-radius: var(--x-size-border-radius-progress-bar-default);
-  background-color: var(--x-color-background-progress-bar-line-default);
-}
 :root {
   --x-size-height-progress-bar-line-default: var(--x-size-base-02);
   --x-size-width-progress-bar-line-default: var(--x-size-base-20);
@@ -7236,3 +7221,19 @@
 .x-normal-case {
   text-transform: none;
 }
+.x-progress-bar {
+  display: inline-block;
+  overflow: hidden;
+  background-color: var(--x-color-background-progress-bar-default);
+  border-color: var(--x-color-border-progress-bar-default);
+  border-style: solid;
+  border-width: var(--x-size-border-width-progress-bar-default);
+  border-radius: var(--x-size-border-radius-progress-bar-default);
+}
+.x-progress-bar__line {
+  height: var(--x-size-height-progress-bar-line-default);
+  width: var(--x-size-width-progress-bar-line-default);
+  border-radius: var(--x-size-border-radius-progress-bar-default);
+  background-color: var(--x-color-background-progress-bar-line-default);
+}

package/docs/API-reference/api/x-components.historyqueriesactions.md CHANGED Viewed

@@ -23,4 +23,5 @@ export interface HistoryQueriesActions
 |  [setHistoryQueries(historyQueries)](./x-components.historyqueriesactions.sethistoryqueries.md) | Sets the history queries, synchronizing them with the browser storage. It also removes the oldest query if the history queries length is bigger than the [HistoryQueriesConfig.maxItemsToStore](./x-components.historyqueriesconfig.maxitemstostore.md)<!-- -->. |
 |  [setUrlParams(urlParams)](./x-components.historyqueriesactions.seturlparams.md) | Checks if the url has a query on it and then updates the state with that value. |
 |  [toggleHistoryQueries(isEnabled)](./x-components.historyqueriesactions.togglehistoryqueries.md) | Toggles the history queries and stores the state in the browser storage. It also cleans the history queries when disabling them. |
+|  [updateHistoryQueriesWithSearchResponse(searchResponse)](./x-components.historyqueriesactions.updatehistoryquerieswithsearchresponse.md) | Updates the history queries with the relevant info included in a search response. |

package/docs/API-reference/api/x-components.historyqueriesactions.updatehistoryquerieswithsearchresponse.md ADDED Viewed

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [HistoryQueriesActions](./x-components.historyqueriesactions.md) &gt; [updateHistoryQueriesWithSearchResponse](./x-components.historyqueriesactions.updatehistoryquerieswithsearchresponse.md)
+## HistoryQueriesActions.updateHistoryQueriesWithSearchResponse() method
+Updates the history queries with the relevant info included in a search response.
+<b>Signature:</b>
+```typescript
+updateHistoryQueriesWithSearchResponse(searchResponse: InternalSearchResponse): void;
+```
+## Parameters
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  searchResponse | [InternalSearchResponse](./x-components.internalsearchresponse.md) | The search response to update history queries with. |
+<b>Returns:</b>
+void

package/docs/API-reference/api/x-components.historyqueriesgetters.historyquerieswithresults.md ADDED Viewed

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [HistoryQueriesGetters](./x-components.historyqueriesgetters.md) &gt; [historyQueriesWithResults](./x-components.historyqueriesgetters.historyquerieswithresults.md)
+## HistoryQueriesGetters.historyQueriesWithResults property
+A sub-set of the [HistoryQueriesGetters.historyQueries](./x-components.historyqueriesgetters.historyqueries.md) including only the queries with results at the moment they were requested.
+<b>Signature:</b>
+```typescript
+historyQueriesWithResults: HistoryQuery[];
+```

package/docs/API-reference/api/x-components.historyqueriesgetters.md CHANGED Viewed

@@ -17,6 +17,7 @@ export interface HistoryQueriesGetters
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [historyQueries](./x-components.historyqueriesgetters.historyqueries.md) | HistoryQuery\[\] | A sub-set of the [HistoryQueriesState.historyQueries](./x-components.historyqueriesstate.historyqueries.md)<!-- -->. If the [HistoryQueriesState.query](./x-components.historyqueriesstate.query.md) property is not empty, this list will only contain suggestions whose query matches with it. |
+|  [historyQueriesWithResults](./x-components.historyqueriesgetters.historyquerieswithresults.md) | HistoryQuery\[\] | A sub-set of the [HistoryQueriesGetters.historyQueries](./x-components.historyqueriesgetters.historyqueries.md) including only the queries with results at the moment they were requested. |
 |  [normalizedQuery](./x-components.historyqueriesgetters.normalizedquery.md) | string | The normalized module's query. |
 |  [sessionHistoryQueries](./x-components.historyqueriesgetters.sessionhistoryqueries.md) | HistoryQuery\[\] | A list of the queries that have been made in the last period of time specified by [HistoryQueriesConfig.sessionTTLInMs](./x-components.historyqueriesconfig.sessionttlinms.md)<!-- -->. |
 |  [storageKey](./x-components.historyqueriesgetters.storagekey.md) | string | The key for saving the [HistoryQueriesState.historyQueries](./x-components.historyqueriesstate.historyqueries.md) in the browser storage. |

package/docs/API-reference/api/x-components.md CHANGED Viewed

@@ -598,6 +598,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [TrashOpenIcon](./x-components.trashopenicon.md) |  |
 |  [TrendingIcon](./x-components.trendingicon.md) |  |
 |  [TrendingTinyIcon](./x-components.trendingtinyicon.md) |  |
+|  [updateHistoryQueriesWithSearchResponse](./x-components.updatehistoryquerieswithsearchresponse.md) | Updates the history queries with the relevant info included in a search response. |
 |  [urlXModule](./x-components.urlxmodule.md) | URL [XModule](./x-components.xmodule.md) implementation. This module is auto-registered as soon as you import any component from the <code>url</code> entry point. |
 |  [UserIcon](./x-components.usericon.md) |  |
 |  [xPlugin](./x-components.xplugin.md) | Vue plugin that modifies each component instance, extending them with the [X Component API](./x-components.xcomponentapi.md)<!-- -->. |

package/docs/API-reference/api/x-components.updatehistoryquerieswithsearchresponse.md ADDED Viewed

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [updateHistoryQueriesWithSearchResponse](./x-components.updatehistoryquerieswithsearchresponse.md)
+## updateHistoryQueriesWithSearchResponse variable
+Updates the history queries with the relevant info included in a search response.
+<b>Signature:</b>
+```typescript
+updateHistoryQueriesWithSearchResponse: import("../..").Wire<import("../search").InternalSearchResponse>
+```

package/history-queries/index.js CHANGED Viewed

@@ -14,5 +14,5 @@ export { HistoryQueriesGetter, historyQueries } from '../js/x-modules/history-qu
 export { sessionHistoryQueries } from '../js/x-modules/history-queries/store/getters/session-history-queries.getter.js';
 export { storageKey } from '../js/x-modules/history-queries/store/getters/storage-key.getter.js';
 export { historyQueriesXStoreModule } from '../js/x-modules/history-queries/store/module.js';
-export { addQueryToHistoryQueries, clearHistoryQueries, clearHistoryQueriesQuery, historyQueriesWiring, loadHistoryQueriesFromBrowserStorageWire, refreshHistoryQueriesSession, removeHistoryQuery, setHistoryQueriesDisabled, setHistoryQueriesEnabled, setHistoryQueriesQuery } from '../js/x-modules/history-queries/wiring.js';
+export { addQueryToHistoryQueries, clearHistoryQueries, clearHistoryQueriesQuery, historyQueriesWiring, loadHistoryQueriesFromBrowserStorageWire, refreshHistoryQueriesSession, removeHistoryQuery, setHistoryQueriesDisabled, setHistoryQueriesEnabled, setHistoryQueriesQuery, updateHistoryQueriesWithSearchResponse } from '../js/x-modules/history-queries/wiring.js';
 export { historyQueriesXModule } from '../js/x-modules/history-queries/x-module.js';

package/js/index.js CHANGED Viewed

@@ -232,7 +232,7 @@ export { HistoryQueriesGetter, historyQueries } from './x-modules/history-querie
 export { sessionHistoryQueries } from './x-modules/history-queries/store/getters/session-history-queries.getter.js';
 export { storageKey } from './x-modules/history-queries/store/getters/storage-key.getter.js';
 export { historyQueriesXStoreModule } from './x-modules/history-queries/store/module.js';
-export { addQueryToHistoryQueries, clearHistoryQueries, clearHistoryQueriesQuery, historyQueriesWiring, loadHistoryQueriesFromBrowserStorageWire, refreshHistoryQueriesSession, removeHistoryQuery, setHistoryQueriesDisabled, setHistoryQueriesEnabled, setHistoryQueriesQuery } from './x-modules/history-queries/wiring.js';
+export { addQueryToHistoryQueries, clearHistoryQueries, clearHistoryQueriesQuery, historyQueriesWiring, loadHistoryQueriesFromBrowserStorageWire, refreshHistoryQueriesSession, removeHistoryQuery, setHistoryQueriesDisabled, setHistoryQueriesEnabled, setHistoryQueriesQuery, updateHistoryQueriesWithSearchResponse } from './x-modules/history-queries/wiring.js';
 export { historyQueriesXModule } from './x-modules/history-queries/x-module.js';
 export { default as IdentifierResult } from './x-modules/identifier-results/components/identifier-result.vue.js';
 export { default as IdentifierResults } from './x-modules/identifier-results/components/identifier-results.vue.js';

package/js/x-modules/history-queries/components/history-queries.vue.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"history-queries.vue.js","sources":["../../../../../src/x-modules/history-queries/components/history-queries.vue"],"sourcesContent":["<template>\n <BaseSuggestions\n v-bind=\"$attrs\"\n :suggestions=\"historyQueries\"\n class=\"x-history-queries\"\n data-test=\"history-queries\"\n >\n <template #default=\"props\">\n <!-- eslint-disable max-len -->\n <!--\n @slot History Query item\n @binding {Object} v-bind - History Query suggestion attributes:<br />  - suggestion <code>Suggestion</code> - History Query suggestion data<br />  - index <code>number</code> - History Query suggestion index\n -->\n <!-- eslint-enable max-len -->\n <slot name=\"suggestion\" v-bind=\"{ ...props }\">\n <HistoryQuery\n :suggestion=\"props.suggestion\"\n data-test=\"history-query-item\"\n class=\"x-history-queries__item\"\n >\n <template #default=\"{ queryHTML }\">\n <!-- eslint-disable max-len -->\n <!--\n @slot History Query content\n @binding {Object} v-bind - History Query suggestion attributes:<br />  - suggestion <code>Suggestion</code> - History Query suggestion data<br />  - index <code>number</code> - History Query suggestion index\n @binding {string} queryHTML - Suggestion's query with the matching part inside a span tag\n -->\n <!-- eslint-enable max-len -->\n <slot name=\"suggestion-content\" v-bind=\"{ ...props, queryHTML }\" />\n </template>\n <template #remove-button-content=\"{ ...props }\">\n <!-- eslint-disable max-len -->\n <!--\n @slot History Query remove button content\n @binding {Object} v-bind - History Query suggestion attributes:<br />  - suggestion <code>Suggestion</code> - History Query suggestion data<br />  - index <code>number</code> - History Query suggestion index\n -->\n <!-- eslint-enable max-len -->\n <slot name=\"suggestion-remove-content\" v-bind=\"{ ...props }\" />\n </template>\n </HistoryQuery>\n </slot>\n </template>\n </BaseSuggestions>\n</template>\n\n<script lang=\"ts\">\n import { HistoryQuery as HistoryQueryModel } from '@empathyco/x-types';\n import Vue from 'vue';\n import { Component } from 'vue-property-decorator';\n import BaseSuggestions from '../../../components/suggestions/base-suggestions.vue';\n import { Getter } from '../../../components/decorators/store.decorators';\n import { xComponentMixin } from '../../../components/x-component.mixin';\n import { historyQueriesXModule } from '../x-module';\n import HistoryQuery from './history-query.vue';\n\n /*\n This component renders a list of suggestions coming from the user queries history.\n * Allows the user to select one of them, emitting the needed events. A history query is just\n * another type of suggestion that contains a query that the user has made in the past.\n \n @public\n /\n @Component({\n components: { BaseSuggestions, HistoryQuery },\n mixins: [xComponentMixin(historyQueriesXModule)]\n })\n export default class HistoryQueries extends Vue {\n /\n The filtered list of history queries.\n \n @internal\n */\n @Getter('historyQueries', '~~historyQueries~~')\n public historyQueries!: HistoryQueryModel[];\n }\n</script>\n\n<!--eslint-disable max-len -->\n<docs lang=\"mdx\">\n## Inherited props\n\nThis component inherits the [`BaseSuggestions`](../base-components/x-components.base-suggestions.md)\nprops.\n\n\| Name \| Description \| Type \| Default \|\n\| ----------------------------- \| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ \| ------------------- \| --------------- \|\n\| <code>animation</code> \| Animation component that will be used to animate the suggestions. \| <code>Vue</code> \| <code>ul</code> \|\n\| <code>maxItemsToRender</code> \| Maximum number of history queries to show. It should be a lower number than the<br />{@link HistoryQueriesConfig.maxItemsToStore}. If it is not provided, it will show<br />all the stored `HistoryQueries`. \| <code>number</code> \| <code></code> \|\n\n## Events\n\nThis component doesn't emit events.\n\n## See it in action\n\nHere you have a basic example of how the HistoryQueries is rendered.\n\n```vue live\n<template>\n <div>\n <SearchInput />\n <HistoryQueries />\n </div>\n</template>\n\n<script>\n import { SearchInput } from '@empathyco/x-components/search-box';\n import { HistoryQueries } from '@empathyco/x-components/history-queries';\n\n export default {\n name: 'HistoryQueriesDemo',\n components: {\n SearchInput,\n HistoryQueries\n }\n };\n</script>\n```\n\n### Play with props\n\nIn this example, the history queries have been limited to render a maximum of 10 queries (by default\nit is 5).\n\n```vue live\n<template>\n <div>\n <SearchInput />\n <HistoryQueries :maxItemsToRender=\"10\" />\n </div>\n</template>\n\n<script>\n import { SearchInput } from '@empathyco/x-components/search-box';\n import { HistoryQueries } from '@empathyco/x-components/history-queries';\n\n export default {\n name: 'HistoryQueriesDemo',\n components: {\n SearchInput,\n HistoryQueries\n }\n };\n</script>\n```\n\n### Play with the animation\n\n```vue live\n<template>\n <div>\n <SearchInput />\n <HistoryQueries :animation=\"'FadeAndSlide'\" />\n </div>\n</template>\n\n<script>\n import Vue from 'vue';\n import { SearchInput } from '@empathyco/x-components/search-box';\n import { HistoryQueries } from '@empathyco/x-components/history-queries';\n import { FadeAndSlide } from '@empathyco/x-components';\n\n // Registering the animation as a global component\n Vue.component('FadeAndSlide', FadeAndSlide);\n export default {\n name: 'HistoryQueriesDemo',\n components: {\n SearchInput,\n HistoryQueries\n }\n };\n</script>\n```\n\n### Play with suggestion slot\n\nIn this example, the [`HistoryQuery`](./x-components.history-query.md) component is passed in the\n`suggestion` slot (although any other component could potentially be passed).\n\n```vue live\n<template>\n <div>\n <SearchInput />\n <HistoryQueries #suggestion=\"{ suggestion }\">\n <HistoryQuery :suggestion=\"suggestion\" />\n </HistoryQueries>\n </div>\n</template>\n\n<script>\n import { SearchInput } from '@empathyco/x-components/search-box';\n import { HistoryQueries, HistoryQuery } from '@empathyco/x-components/history-queries';\n\n export default {\n name: 'HistoryQueriesDemo',\n components: {\n SearchInput,\n HistoryQueries,\n HistoryQuery\n }\n };\n</script>\n```\n\n### Play with suggestion-content slot\n\nTo continue the previous example, the [`HistoryQuery`](./x-components.history-query.md) component is\npassed in the `suggestion-content` slot, but in addition, an HTML span tag for the text are also\npassed.\n\n```vue live\n<template>\n <div>\n <SearchInput />\n <HistoryQueries #suggestion-content=\"{ suggestion }\">\n <span>{{ suggestion.query }}</span>\n </HistoryQueries>\n </div>\n</template>\n\n<script>\n import { SearchInput } from '@empathyco/x-components/search-box';\n import { HistoryQueries } from '@empathyco/x-components/history-queries';\n\n export default {\n name: 'HistoryQueriesDemo',\n components: {\n SearchInput,\n HistoryQueries\n }\n };\n</script>\n```\n\n### Play with suggestion-content-remove slot\n\nTo continue the previous example, the [`HistoryQuery`](./x-components.history-query.md) component is\npassed in the `suggestion-content` slot, but in addition, a cross icon is also passed to change the\nicon to remove the history query.\n\n```vue live\n<template>\n <div>\n <SearchInput />\n <HistoryQueries #suggestion-remove-content=\"{ suggestion }\">\n <CrossIcon />\n </HistoryQueries>\n </div>\n</template>\n\n<script>\n import { SearchInput } from '@empathyco/x-components/search-box';\n import { HistoryQueries } from '@empathyco/x-components/history-queries';\n import { CrossIcon } from '@empathyco/x-components';\n\n export default {\n name: 'HistoryQueriesDemo',\n components: {\n SearchInput,\n HistoryQueries,\n CrossIcon\n }\n };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
1	+ {"version":3,"file":"history-queries.vue.js","sources":["../../../../../src/x-modules/history-queries/components/history-queries.vue"],"sourcesContent":["<template>\n <BaseSuggestions\n v-bind=\"$attrs\"\n :suggestions=\"historyQueries\"\n class=\"x-history-queries\"\n data-test=\"history-queries\"\n >\n <template #default=\"props\">\n <!-- eslint-disable max-len -->\n <!--\n @slot History Query item\n @binding {Object} v-bind - History Query suggestion attributes:<br />  - suggestion <code>Suggestion</code> - History Query suggestion data<br />  - index <code>number</code> - History Query suggestion index\n -->\n <!-- eslint-enable max-len -->\n <slot name=\"suggestion\" v-bind=\"{ ...props }\">\n <HistoryQuery\n :suggestion=\"props.suggestion\"\n data-test=\"history-query-item\"\n class=\"x-history-queries__item\"\n >\n <template #default=\"{ queryHTML }\">\n <!-- eslint-disable max-len -->\n <!--\n @slot History Query content\n @binding {Object} v-bind - History Query suggestion attributes:<br />  - suggestion <code>Suggestion</code> - History Query suggestion data<br />  - index <code>number</code> - History Query suggestion index\n @binding {string} queryHTML - Suggestion's query with the matching part inside a span tag\n -->\n <!-- eslint-enable max-len -->\n <slot name=\"suggestion-content\" v-bind=\"{ ...props, queryHTML }\" />\n </template>\n <template #remove-button-content=\"{ ...props }\">\n <!-- eslint-disable max-len -->\n <!--\n @slot History Query remove button content\n @binding {Object} v-bind - History Query suggestion attributes:<br />  - suggestion <code>Suggestion</code> - History Query suggestion data<br />  - index <code>number</code> - History Query suggestion index\n -->\n <!-- eslint-enable max-len -->\n <slot name=\"suggestion-remove-content\" v-bind=\"{ ...props }\" />\n </template>\n </HistoryQuery>\n </slot>\n </template>\n </BaseSuggestions>\n</template>\n\n<script lang=\"ts\">\n import { HistoryQuery as HistoryQueryModel } from '@empathyco/x-types';\n import Vue from 'vue';\n import { Component } from 'vue-property-decorator';\n import BaseSuggestions from '../../../components/suggestions/base-suggestions.vue';\n import { Getter } from '../../../components/decorators/store.decorators';\n import { xComponentMixin } from '../../../components/x-component.mixin';\n import { historyQueriesXModule } from '../x-module';\n import HistoryQuery from './history-query.vue';\n\n /*\n This component renders a list of suggestions coming from the user queries history.\n * Allows the user to select one of them, emitting the needed events. A history query is just\n * another type of suggestion that contains a query that the user has made in the past.\n \n @public\n /\n @Component({\n components: { BaseSuggestions, HistoryQuery },\n mixins: [xComponentMixin(historyQueriesXModule)]\n })\n export default class HistoryQueries extends Vue {\n /\n The filtered list of history queries.\n \n @internal\n */\n @Getter('historyQueries', 'historyQueriesWithResults')\n public historyQueries!: HistoryQueryModel[];\n }\n</script>\n\n<!--eslint-disable max-len -->\n<docs lang=\"mdx\">\n## Inherited props\n\nThis component inherits the [`BaseSuggestions`](../base-components/x-components.base-suggestions.md)\nprops.\n\n\| Name \| Description \| Type \| Default \|\n\| ----------------------------- \| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ \| ------------------- \| --------------- \|\n\| <code>animation</code> \| Animation component that will be used to animate the suggestions. \| <code>Vue</code> \| <code>ul</code> \|\n\| <code>maxItemsToRender</code> \| Maximum number of history queries to show. It should be a lower number than the<br />{@link HistoryQueriesConfig.maxItemsToStore}. If it is not provided, it will show<br />all the stored `HistoryQueries`. \| <code>number</code> \| <code></code> \|\n\n## Events\n\nThis component doesn't emit events.\n\n## See it in action\n\nHere you have a basic example of how the HistoryQueries is rendered.\n\n```vue live\n<template>\n <div>\n <SearchInput />\n <HistoryQueries />\n </div>\n</template>\n\n<script>\n import { SearchInput } from '@empathyco/x-components/search-box';\n import { HistoryQueries } from '@empathyco/x-components/history-queries';\n\n export default {\n name: 'HistoryQueriesDemo',\n components: {\n SearchInput,\n HistoryQueries\n }\n };\n</script>\n```\n\n### Play with props\n\nIn this example, the history queries have been limited to render a maximum of 10 queries (by default\nit is 5).\n\n```vue live\n<template>\n <div>\n <SearchInput />\n <HistoryQueries :maxItemsToRender=\"10\" />\n </div>\n</template>\n\n<script>\n import { SearchInput } from '@empathyco/x-components/search-box';\n import { HistoryQueries } from '@empathyco/x-components/history-queries';\n\n export default {\n name: 'HistoryQueriesDemo',\n components: {\n SearchInput,\n HistoryQueries\n }\n };\n</script>\n```\n\n### Play with the animation\n\n```vue live\n<template>\n <div>\n <SearchInput />\n <HistoryQueries :animation=\"'FadeAndSlide'\" />\n </div>\n</template>\n\n<script>\n import Vue from 'vue';\n import { SearchInput } from '@empathyco/x-components/search-box';\n import { HistoryQueries } from '@empathyco/x-components/history-queries';\n import { FadeAndSlide } from '@empathyco/x-components';\n\n // Registering the animation as a global component\n Vue.component('FadeAndSlide', FadeAndSlide);\n export default {\n name: 'HistoryQueriesDemo',\n components: {\n SearchInput,\n HistoryQueries\n }\n };\n</script>\n```\n\n### Play with suggestion slot\n\nIn this example, the [`HistoryQuery`](./x-components.history-query.md) component is passed in the\n`suggestion` slot (although any other component could potentially be passed).\n\n```vue live\n<template>\n <div>\n <SearchInput />\n <HistoryQueries #suggestion=\"{ suggestion }\">\n <HistoryQuery :suggestion=\"suggestion\" />\n </HistoryQueries>\n </div>\n</template>\n\n<script>\n import { SearchInput } from '@empathyco/x-components/search-box';\n import { HistoryQueries, HistoryQuery } from '@empathyco/x-components/history-queries';\n\n export default {\n name: 'HistoryQueriesDemo',\n components: {\n SearchInput,\n HistoryQueries,\n HistoryQuery\n }\n };\n</script>\n```\n\n### Play with suggestion-content slot\n\nTo continue the previous example, the [`HistoryQuery`](./x-components.history-query.md) component is\npassed in the `suggestion-content` slot, but in addition, an HTML span tag for the text are also\npassed.\n\n```vue live\n<template>\n <div>\n <SearchInput />\n <HistoryQueries #suggestion-content=\"{ suggestion }\">\n <span>{{ suggestion.query }}</span>\n </HistoryQueries>\n </div>\n</template>\n\n<script>\n import { SearchInput } from '@empathyco/x-components/search-box';\n import { HistoryQueries } from '@empathyco/x-components/history-queries';\n\n export default {\n name: 'HistoryQueriesDemo',\n components: {\n SearchInput,\n HistoryQueries\n }\n };\n</script>\n```\n\n### Play with suggestion-content-remove slot\n\nTo continue the previous example, the [`HistoryQuery`](./x-components.history-query.md) component is\npassed in the `suggestion-content` slot, but in addition, a cross icon is also passed to change the\nicon to remove the history query.\n\n```vue live\n<template>\n <div>\n <SearchInput />\n <HistoryQueries #suggestion-remove-content=\"{ suggestion }\">\n <CrossIcon />\n </HistoryQueries>\n </div>\n</template>\n\n<script>\n import { SearchInput } from '@empathyco/x-components/search-box';\n import { HistoryQueries } from '@empathyco/x-components/history-queries';\n import { CrossIcon } from '@empathyco/x-components';\n\n export default {\n name: 'HistoryQueriesDemo',\n components: {\n SearchInput,\n HistoryQueries,\n CrossIcon\n }\n };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/js/x-modules/history-queries/components/history-queries.vue_rollup-plugin-vue_script.vue.js CHANGED Viewed

@@ -17,7 +17,7 @@ import __vue_component__$1 from './history-query.vue.js';
 let HistoryQueries = class HistoryQueries extends Vue {
 };
 __decorate([
-    Getter('historyQueries', 'historyQueries')
+    Getter('historyQueries', 'historyQueriesWithResults')
 ], HistoryQueries.prototype, "historyQueries", void 0);
 HistoryQueries = __decorate([
     Component({

package/js/x-modules/history-queries/components/history-queries.vue_rollup-plugin-vue_script.vue.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"history-queries.vue_rollup-plugin-vue_script.vue.js","sources":["../../../../../src/x-modules/history-queries/components/history-queries.vue?rollup-plugin-vue=script.ts"],"sourcesContent":["\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nimport { HistoryQuery as HistoryQueryModel } from '@empathyco/x-types';\nimport Vue from 'vue';\nimport { Component } from 'vue-property-decorator';\nimport BaseSuggestions from '../../../components/suggestions/base-suggestions.vue';\nimport { Getter } from '../../../components/decorators/store.decorators';\nimport { xComponentMixin } from '../../../components/x-component.mixin';\nimport { historyQueriesXModule } from '../x-module';\nimport HistoryQuery from './history-query.vue';\n\n/*\n This component renders a list of suggestions coming from the user queries history.\n * Allows the user to select one of them, emitting the needed events. A history query is just\n * another type of suggestion that contains a query that the user has made in the past.\n \n @public\n /\n@Component({\n components: { BaseSuggestions, HistoryQuery },\n mixins: [xComponentMixin(historyQueriesXModule)]\n})\nexport default class HistoryQueries extends Vue {\n /\n The filtered list of history queries.\n \n @internal\n */\n @Getter('historyQueries', '~~historyQueries~~')\n public historyQueries!: HistoryQueryModel[];\n}\n"],"names":["BaseSuggestions","HistoryQuery"],"mappings":";;;;;;;;;AAuDA;;;;;;;AAWA,IAAqB,cAAc,GAAnC,MAAqB,cAAe,SAAQ,GAAG;CAQ9C,CAAA;AADC;IADC,MAAM,CAAC,gBAAgB,EAAE,~~gBAAgB~~,CAAC;~~sDACC~~;AAPzB,cAAc;IAJlC,SAAS,CAAC;QACT,UAAU,EAAE,mBAAEA,iBAAe,gBAAEC,mBAAY,EAAE;QAC7C,MAAM,EAAE,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC;KACjD,CAAC;GACmB,cAAc,CAQlC;aARoB,cAAc;;;;"}
1	+ {"version":3,"file":"history-queries.vue_rollup-plugin-vue_script.vue.js","sources":["../../../../../src/x-modules/history-queries/components/history-queries.vue?rollup-plugin-vue=script.ts"],"sourcesContent":["\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nimport { HistoryQuery as HistoryQueryModel } from '@empathyco/x-types';\nimport Vue from 'vue';\nimport { Component } from 'vue-property-decorator';\nimport BaseSuggestions from '../../../components/suggestions/base-suggestions.vue';\nimport { Getter } from '../../../components/decorators/store.decorators';\nimport { xComponentMixin } from '../../../components/x-component.mixin';\nimport { historyQueriesXModule } from '../x-module';\nimport HistoryQuery from './history-query.vue';\n\n/*\n This component renders a list of suggestions coming from the user queries history.\n * Allows the user to select one of them, emitting the needed events. A history query is just\n * another type of suggestion that contains a query that the user has made in the past.\n \n @public\n /\n@Component({\n components: { BaseSuggestions, HistoryQuery },\n mixins: [xComponentMixin(historyQueriesXModule)]\n})\nexport default class HistoryQueries extends Vue {\n /\n The filtered list of history queries.\n \n @internal\n */\n @Getter('historyQueries', 'historyQueriesWithResults')\n public historyQueries!: HistoryQueryModel[];\n}\n"],"names":["BaseSuggestions","HistoryQuery"],"mappings":";;;;;;;;;AAuDA;;;;;;;AAWA,IAAqB,cAAc,GAAnC,MAAqB,cAAe,SAAQ,GAAG;CAQ9C,CAAA;AADC;IADC,MAAM,CAAC,gBAAgB,EAAE,2BAA2B,CAAC;sDACV;AAPzB,cAAc;IAJlC,SAAS,CAAC;QACT,UAAU,EAAE,mBAAEA,iBAAe,gBAAEC,mBAAY,EAAE;QAC7C,MAAM,EAAE,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC;KACjD,CAAC;GACmB,cAAc,CAQlC;aARoB,cAAc;;;;"}

package/js/x-modules/history-queries/store/actions/update-history-queries-with-search-response.action.js ADDED Viewed

@@ -0,0 +1,42 @@
+/**
+ * Default implementation for the
+ * {@link HistoryQueriesActions.updateHistoryQueriesWithSearchResponse} action.
+ *
+ * The matching history query will only be updated on the following scenarios:
+ * 1. If it is part of a previous session, not the current one.
+ * 2. If its total results count has not been registered yet.
+ * 3. If its total results count registered is less than the one specified on the search response,
+ * meaning that the previous update was part of a filtered request.
+ *
+ * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions,
+ * provided by Vuex.
+ *
+ * @param searchResponse - The search response to update history queries with.
+ *
+ * @returns A `void` promise that resolves when the history query finishes updating.
+ *
+ * @public
+ */
+// eslint-disable-next-line max-len
+const updateHistoryQueriesWithSearchResponse = ({ state, dispatch }, searchResponse) => {
+    if (searchResponse.status === 'success') {
+        const indexOfHistoryQuery = state.historyQueries.findIndex(({ query }) => query === searchResponse.request.query);
+        if (indexOfHistoryQuery >= 0) {
+            const historyQuery = state.historyQueries[indexOfHistoryQuery];
+            const isCurrentSessionHistoryQuery = historyQuery.timestamp > state.sessionTimeStampInMs;
+            if (!isCurrentSessionHistoryQuery ||
+                historyQuery.totalResults == null ||
+                historyQuery.totalResults < searchResponse.totalResults) {
+                const newHistoryQueries = state.historyQueries.slice();
+                newHistoryQueries[indexOfHistoryQuery] = {
+                    ...historyQuery,
+                    totalResults: searchResponse.totalResults
+                };
+                return dispatch('setHistoryQueries', newHistoryQueries);
+            }
+        }
+    }
+};
+export { updateHistoryQueriesWithSearchResponse };
+//# sourceMappingURL=update-history-queries-with-search-response.action.js.map

package/js/x-modules/history-queries/store/actions/update-history-queries-with-search-response.action.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"update-history-queries-with-search-response.action.js","sources":["../../../../../../src/x-modules/history-queries/store/actions/update-history-queries-with-search-response.action.ts"],"sourcesContent":["import { HistoryQueriesXStoreModule } from '../types';\n\n/**\n * Default implementation for the\n * {@link HistoryQueriesActions.updateHistoryQueriesWithSearchResponse} action.\n *\n * The matching history query will only be updated on the following scenarios:\n * 1. If it is part of a previous session, not the current one.\n * 2. If its total results count has not been registered yet.\n * 3. If its total results count registered is less than the one specified on the search response,\n * meaning that the previous update was part of a filtered request.\n *\n * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions,\n * provided by Vuex.\n *\n * @param searchResponse - The search response to update history queries with.\n *\n * @returns A `void` promise that resolves when the history query finishes updating.\n *\n * @public\n */\n// eslint-disable-next-line max-len\nexport const updateHistoryQueriesWithSearchResponse: HistoryQueriesXStoreModule['actions']['updateHistoryQueriesWithSearchResponse'] =\n ({ state, dispatch }, searchResponse) => {\n if (searchResponse.status === 'success') {\n const indexOfHistoryQuery = state.historyQueries.findIndex(\n ({ query }) => query === searchResponse.request.query\n );\n if (indexOfHistoryQuery >= 0) {\n const historyQuery = state.historyQueries[indexOfHistoryQuery];\n const isCurrentSessionHistoryQuery = historyQuery.timestamp > state.sessionTimeStampInMs;\n if (\n !isCurrentSessionHistoryQuery ||\n historyQuery.totalResults == null ||\n historyQuery.totalResults < searchResponse.totalResults\n ) {\n const newHistoryQueries = state.historyQueries.slice();\n newHistoryQueries[indexOfHistoryQuery] = {\n ...historyQuery,\n totalResults: searchResponse.totalResults\n };\n return dispatch('setHistoryQueries', newHistoryQueries);\n }\n }\n }\n };\n"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;AAmBA;MACa,sCAAsC,GACjD,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,cAAc;IAClC,IAAI,cAAc,CAAC,MAAM,KAAK,SAAS,EAAE;QACvC,MAAM,mBAAmB,GAAG,KAAK,CAAC,cAAc,CAAC,SAAS,CACxD,CAAC,EAAE,KAAK,EAAE,KAAK,KAAK,KAAK,cAAc,CAAC,OAAO,CAAC,KAAK,CACtD,CAAC;QACF,IAAI,mBAAmB,IAAI,CAAC,EAAE;YAC5B,MAAM,YAAY,GAAG,KAAK,CAAC,cAAc,CAAC,mBAAmB,CAAC,CAAC;YAC/D,MAAM,4BAA4B,GAAG,YAAY,CAAC,SAAS,GAAG,KAAK,CAAC,oBAAoB,CAAC;YACzF,IACE,CAAC,4BAA4B;gBAC7B,YAAY,CAAC,YAAY,IAAI,IAAI;gBACjC,YAAY,CAAC,YAAY,GAAG,cAAc,CAAC,YAAY,EACvD;gBACA,MAAM,iBAAiB,GAAG,KAAK,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;gBACvD,iBAAiB,CAAC,mBAAmB,CAAC,GAAG;oBACvC,GAAG,YAAY;oBACf,YAAY,EAAE,cAAc,CAAC,YAAY;iBAC1C,CAAC;gBACF,OAAO,QAAQ,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAAC;aACzD;SACF;KACF;AACH;;;;"}

package/js/x-modules/history-queries/store/getters/history-queries-with-results.getter.js ADDED Viewed

@@ -0,0 +1,18 @@
+/**
+ * Default implementation for the {@link HistoryQueriesGetters.historyQueriesWithResults} getter.
+ *
+ * @param state - Current {@link https://vuex.vuejs.org/guide/state.html | state} of the history
+ * queries module.
+ *
+ * @param getters - Current {@link https://vuex.vuejs.org/guide/getters.html | getters} of the
+ * history queries module.
+ *
+ * @returns The history queries that have results at the moment they were requested.
+ *
+ * @public
+ */
+// eslint-disable-next-line max-len
+const historyQueriesWithResults = (state, { historyQueries }) => historyQueries.filter(({ totalResults }) => !!totalResults);
+export { historyQueriesWithResults };
+//# sourceMappingURL=history-queries-with-results.getter.js.map

package/js/x-modules/history-queries/store/getters/history-queries-with-results.getter.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"history-queries-with-results.getter.js","sources":["../../../../../../src/x-modules/history-queries/store/getters/history-queries-with-results.getter.ts"],"sourcesContent":["import { HistoryQueriesXStoreModule } from '../types';\n\n/**\n * Default implementation for the {@link HistoryQueriesGetters.historyQueriesWithResults} getter.\n *\n * @param state - Current {@link https://vuex.vuejs.org/guide/state.html | state} of the history\n * queries module.\n *\n * @param getters - Current {@link https://vuex.vuejs.org/guide/getters.html | getters} of the\n * history queries module.\n *\n * @returns The history queries that have results at the moment they were requested.\n *\n * @public\n */\n// eslint-disable-next-line max-len\nexport const historyQueriesWithResults: HistoryQueriesXStoreModule['getters']['historyQueriesWithResults'] =\n (state, { historyQueries }) => historyQueries.filter(({ totalResults }) => !!totalResults);\n"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;AAaA;MACa,yBAAyB,GACpC,CAAC,KAAK,EAAE,EAAE,cAAc,EAAE,KAAK,cAAc,CAAC,MAAM,CAAC,CAAC,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC,YAAY;;;;"}

package/js/x-modules/history-queries/store/module.js CHANGED Viewed

@@ -7,9 +7,11 @@ import { removeFromHistory } from './actions/remove-query-from-history.action.js
 import { setHistoryQueries } from './actions/set-history-queries.action.js';
 import { setUrlParams } from './actions/set-url-params.action.js';
 import { toggleHistoryQueries } from './actions/toggle-history-queries.action.js';
+import { updateHistoryQueriesWithSearchResponse } from './actions/update-history-queries-with-search-response.action.js';
 import { HISTORY_QUERIES_ENABLED_KEY } from './constants.js';
 import { historyQueries } from './getters/history-queries.getter.js';
 import { normalizedQuery } from './getters/normalized-query.getter.js';
+import { historyQueriesWithResults } from './getters/history-queries-with-results.getter.js';
 import { sessionHistoryQueries } from './getters/session-history-queries.getter.js';
 import { storageKey } from './getters/storage-key.getter.js';
@@ -34,6 +36,7 @@ const historyQueriesXStoreModule = {
     getters: {
         historyQueries,
         normalizedQuery,
+        historyQueriesWithResults,
         sessionHistoryQueries,
         storageKey
     },
@@ -56,7 +59,8 @@ const historyQueriesXStoreModule = {
         removeFromHistory,
         setHistoryQueries,
         setUrlParams,
-        toggleHistoryQueries
+        toggleHistoryQueries,
+        updateHistoryQueriesWithSearchResponse
     }
 };

package/js/x-modules/history-queries/store/module.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"module.js","sources":["../../../../../src/x-modules/history-queries/store/module.ts"],"sourcesContent":["import { setQuery } from '../../../store/utils/query.utils';\nimport { localStorageService } from '../../../utils/storage';\nimport { addQueryToHistory } from './actions/add-query-to-history.action';\n// eslint-disable-next-line max-len\nimport { loadHistoryQueriesFromBrowserStorage } from './actions/load-history-queries-from-browser-storage.action';\nimport { refreshSession } from './actions/refresh-session.action';\nimport { removeFromHistory } from './actions/remove-query-from-history.action';\nimport { setHistoryQueries } from './actions/set-history-queries.action';\nimport { setUrlParams } from './actions/set-url-params.action';\nimport { toggleHistoryQueries } from './actions/toggle-history-queries.action';\nimport { HISTORY_QUERIES_ENABLED_KEY } from './constants';\nimport { historyQueries } from './getters/history-queries.getter';\nimport { normalizedQuery } from './getters/normalized-query.getter';\nimport { sessionHistoryQueries } from './getters/session-history-queries.getter';\nimport { storageKey } from './getters/storage-key.getter';\nimport { HistoryQueriesXStoreModule } from './types';\n\n/*\n {@link XStoreModule} For the history-queries module.\n \n @internal\n /\nexport const historyQueriesXStoreModule: HistoryQueriesXStoreModule = {\n state: () => ({\n config: {\n debounceInMs: 150,\n maxItemsToStore: 50,\n hideIfEqualsQuery: true,\n sessionTTLInMs: 30 60 * 1000\n },\n query: '',\n historyQueries: [],\n sessionTimeStampInMs: Date.now(),\n isEnabled: localStorageService.getItem<boolean>(HISTORY_QUERIES_ENABLED_KEY) ?? true\n }),\n getters: {\n historyQueries,\n normalizedQuery,\n sessionHistoryQueries,\n storageKey\n },\n mutations: {\n setHistoryQueries(state, historyQueries) {\n state.historyQueries = historyQueries;\n },\n setSessionTimeStamp(state, sessionTimeStamp) {\n state.sessionTimeStampInMs = sessionTimeStamp;\n },\n setQuery,\n setIsEnabled(state, isEnabled) {\n state.isEnabled = isEnabled;\n }\n },\n actions: {\n addQueryToHistory,\n loadHistoryQueriesFromBrowserStorage,\n refreshSession,\n removeFromHistory,\n setHistoryQueries,\n setUrlParams,\n toggleHistoryQueries\n }\n};\n"],"names":[],"mappings":"~~;;;;;;;;;;;;;;;AAiBA~~;;;;;MAKa,0BAA0B,GAA+B;IACpE,KAAK,EAAE,OAAO;QACZ,MAAM,EAAE;YACN,YAAY,EAAE,GAAG;YACjB,eAAe,EAAE,EAAE;YACnB,iBAAiB,EAAE,IAAI;YACvB,cAAc,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI;SAC/B;QACD,KAAK,EAAE,EAAE;QACT,cAAc,EAAE,EAAE;QAClB,oBAAoB,EAAE,IAAI,CAAC,GAAG,EAAE;QAChC,SAAS,EAAE,mBAAmB,CAAC,OAAO,CAAU,2BAA2B,CAAC,IAAI,IAAI;KACrF,CAAC;IACF,OAAO,EAAE;QACP,cAAc;QACd,eAAe;QACf,qBAAqB;QACrB,UAAU;KACX;IACD,SAAS,EAAE;QACT,iBAAiB,CAAC,KAAK,EAAE,cAAc;YACrC,KAAK,CAAC,cAAc,GAAG,cAAc,CAAC;SACvC;QACD,mBAAmB,CAAC,KAAK,EAAE,gBAAgB;YACzC,KAAK,CAAC,oBAAoB,GAAG,gBAAgB,CAAC;SAC/C;QACD,QAAQ;QACR,YAAY,CAAC,KAAK,EAAE,SAAS;YAC3B,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;SAC7B;KACF;IACD,OAAO,EAAE;QACP,iBAAiB;QACjB,oCAAoC;QACpC,cAAc;QACd,iBAAiB;QACjB,iBAAiB;QACjB,YAAY;QACZ,oBAAoB;~~KACrB~~;;;;;"}
1	+ {"version":3,"file":"module.js","sources":["../../../../../src/x-modules/history-queries/store/module.ts"],"sourcesContent":["import { setQuery } from '../../../store/utils/query.utils';\nimport { localStorageService } from '../../../utils/storage';\nimport { addQueryToHistory } from './actions/add-query-to-history.action';\n// eslint-disable-next-line max-len\nimport { loadHistoryQueriesFromBrowserStorage } from './actions/load-history-queries-from-browser-storage.action';\nimport { refreshSession } from './actions/refresh-session.action';\nimport { removeFromHistory } from './actions/remove-query-from-history.action';\nimport { setHistoryQueries } from './actions/set-history-queries.action';\nimport { setUrlParams } from './actions/set-url-params.action';\nimport { toggleHistoryQueries } from './actions/toggle-history-queries.action';\n// eslint-disable-next-line max-len\nimport { updateHistoryQueriesWithSearchResponse } from './actions/update-history-queries-with-search-response.action';\nimport { HISTORY_QUERIES_ENABLED_KEY } from './constants';\nimport { historyQueries } from './getters/history-queries.getter';\nimport { normalizedQuery } from './getters/normalized-query.getter';\nimport { historyQueriesWithResults } from './getters/history-queries-with-results.getter';\nimport { sessionHistoryQueries } from './getters/session-history-queries.getter';\nimport { storageKey } from './getters/storage-key.getter';\nimport { HistoryQueriesXStoreModule } from './types';\n\n/*\n {@link XStoreModule} For the history-queries module.\n \n @internal\n /\nexport const historyQueriesXStoreModule: HistoryQueriesXStoreModule = {\n state: () => ({\n config: {\n debounceInMs: 150,\n maxItemsToStore: 50,\n hideIfEqualsQuery: true,\n sessionTTLInMs: 30 60 * 1000\n },\n query: '',\n historyQueries: [],\n sessionTimeStampInMs: Date.now(),\n isEnabled: localStorageService.getItem<boolean>(HISTORY_QUERIES_ENABLED_KEY) ?? true\n }),\n getters: {\n historyQueries,\n normalizedQuery,\n historyQueriesWithResults,\n sessionHistoryQueries,\n storageKey\n },\n mutations: {\n setHistoryQueries(state, historyQueries) {\n state.historyQueries = historyQueries;\n },\n setSessionTimeStamp(state, sessionTimeStamp) {\n state.sessionTimeStampInMs = sessionTimeStamp;\n },\n setQuery,\n setIsEnabled(state, isEnabled) {\n state.isEnabled = isEnabled;\n }\n },\n actions: {\n addQueryToHistory,\n loadHistoryQueriesFromBrowserStorage,\n refreshSession,\n removeFromHistory,\n setHistoryQueries,\n setUrlParams,\n toggleHistoryQueries,\n updateHistoryQueriesWithSearchResponse\n }\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAoBA;;;;;MAKa,0BAA0B,GAA+B;IACpE,KAAK,EAAE,OAAO;QACZ,MAAM,EAAE;YACN,YAAY,EAAE,GAAG;YACjB,eAAe,EAAE,EAAE;YACnB,iBAAiB,EAAE,IAAI;YACvB,cAAc,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI;SAC/B;QACD,KAAK,EAAE,EAAE;QACT,cAAc,EAAE,EAAE;QAClB,oBAAoB,EAAE,IAAI,CAAC,GAAG,EAAE;QAChC,SAAS,EAAE,mBAAmB,CAAC,OAAO,CAAU,2BAA2B,CAAC,IAAI,IAAI;KACrF,CAAC;IACF,OAAO,EAAE;QACP,cAAc;QACd,eAAe;QACf,yBAAyB;QACzB,qBAAqB;QACrB,UAAU;KACX;IACD,SAAS,EAAE;QACT,iBAAiB,CAAC,KAAK,EAAE,cAAc;YACrC,KAAK,CAAC,cAAc,GAAG,cAAc,CAAC;SACvC;QACD,mBAAmB,CAAC,KAAK,EAAE,gBAAgB;YACzC,KAAK,CAAC,oBAAoB,GAAG,gBAAgB,CAAC;SAC/C;QACD,QAAQ;QACR,YAAY,CAAC,KAAK,EAAE,SAAS;YAC3B,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;SAC7B;KACF;IACD,OAAO,EAAE;QACP,iBAAiB;QACjB,oCAAoC;QACpC,cAAc;QACd,iBAAiB;QACjB,iBAAiB;QACjB,YAAY;QACZ,oBAAoB;QACpB,sCAAsC;KACvC;;;;;"}

package/js/x-modules/history-queries/wiring.js CHANGED Viewed

@@ -88,6 +88,12 @@ const setHistoryQueriesEnabled = wireDispatch('toggleHistoryQueries', true);
  * @public
  */
 const setHistoryQueriesDisabled = wireDispatch('toggleHistoryQueries', false);
+/**
+ * Updates the history queries with the relevant info included in a search response.
+ *
+ * @public
+ */
+const updateHistoryQueriesWithSearchResponse = wireDispatch('updateHistoryQueriesWithSearchResponse');
 /**
  * Debounce function for the module.
  */
@@ -134,8 +140,11 @@ const historyQueriesWiring = createWiring({
     },
     UserClickedOutOfMainModal: {
         clearHistoryQueriesQuery
+    },
+    SearchResponseProvided: {
+        updateHistoryQueriesWithSearchResponse
     }
 });
-export { addQueryToHistoryQueries, clearHistoryQueries, clearHistoryQueriesQuery, historyQueriesWiring, loadHistoryQueriesFromBrowserStorageWire, refreshHistoryQueriesSession, removeHistoryQuery, setHistoryQueriesDisabled, setHistoryQueriesEnabled, setHistoryQueriesQuery };
+export { addQueryToHistoryQueries, clearHistoryQueries, clearHistoryQueriesQuery, historyQueriesWiring, loadHistoryQueriesFromBrowserStorageWire, refreshHistoryQueriesSession, removeHistoryQuery, setHistoryQueriesDisabled, setHistoryQueriesEnabled, setHistoryQueriesQuery, updateHistoryQueriesWithSearchResponse };
 //# sourceMappingURL=wiring.js.map

package/js/x-modules/history-queries/wiring.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"wiring.js","sources":["../../../../src/x-modules/history-queries/wiring.ts"],"sourcesContent":["import {\n namespacedWireCommit,\n namespacedWireDispatch,\n namespacedWireDispatchWithoutPayload\n} from '../../wiring/namespaced-wires.factory';\nimport { namespacedDebounce } from '../../wiring/namespaced-wires.operators';\nimport { NamespacedWireCommit, NamespacedWireDispatch } from '../../wiring/namespaced-wiring.types';\nimport { createWiring } from '../../wiring/wiring.utils';\n\n/*\n `historyQueries` {@link XModuleName \| XModule name}.\n \n @internal\n /\nconst moduleName = 'historyQueries';\n/\n WireCommit for {@link HistoryQueriesXModule}.\n \n @internal\n /\nconst wireCommit: NamespacedWireCommit<typeof moduleName> = namespacedWireCommit(moduleName);\n/\n WireDispatch for {@link HistoryQueriesXModule}.\n \n @internal\n /\nconst wireDispatch: NamespacedWireDispatch<typeof moduleName> = namespacedWireDispatch(moduleName);\n/\n WireDispatchWithoutPayload for {@link HistoryQueriesXModule}.\n \n @internal\n /\nconst wireDispatchWithoutPayload = namespacedWireDispatchWithoutPayload(moduleName);\n\n/\n Saves a new query into the history queries.\n \n @public\n /\nexport const addQueryToHistoryQueries = wireDispatch('addQueryToHistory');\n\n/\n Sets the query of the history queries module. Used for searching into the history queries.\n \n @public\n /\nexport const setHistoryQueriesQuery = wireCommit('setQuery');\n\n/\n Sets the history queries state `query` from url.\n \n @public\n /\nconst setUrlParams = wireDispatch('setUrlParams');\n\n/\n Sets the query of the history queries module to an empty string.\n \n @public\n /\nexport const clearHistoryQueriesQuery = wireCommit('setQuery', '');\n\n/\n Triggers a session refresh, extending its validity for the time configured in the\n * {@link HistoryQueriesConfig.sessionTTLInMs}.\n \n @public\n /\nexport const refreshHistoryQueriesSession = wireDispatchWithoutPayload('refreshSession');\n\n/\n Loads the history queries from the browser storage, saving them to the\n * {@link HistoryQueriesState.historyQueries}.\n \n @public\n /\nexport const loadHistoryQueriesFromBrowserStorageWire = wireDispatchWithoutPayload(\n 'loadHistoryQueriesFromBrowserStorage'\n);\n\n/\n Clears the history queries.\n \n @public\n /\nexport const clearHistoryQueries = wireDispatch('setHistoryQueries', []);\n\n/\n Removes a single history query from the history queries.\n \n @public\n /\nexport const removeHistoryQuery = wireDispatch('removeFromHistory');\n\n/\n Enables history queries.\n \n @public\n /\nexport const setHistoryQueriesEnabled = wireDispatch('toggleHistoryQueries', true);\n\n/\n Disables history queries.\n \n @public\n /\nexport const setHistoryQueriesDisabled = wireDispatch('toggleHistoryQueries', false);\n\n/\n Debounce function for the module.\n /\nconst moduleDebounce = namespacedDebounce(moduleName);\n\n/\n Default wiring for the {@link HistoryQueries} module.\n \n @internal\n */\nexport const historyQueriesWiring = createWiring({\n ParamsLoadedFromUrl: {\n setUrlParams\n },\n HistoryQueriesQueryChanged: {\n refreshHistoryQueriesSession\n },\n HistoryQueriesStorageKeyChanged: {\n loadHistoryQueriesFromBrowserStorageWire\n },\n UserClearedQuery: {\n clearHistoryQueriesQuery\n },\n UserAcceptedAQuery: {\n setHistoryQueriesQuery,\n addQueryToHistoryQueries\n },\n UserIsTypingAQuery: {\n setHistoryQueriesQueryDebounce: moduleDebounce(\n setHistoryQueriesQuery,\n ({ state }) => state.config.debounceInMs,\n { cancelOn: 'UserAcceptedAQuery' }\n )\n },\n UserPressedClearHistoryQueries: {\n clearHistoryQueries\n },\n UserPressedRemoveHistoryQuery: {\n removeHistoryQuery\n },\n UserClickedEnableHistoryQueries: {\n setHistoryQueriesEnabled\n },\n UserClickedConfirmDisableHistoryQueries: {\n setHistoryQueriesDisabled\n },\n UserClickedCloseX: {\n clearHistoryQueriesQuery\n },\n UserClickedOutOfMainModal: {\n clearHistoryQueriesQuery\n }\n});\n"],"names":[],"mappings":";;;;AASA;;;;;AAKA,MAAM,UAAU,GAAG,gBAAgB,CAAC;AACpC;;;;;AAKA,MAAM,UAAU,GAA4C,oBAAoB,CAAC,UAAU,CAAC,CAAC;AAC7F;;;;;AAKA,MAAM,YAAY,GAA8C,sBAAsB,CAAC,UAAU,CAAC,CAAC;AACnG;;;;;AAKA,MAAM,0BAA0B,GAAG,oCAAoC,CAAC,UAAU,CAAC,CAAC;AAEpF;;;;;MAKa,wBAAwB,GAAG,YAAY,CAAC,mBAAmB,EAAE;AAE1E;;;;;MAKa,sBAAsB,GAAG,UAAU,CAAC,UAAU,EAAE;AAE7D;;;;;AAKA,MAAM,YAAY,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC;AAElD;;;;;MAKa,wBAAwB,GAAG,UAAU,CAAC,UAAU,EAAE,EAAE,EAAE;AAEnE;;;;;;MAMa,4BAA4B,GAAG,0BAA0B,CAAC,gBAAgB,EAAE;AAEzF;;;;;;MAMa,wCAAwC,GAAG,0BAA0B,CAChF,sCAAsC,EACtC;AAEF;;;;;MAKa,mBAAmB,GAAG,YAAY,CAAC,mBAAmB,EAAE,EAAE,EAAE;AAEzE;;;;;MAKa,kBAAkB,GAAG,YAAY,CAAC,mBAAmB,EAAE;AAEpE;;;;;MAKa,wBAAwB,GAAG,YAAY,CAAC,sBAAsB,EAAE,IAAI,EAAE;AAEnF;;;;;MAKa,yBAAyB,GAAG,YAAY,CAAC,sBAAsB,EAAE,KAAK,EAAE;AAErF;;;AAGA,MAAM,cAAc,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;AAEtD;;;;;MAKa,oBAAoB,GAAG,YAAY,CAAC;IAC/C,mBAAmB,EAAE;QACnB,YAAY;KACb;IACD,0BAA0B,EAAE;QAC1B,4BAA4B;KAC7B;IACD,+BAA+B,EAAE;QAC/B,wCAAwC;KACzC;IACD,gBAAgB,EAAE;QAChB,wBAAwB;KACzB;IACD,kBAAkB,EAAE;QAClB,sBAAsB;QACtB,wBAAwB;KACzB;IACD,kBAAkB,EAAE;QAClB,8BAA8B,EAAE,cAAc,CAC5C,sBAAsB,EACtB,CAAC,EAAE,KAAK,EAAE,KAAK,KAAK,CAAC,MAAM,CAAC,YAAY,EACxC,EAAE,QAAQ,EAAE,oBAAoB,EAAE,CACnC;KACF;IACD,8BAA8B,EAAE;QAC9B,mBAAmB;KACpB;IACD,6BAA6B,EAAE;QAC7B,kBAAkB;KACnB;IACD,+BAA+B,EAAE;QAC/B,wBAAwB;KACzB;IACD,uCAAuC,EAAE;QACvC,yBAAyB;KAC1B;IACD,iBAAiB,EAAE;QACjB,wBAAwB;KACzB;IACD,yBAAyB,EAAE;QACzB,wBAAwB;KACzB;CACF;;;;"}
1	+ {"version":3,"file":"wiring.js","sources":["../../../../src/x-modules/history-queries/wiring.ts"],"sourcesContent":["import {\n namespacedWireCommit,\n namespacedWireDispatch,\n namespacedWireDispatchWithoutPayload\n} from '../../wiring/namespaced-wires.factory';\nimport { namespacedDebounce } from '../../wiring/namespaced-wires.operators';\nimport { NamespacedWireCommit, NamespacedWireDispatch } from '../../wiring/namespaced-wiring.types';\nimport { createWiring } from '../../wiring/wiring.utils';\n\n/*\n `historyQueries` {@link XModuleName \| XModule name}.\n \n @internal\n /\nconst moduleName = 'historyQueries';\n/\n WireCommit for {@link HistoryQueriesXModule}.\n \n @internal\n /\nconst wireCommit: NamespacedWireCommit<typeof moduleName> = namespacedWireCommit(moduleName);\n/\n WireDispatch for {@link HistoryQueriesXModule}.\n \n @internal\n /\nconst wireDispatch: NamespacedWireDispatch<typeof moduleName> = namespacedWireDispatch(moduleName);\n/\n WireDispatchWithoutPayload for {@link HistoryQueriesXModule}.\n \n @internal\n /\nconst wireDispatchWithoutPayload = namespacedWireDispatchWithoutPayload(moduleName);\n\n/\n Saves a new query into the history queries.\n \n @public\n /\nexport const addQueryToHistoryQueries = wireDispatch('addQueryToHistory');\n\n/\n Sets the query of the history queries module. Used for searching into the history queries.\n \n @public\n /\nexport const setHistoryQueriesQuery = wireCommit('setQuery');\n\n/\n Sets the history queries state `query` from url.\n \n @public\n /\nconst setUrlParams = wireDispatch('setUrlParams');\n\n/\n Sets the query of the history queries module to an empty string.\n \n @public\n /\nexport const clearHistoryQueriesQuery = wireCommit('setQuery', '');\n\n/\n Triggers a session refresh, extending its validity for the time configured in the\n * {@link HistoryQueriesConfig.sessionTTLInMs}.\n \n @public\n /\nexport const refreshHistoryQueriesSession = wireDispatchWithoutPayload('refreshSession');\n\n/\n Loads the history queries from the browser storage, saving them to the\n * {@link HistoryQueriesState.historyQueries}.\n \n @public\n /\nexport const loadHistoryQueriesFromBrowserStorageWire = wireDispatchWithoutPayload(\n 'loadHistoryQueriesFromBrowserStorage'\n);\n\n/\n Clears the history queries.\n \n @public\n /\nexport const clearHistoryQueries = wireDispatch('setHistoryQueries', []);\n\n/\n Removes a single history query from the history queries.\n \n @public\n /\nexport const removeHistoryQuery = wireDispatch('removeFromHistory');\n\n/\n Enables history queries.\n \n @public\n /\nexport const setHistoryQueriesEnabled = wireDispatch('toggleHistoryQueries', true);\n\n/\n Disables history queries.\n \n @public\n /\nexport const setHistoryQueriesDisabled = wireDispatch('toggleHistoryQueries', false);\n\n/\n Updates the history queries with the relevant info included in a search response.\n \n @public\n /\nexport const updateHistoryQueriesWithSearchResponse = wireDispatch(\n 'updateHistoryQueriesWithSearchResponse'\n);\n\n/\n Debounce function for the module.\n /\nconst moduleDebounce = namespacedDebounce(moduleName);\n\n/\n Default wiring for the {@link HistoryQueries} module.\n \n @internal\n */\nexport const historyQueriesWiring = createWiring({\n ParamsLoadedFromUrl: {\n setUrlParams\n },\n HistoryQueriesQueryChanged: {\n refreshHistoryQueriesSession\n },\n HistoryQueriesStorageKeyChanged: {\n loadHistoryQueriesFromBrowserStorageWire\n },\n UserClearedQuery: {\n clearHistoryQueriesQuery\n },\n UserAcceptedAQuery: {\n setHistoryQueriesQuery,\n addQueryToHistoryQueries\n },\n UserIsTypingAQuery: {\n setHistoryQueriesQueryDebounce: moduleDebounce(\n setHistoryQueriesQuery,\n ({ state }) => state.config.debounceInMs,\n { cancelOn: 'UserAcceptedAQuery' }\n )\n },\n UserPressedClearHistoryQueries: {\n clearHistoryQueries\n },\n UserPressedRemoveHistoryQuery: {\n removeHistoryQuery\n },\n UserClickedEnableHistoryQueries: {\n setHistoryQueriesEnabled\n },\n UserClickedConfirmDisableHistoryQueries: {\n setHistoryQueriesDisabled\n },\n UserClickedCloseX: {\n clearHistoryQueriesQuery\n },\n UserClickedOutOfMainModal: {\n clearHistoryQueriesQuery\n },\n SearchResponseProvided: {\n updateHistoryQueriesWithSearchResponse\n }\n});\n"],"names":[],"mappings":";;;;AASA;;;;;AAKA,MAAM,UAAU,GAAG,gBAAgB,CAAC;AACpC;;;;;AAKA,MAAM,UAAU,GAA4C,oBAAoB,CAAC,UAAU,CAAC,CAAC;AAC7F;;;;;AAKA,MAAM,YAAY,GAA8C,sBAAsB,CAAC,UAAU,CAAC,CAAC;AACnG;;;;;AAKA,MAAM,0BAA0B,GAAG,oCAAoC,CAAC,UAAU,CAAC,CAAC;AAEpF;;;;;MAKa,wBAAwB,GAAG,YAAY,CAAC,mBAAmB,EAAE;AAE1E;;;;;MAKa,sBAAsB,GAAG,UAAU,CAAC,UAAU,EAAE;AAE7D;;;;;AAKA,MAAM,YAAY,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC;AAElD;;;;;MAKa,wBAAwB,GAAG,UAAU,CAAC,UAAU,EAAE,EAAE,EAAE;AAEnE;;;;;;MAMa,4BAA4B,GAAG,0BAA0B,CAAC,gBAAgB,EAAE;AAEzF;;;;;;MAMa,wCAAwC,GAAG,0BAA0B,CAChF,sCAAsC,EACtC;AAEF;;;;;MAKa,mBAAmB,GAAG,YAAY,CAAC,mBAAmB,EAAE,EAAE,EAAE;AAEzE;;;;;MAKa,kBAAkB,GAAG,YAAY,CAAC,mBAAmB,EAAE;AAEpE;;;;;MAKa,wBAAwB,GAAG,YAAY,CAAC,sBAAsB,EAAE,IAAI,EAAE;AAEnF;;;;;MAKa,yBAAyB,GAAG,YAAY,CAAC,sBAAsB,EAAE,KAAK,EAAE;AAErF;;;;;MAKa,sCAAsC,GAAG,YAAY,CAChE,wCAAwC,EACxC;AAEF;;;AAGA,MAAM,cAAc,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;AAEtD;;;;;MAKa,oBAAoB,GAAG,YAAY,CAAC;IAC/C,mBAAmB,EAAE;QACnB,YAAY;KACb;IACD,0BAA0B,EAAE;QAC1B,4BAA4B;KAC7B;IACD,+BAA+B,EAAE;QAC/B,wCAAwC;KACzC;IACD,gBAAgB,EAAE;QAChB,wBAAwB;KACzB;IACD,kBAAkB,EAAE;QAClB,sBAAsB;QACtB,wBAAwB;KACzB;IACD,kBAAkB,EAAE;QAClB,8BAA8B,EAAE,cAAc,CAC5C,sBAAsB,EACtB,CAAC,EAAE,KAAK,EAAE,KAAK,KAAK,CAAC,MAAM,CAAC,YAAY,EACxC,EAAE,QAAQ,EAAE,oBAAoB,EAAE,CACnC;KACF;IACD,8BAA8B,EAAE;QAC9B,mBAAmB;KACpB;IACD,6BAA6B,EAAE;QAC7B,kBAAkB;KACnB;IACD,+BAA+B,EAAE;QAC/B,wBAAwB;KACzB;IACD,uCAAuC,EAAE;QACvC,yBAAyB;KAC1B;IACD,iBAAiB,EAAE;QACjB,wBAAwB;KACzB;IACD,yBAAyB,EAAE;QACzB,wBAAwB;KACzB;IACD,sBAAsB,EAAE;QACtB,sCAAsC;KACvC;CACF;;;;"}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@empathyco/x-components",
-  "version": "3.0.0-alpha.239",
+  "version": "3.0.0-alpha.240",
   "description": "Empathy X Components",
   "author": "Empathy Systems Corporation S.L.",
   "license": "Apache-2.0",
@@ -135,5 +135,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "5402c859f87676965bdb0e4e577f28c4bbde3bb0"
+  "gitHead": "3fce04695e047232690f3cff8cb4e310ec7e6447"
 }

package/report/x-components.api.json CHANGED Viewed

@@ -20188,6 +20188,51 @@
                 }
               ],
               "name": "toggleHistoryQueries"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@empathyco/x-components!HistoryQueriesActions#updateHistoryQueriesWithSearchResponse:member(1)",
+              "docComment": "/**\n * Updates the history queries with the relevant info included in a search response.\n *\n * @param searchResponse - The search response to update history queries with.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "updateHistoryQueriesWithSearchResponse(searchResponse: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "InternalSearchResponse",
+                  "canonicalReference": "@empathyco/x-components!InternalSearchResponse:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "searchResponse",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  }
+                }
+              ],
+              "name": "updateHistoryQueriesWithSearchResponse"
             }
           ],
           "extendsTokenRanges": []
@@ -20446,6 +20491,37 @@
                 "endIndex": 3
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!HistoryQueriesGetters#historyQueriesWithResults:member",
+              "docComment": "/**\n * A sub-set of the {@link HistoryQueriesGetters.historyQueries} including only the queries with results at the moment they were requested.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "historyQueriesWithResults: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "HistoryQuery",
+                  "canonicalReference": "@empathyco/x-components!HistoryQuery:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "historyQueriesWithResults",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!HistoryQueriesGetters#normalizedQuery:member",
@@ -50724,6 +50800,45 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-components!updateHistoryQueriesWithSearchResponse:var",
+          "docComment": "/**\n * Updates the history queries with the relevant info included in a search response.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "updateHistoryQueriesWithSearchResponse: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"../..\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Wire",
+              "canonicalReference": "@empathyco/x-components!Wire:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<import(\"../search\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "InternalSearchResponse",
+              "canonicalReference": "@empathyco/x-components!InternalSearchResponse:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "updateHistoryQueriesWithSearchResponse",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 6
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@empathyco/x-components!UrlActionContext:type",

package/report/x-components.api.md CHANGED Viewed

@@ -1987,6 +1987,7 @@ export interface HistoryQueriesActions {
     setHistoryQueries(historyQueries: HistoryQuery_2[]): void;
     setUrlParams(urlParams: UrlParams): void;
     toggleHistoryQueries(isEnabled: boolean): void;
+    updateHistoryQueriesWithSearchResponse(searchResponse: InternalSearchResponse): void;
 }
 // @public
@@ -2020,6 +2021,7 @@ export class HistoryQueriesGetter implements GettersClass<HistoryQueriesXStoreMo
 // @public
 export interface HistoryQueriesGetters {
     historyQueries: HistoryQuery_2[];
+    historyQueriesWithResults: HistoryQuery_2[];
     normalizedQuery: string;
     sessionHistoryQueries: HistoryQuery_2[];
     storageKey: string;
@@ -2095,6 +2097,9 @@ export const historyQueriesWiring: {
     UserClickedOutOfMainModal: {
         clearHistoryQueriesQuery: AnyWire;
     };
+    SearchResponseProvided: {
+        updateHistoryQueriesWithSearchResponse: Wire<InternalSearchResponse>;
+    };
 };
 // @public
@@ -4950,6 +4955,9 @@ export const TrendingIcon: {};
 // @public (undocumented)
 export const TrendingTinyIcon: {};
+// @public
+export const updateHistoryQueriesWithSearchResponse: Wire<InternalSearchResponse>;
 // @public
 export type UrlActionContext = XActionContext<UrlState, UrlGetters, UrlMutations, UrlActions>;

package/types/x-modules/history-queries/store/actions/update-history-queries-with-search-response.action.d.ts ADDED Viewed

@@ -0,0 +1,22 @@
+import { HistoryQueriesXStoreModule } from '../types';
+/**
+ * Default implementation for the
+ * {@link HistoryQueriesActions.updateHistoryQueriesWithSearchResponse} action.
+ *
+ * The matching history query will only be updated on the following scenarios:
+ * 1. If it is part of a previous session, not the current one.
+ * 2. If its total results count has not been registered yet.
+ * 3. If its total results count registered is less than the one specified on the search response,
+ * meaning that the previous update was part of a filtered request.
+ *
+ * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions,
+ * provided by Vuex.
+ *
+ * @param searchResponse - The search response to update history queries with.
+ *
+ * @returns A `void` promise that resolves when the history query finishes updating.
+ *
+ * @public
+ */
+export declare const updateHistoryQueriesWithSearchResponse: HistoryQueriesXStoreModule['actions']['updateHistoryQueriesWithSearchResponse'];
+//# sourceMappingURL=update-history-queries-with-search-response.action.d.ts.map

package/types/x-modules/history-queries/store/actions/update-history-queries-with-search-response.action.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"update-history-queries-with-search-response.action.d.ts","sourceRoot":"","sources":["../../../../../../src/x-modules/history-queries/store/actions/update-history-queries-with-search-response.action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,UAAU,CAAC;AAEtD;;;;;;;;;;;;;;;;;;GAkBG;AAEH,eAAO,MAAM,sCAAsC,EAAE,0BAA0B,CAAC,SAAS,CAAC,CAAC,wCAAwC,CAuBhI,CAAC"}

package/types/x-modules/history-queries/store/getters/history-queries-with-results.getter.d.ts ADDED Viewed

@@ -0,0 +1,16 @@
+import { HistoryQueriesXStoreModule } from '../types';
+/**
+ * Default implementation for the {@link HistoryQueriesGetters.historyQueriesWithResults} getter.
+ *
+ * @param state - Current {@link https://vuex.vuejs.org/guide/state.html | state} of the history
+ * queries module.
+ *
+ * @param getters - Current {@link https://vuex.vuejs.org/guide/getters.html | getters} of the
+ * history queries module.
+ *
+ * @returns The history queries that have results at the moment they were requested.
+ *
+ * @public
+ */
+export declare const historyQueriesWithResults: HistoryQueriesXStoreModule['getters']['historyQueriesWithResults'];
+//# sourceMappingURL=history-queries-with-results.getter.d.ts.map

package/types/x-modules/history-queries/store/getters/history-queries-with-results.getter.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"history-queries-with-results.getter.d.ts","sourceRoot":"","sources":["../../../../../../src/x-modules/history-queries/store/getters/history-queries-with-results.getter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,UAAU,CAAC;AAEtD;;;;;;;;;;;;GAYG;AAEH,eAAO,MAAM,yBAAyB,EAAE,0BAA0B,CAAC,SAAS,CAAC,CAAC,2BAA2B,CACb,CAAC"}

package/types/x-modules/history-queries/store/module.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/history-queries/store/module.ts"],"names":[],"mappings":"~~AAeA~~,OAAO,EAAE,0BAA0B,EAAE,MAAM,SAAS,CAAC;AAErD;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,EAAE,~~0BAwCxC~~,CAAC"}
1	+ {"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/history-queries/store/module.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,0BAA0B,EAAE,MAAM,SAAS,CAAC;AAErD;;;;GAIG;AACH,eAAO,MAAM,0BAA0B,EAAE,0BA0CxC,CAAC"}

package/types/x-modules/history-queries/store/types.d.ts CHANGED Viewed

@@ -3,6 +3,7 @@ import { XActionContext, XStoreModule } from '../../../store';
 import { QueryMutations, QueryState } from '../../../store/utils/query.utils';
 import { UrlParams } from '../../../types/url-params';
 import { HistoryQueriesConfig } from '../config.types';
+import { InternalSearchResponse } from '../../search/index';
 /**
  * HistoryQueries store state.
  *
@@ -45,6 +46,11 @@ export interface HistoryQueriesGetters {
     historyQueries: HistoryQuery[];
     /** The normalized module's query. */
     normalizedQuery: string;
+    /**
+     * A sub-set of the {@link HistoryQueriesGetters.historyQueries} including only the queries with
+     * results at the moment they were requested.
+     */
+    historyQueriesWithResults: HistoryQuery[];
     /**
      * A list of the queries that have been made in the last period of time specified by
      * {@link HistoryQueriesConfig.sessionTTLInMs}.
@@ -173,6 +179,12 @@ export interface HistoryQueriesActions {
      * @param isEnabled - Whether to enable or disable the history queries.
      */
     toggleHistoryQueries(isEnabled: boolean): void;
+    /**
+     * Updates the history queries with the relevant info included in a search response.
+     *
+     * @param searchResponse - The search response to update history queries with.
+     */
+    updateHistoryQueriesWithSearchResponse(searchResponse: InternalSearchResponse): void;
 }
 /**
  * HistoryQueries type safe store module.

package/types/x-modules/history-queries/store/types.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/history-queries/store/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;~~AAEvD~~;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAC7B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,cAAc,EAAE,YAAY,EAAE,CAAC;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,cAAc,EAAE,YAAY,EAAE,CAAC;IAC/B,qCAAqC;IACrC,eAAe,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,qBAAqB,EAAE,YAAY,EAAE,CAAC;IACtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AACD;;;;GAIG;AACH,MAAM,WAAW,uBAAwB,SAAQ,cAAc;IAC7D;;;;OAIG;IACH,iBAAiB,CAAC,cAAc,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;IACxD;;;;OAIG;IACH,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7C;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B;;;;OAIG;IACH,YAAY,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;CACxC;AACD;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC;;;OAGG;IACH,oCAAoC,IAAI,IAAI,CAAC;IAC7C;;OAEG;IACH,cAAc,IAAI,IAAI,CAAC;IACvB;;;;OAIG;IACH,iBAAiB,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IACpD;;;;;;OAMG;IACH,iBAAiB,CAAC,cAAc,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;IACxD;;;;OAIG;IACH,YAAY,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IACzC;;;;;OAKG;IACH,oBAAoB,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;~~CAChD~~;AACD;;;;GAIG;AACH,oBAAY,0BAA0B,GAAG,YAAY,CACnD,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,qBAAqB,CACtB,CAAC;AAEF;;;;GAIG;AACH,oBAAY,2BAA2B,GAAG,cAAc,CACtD,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,qBAAqB,CACtB,CAAC"}
1	+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/history-queries/store/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AAC9E,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAE5D;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAC7B;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,cAAc,EAAE,YAAY,EAAE,CAAC;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,cAAc,EAAE,YAAY,EAAE,CAAC;IAC/B,qCAAqC;IACrC,eAAe,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,yBAAyB,EAAE,YAAY,EAAE,CAAC;IAC1C;;;OAGG;IACH,qBAAqB,EAAE,YAAY,EAAE,CAAC;IACtC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AACD;;;;GAIG;AACH,MAAM,WAAW,uBAAwB,SAAQ,cAAc;IAC7D;;;;OAIG;IACH,iBAAiB,CAAC,cAAc,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;IACxD;;;;OAIG;IACH,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7C;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B;;;;OAIG;IACH,YAAY,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;CACxC;AACD;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC;;;OAGG;IACH,oCAAoC,IAAI,IAAI,CAAC;IAC7C;;OAEG;IACH,cAAc,IAAI,IAAI,CAAC;IACvB;;;;OAIG;IACH,iBAAiB,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IACpD;;;;;;OAMG;IACH,iBAAiB,CAAC,cAAc,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC;IACxD;;;;OAIG;IACH,YAAY,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IACzC;;;;;OAKG;IACH,oBAAoB,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IAC/C;;;;OAIG;IACH,sCAAsC,CAAC,cAAc,EAAE,sBAAsB,GAAG,IAAI,CAAC;CACtF;AACD;;;;GAIG;AACH,oBAAY,0BAA0B,GAAG,YAAY,CACnD,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,qBAAqB,CACtB,CAAC;AAEF;;;;GAIG;AACH,oBAAY,2BAA2B,GAAG,cAAc,CACtD,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,qBAAqB,CACtB,CAAC"}

package/types/x-modules/history-queries/wiring.d.ts CHANGED Viewed

@@ -54,6 +54,12 @@ export declare const setHistoryQueriesEnabled: import("../..").AnyWire;
  * @public
  */
 export declare const setHistoryQueriesDisabled: import("../..").AnyWire;
+/**
+ * Updates the history queries with the relevant info included in a search response.
+ *
+ * @public
+ */
+export declare const updateHistoryQueriesWithSearchResponse: import("../..").Wire<import("../search").InternalSearchResponse>;
 /**
  * Default wiring for the {@link HistoryQueries} module.
  *
@@ -97,5 +103,8 @@ export declare const historyQueriesWiring: {
     UserClickedOutOfMainModal: {
         clearHistoryQueriesQuery: import("../..").AnyWire;
     };
+    SearchResponseProvided: {
+        updateHistoryQueriesWithSearchResponse: import("../..").Wire<import("../search").InternalSearchResponse>;
+    };
 };
 //# sourceMappingURL=wiring.d.ts.map

package/types/x-modules/history-queries/wiring.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"wiring.d.ts","sourceRoot":"","sources":["../../../../src/x-modules/history-queries/wiring.ts"],"names":[],"mappings":"AAkCA;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,8BAAoC,CAAC;AAE1E;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,8BAAyB,CAAC;AAS7D;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,yBAA6B,CAAC;AAEnE;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,yBAA+C,CAAC;AAEzF;;;;;GAKG;AACH,eAAO,MAAM,wCAAwC,yBAEpD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,yBAAwC,CAAC;AAEzE;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,iEAAoC,CAAC;AAEpE;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,yBAA6C,CAAC;AAEnF;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,yBAA8C,CAAC;~~AAOrF~~;;;;GAIG;AACH,eAAO,MAAM,oBAAoB~~;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0C~~/B,CAAC"}
1	+ {"version":3,"file":"wiring.d.ts","sourceRoot":"","sources":["../../../../src/x-modules/history-queries/wiring.ts"],"names":[],"mappings":"AAkCA;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,8BAAoC,CAAC;AAE1E;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,8BAAyB,CAAC;AAS7D;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,yBAA6B,CAAC;AAEnE;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,yBAA+C,CAAC;AAEzF;;;;;GAKG;AACH,eAAO,MAAM,wCAAwC,yBAEpD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,yBAAwC,CAAC;AAEzE;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,iEAAoC,CAAC;AAEpE;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,yBAA6C,CAAC;AAEnF;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,yBAA8C,CAAC;AAErF;;;;GAIG;AACH,eAAO,MAAM,sCAAsC,kEAElD,CAAC;AAOF;;;;GAIG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6C/B,CAAC"}