@empathyco/x-components 3.0.0-alpha.153 → 3.0.0-alpha.154

package/CHANGELOG.md

@@ -3,6 +3,19 @@
 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.154](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.153...@empathyco/x-components@3.0.0-alpha.154) (2022-08-12)
+
+### Features
+
+- add `queriesPreview` option to snippet config (#654)
+  ([7733c98](https://github.com/empathyco/x/commit/7733c9856b2859574ca0cace9c79b8b58545f46a)),
+  closes [EX-6849](https://searchbroker.atlassian.net/browse/EX-6849)
+
+# 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.153](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.152...@empathyco/x-components@3.0.0-alpha.153) (2022-08-10)
 
 ### Features

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

@@ -272,6 +272,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [PopularSearchesState](./x-components.popularsearchesstate.md) | Popular searches module state. |
 |  [PopularSearchesXEvents](./x-components.popularsearchesxevents.md) | Dictionary of the events of PopularSearches XModule, where each key is the event name, and the value is the event payload type or <code>void</code> if it has no payload. |
 |  [PrivateXModuleOptions](./x-components.privatexmoduleoptions.md) | Options for overriding the default store module and store emitters for a [XModule](./x-components.xmodule.md)<!-- -->. |
+|  [QueryPreview](./x-components.querypreview.md) | Information to render a query preview with. |
 |  [QuerySuggestionsActions](./x-components.querysuggestionsactions.md) | QuerySuggestions store actions. |
 |  [QuerySuggestionsConfig](./x-components.querysuggestionsconfig.md) | Configuration options for the [QuerySuggestionsXModule](./x-components.querysuggestionsxmodule.md)<!-- -->. |
 |  [QuerySuggestionsGetters](./x-components.querysuggestionsgetters.md) | QuerySuggestions store getters. |

package/docs/API-reference/api/x-components.querypreview.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [QueryPreview](./x-components.querypreview.md)
+
+## QueryPreview interface
+
+Information to render a query preview with.
+
+<b>Signature:</b>
+
+```typescript
+export interface QueryPreview 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [query](./x-components.querypreview.query.md) | string | The query to search for. |
+|  [title?](./x-components.querypreview.title.md) | string | <i>(Optional)</i> An optional title for the container. |
+

package/docs/API-reference/api/x-components.querypreview.query.md

@@ -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; [QueryPreview](./x-components.querypreview.md) &gt; [query](./x-components.querypreview.query.md)
+
+## QueryPreview.query property
+
+The query to search for.
+
+<b>Signature:</b>
+
+```typescript
+query: string;
+```

package/docs/API-reference/api/x-components.querypreview.title.md

@@ -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; [QueryPreview](./x-components.querypreview.md) &gt; [title](./x-components.querypreview.title.md)
+
+## QueryPreview.title property
+
+An optional title for the container.
+
+<b>Signature:</b>
+
+```typescript
+title?: string;
+```

package/docs/API-reference/api/x-components.snippetconfig.md

@@ -26,6 +26,7 @@ export interface SnippetConfig
 |  [isSpa?](./x-components.snippetconfig.isspa.md) | boolean | <i>(Optional)</i> Flag determining if the page is a single page application or not. |
 |  [lang](./x-components.snippetconfig.lang.md) | string | Language to display. |
 |  [productId?](./x-components.snippetconfig.productid.md) | string | <i>(Optional)</i> The id for the current product when product page is loaded. |
+|  [queriesPreview?](./x-components.snippetconfig.queriespreview.md) | [QueryPreview](./x-components.querypreview.md)<!-- -->\[\] | <i>(Optional)</i> List of queries to preview. |
 |  [scope](./x-components.snippetconfig.scope.md) | string | Execution scope (desktop, mobile, app, ...). |
 |  [searchLang?](./x-components.snippetconfig.searchlang.md) | string | <i>(Optional)</i> Language to send to backend services. |
 

package/docs/API-reference/api/x-components.snippetconfig.queriespreview.md

@@ -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; [SnippetConfig](./x-components.snippetconfig.md) &gt; [queriesPreview](./x-components.snippetconfig.queriespreview.md)
+
+## SnippetConfig.queriesPreview property
+
+List of queries to preview.
+
+<b>Signature:</b>
+
+```typescript
+queriesPreview?: QueryPreview[];
+```

package/docs/API-reference/components/extra-params/x-components.snippet-config-extra-params.md

@@ -11,10 +11,10 @@ objects of every x-module.
 
 ## Props
 
-| Name                             | Description                                                                                    | Type                    | Default                                                                                                                                                                                         |
-| -------------------------------- | ---------------------------------------------------------------------------------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <code>values</code>              | A Dictionary where the keys are the extra param names and its values.                          | <code>Dictionary</code> | <code></code>                                                                                                                                                                                   |
-| <code>excludedExtraParams</code> | Collection of properties from the snippet config to exclude from the<br />extra params object. | <code>Array</code>      | <code>(): Array<keyof SnippetConfig> => [<br /> 'callbacks',<br /> 'productId',<br /> 'searchLang',<br /> 'consent',<br /> 'documentDirection',<br /> 'currency',<br /> 'filters'<br />]</code> |
+| Name                             | Description                                                                                    | Type                    | Default                                                                                                                                                                                                                                |
+| -------------------------------- | ---------------------------------------------------------------------------------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <code>values</code>              | A Dictionary where the keys are the extra param names and its values.                          | <code>Dictionary</code> | <code></code>                                                                                                                                                                                                                          |
+| <code>excludedExtraParams</code> | Collection of properties from the snippet config to exclude from the<br />extra params object. | <code>Array</code>      | <code>(): Array<keyof SnippetConfig> => [<br /> 'callbacks',<br /> 'productId',<br /> 'searchLang',<br /> 'consent',<br /> 'documentDirection',<br /> 'currency',<br /> 'filters',<br /> 'isSpa',<br /> 'queriesPreview'<br />]</code> |
 
 ## See it in action
 

package/js/x-modules/extra-params/components/snippet-config-extra-params.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"snippet-config-extra-params.vue.js","sources":["../../../../../src/x-modules/extra-params/components/snippet-config-extra-params.vue"],"sourcesContent":["<template>\n  <ExtraParams :values=\"extraParams\" />\n</template>\n\n<script lang=\"ts\">\n  import { forEach, Dictionary } from '@empathyco/x-utils';\n  import Vue from 'vue';\n  import { Component, Watch, Inject, Prop } from 'vue-property-decorator';\n  import { xComponentMixin } from '../../../components/x-component.mixin';\n  import { SnippetConfig } from '../../../x-installer/api/api.types';\n  import { extraParamsXModule } from '../x-module';\n  import ExtraParams from './extra-params.vue';\n\n  /**\n   * Extracts the extra parameters from the {@link SnippetConfig} and syncs it with the request\n   * objects of every x-module.\n   *\n   * @public\n   */\n  @Component({\n    components: { ExtraParams },\n    mixins: [xComponentMixin(extraParamsXModule)]\n  })\n  export default class SnippetConfigExtraParams extends Vue {\n    /**\n     * It injects {@link SnippetConfig} provided by an ancestor as snippetConfig.\n     *\n     * @internal\n     */\n    @Inject('snippetConfig')\n    public snippetConfig!: SnippetConfig;\n\n    /**\n     * A Dictionary where the keys are the extra param names and its values.\n     *\n     * @public\n     */\n    @Prop()\n    protected values?: Dictionary<unknown>;\n\n    /**\n     * Custom object containing the extra params from the snippet config.\n     *\n     * @remarks This object keeps manually the desired snippet config properties to avoid\n     * unnecessary re-renders.\n     *\n     * @internal\n     */\n    protected extraParams: Dictionary<unknown> = {};\n\n    /**\n     * Collection of properties from the snippet config to exclude from the\n     * extra params object.\n     *\n     * @public\n     */\n    @Prop({\n      default: (): Array<keyof SnippetConfig> => [\n        'callbacks',\n        'productId',\n        'searchLang',\n        'consent',\n        'documentDirection',\n        'currency',\n        'filters'\n      ]\n    })\n    protected excludedExtraParams!: Array<keyof SnippetConfig>;\n\n    /**\n     * Updates the extraParams object when the snippet config changes.\n     *\n     * @param snippetConfig - The new snippet config.\n     *\n     * @internal\n     */\n    @Watch('snippetConfig', { deep: true, immediate: true })\n    syncExtraParams(snippetConfig: SnippetConfig): void {\n      forEach({ ...this.values, ...snippetConfig }, (name, value) => {\n        if (this.excludedExtraParams.includes(name)) {\n          return;\n        }\n        this.$set(this.extraParams, name, value);\n      });\n    }\n  }\n</script>\n\n<docs lang=\"mdx\">\n## See it in action\n\n_See how the snippet config is injected and passed to the SnippetConfigExtraParams component._\n\n```vue\n<template>\n  <Provider>\n    <SnippetConfigExtraParams />\n  </Provider>\n</template>\n\n<script>\n  import { SnippetConfigExtraParams } from '@empathyco/x-components/extra-params';\n\n  const Provider = {\n    provide: {\n      snippetConfig: {\n        instance: 'demo',\n        lang: 'es',\n        warehouse: 1234\n      }\n    }\n  };\n\n  export default {\n    name: 'SnippetConfigExtraParamsDemo',\n    components: {\n      Provider,\n      SnippetConfigExtraParams\n    }\n  };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"snippet-config-extra-params.vue.js","sources":["../../../../../src/x-modules/extra-params/components/snippet-config-extra-params.vue"],"sourcesContent":["<template>\n  <ExtraParams :values=\"extraParams\" />\n</template>\n\n<script lang=\"ts\">\n  import { forEach, Dictionary } from '@empathyco/x-utils';\n  import Vue from 'vue';\n  import { Component, Watch, Inject, Prop } from 'vue-property-decorator';\n  import { xComponentMixin } from '../../../components/x-component.mixin';\n  import { SnippetConfig } from '../../../x-installer/api/api.types';\n  import { extraParamsXModule } from '../x-module';\n  import ExtraParams from './extra-params.vue';\n\n  /**\n   * Extracts the extra parameters from the {@link SnippetConfig} and syncs it with the request\n   * objects of every x-module.\n   *\n   * @public\n   */\n  @Component({\n    components: { ExtraParams },\n    mixins: [xComponentMixin(extraParamsXModule)]\n  })\n  export default class SnippetConfigExtraParams extends Vue {\n    /**\n     * It injects {@link SnippetConfig} provided by an ancestor as snippetConfig.\n     *\n     * @internal\n     */\n    @Inject('snippetConfig')\n    public snippetConfig!: SnippetConfig;\n\n    /**\n     * A Dictionary where the keys are the extra param names and its values.\n     *\n     * @public\n     */\n    @Prop()\n    protected values?: Dictionary<unknown>;\n\n    /**\n     * Custom object containing the extra params from the snippet config.\n     *\n     * @remarks This object keeps manually the desired snippet config properties to avoid\n     * unnecessary re-renders.\n     *\n     * @internal\n     */\n    protected extraParams: Dictionary<unknown> = {};\n\n    /**\n     * Collection of properties from the snippet config to exclude from the\n     * extra params object.\n     *\n     * @public\n     */\n    @Prop({\n      default: (): Array<keyof SnippetConfig> => [\n        'callbacks',\n        'productId',\n        'searchLang',\n        'consent',\n        'documentDirection',\n        'currency',\n        'filters',\n        'isSpa',\n        'queriesPreview'\n      ]\n    })\n    protected excludedExtraParams!: Array<keyof SnippetConfig>;\n\n    /**\n     * Updates the extraParams object when the snippet config changes.\n     *\n     * @param snippetConfig - The new snippet config.\n     *\n     * @internal\n     */\n    @Watch('snippetConfig', { deep: true, immediate: true })\n    syncExtraParams(snippetConfig: SnippetConfig): void {\n      forEach({ ...this.values, ...snippetConfig }, (name, value) => {\n        if (!this.excludedExtraParams.includes(name)) {\n          this.$set(this.extraParams, name, value);\n        }\n      });\n    }\n  }\n</script>\n\n<docs lang=\"mdx\">\n## See it in action\n\n_See how the snippet config is injected and passed to the SnippetConfigExtraParams component._\n\n```vue\n<template>\n  <Provider>\n    <SnippetConfigExtraParams />\n  </Provider>\n</template>\n\n<script>\n  import { SnippetConfigExtraParams } from '@empathyco/x-components/extra-params';\n\n  const Provider = {\n    provide: {\n      snippetConfig: {\n        instance: 'demo',\n        lang: 'es',\n        warehouse: 1234\n      }\n    }\n  };\n\n  export default {\n    name: 'SnippetConfigExtraParamsDemo',\n    components: {\n      Provider,\n      SnippetConfigExtraParams\n    }\n  };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/js/x-modules/extra-params/components/snippet-config-extra-params.vue_rollup-plugin-vue_script.vue.js

@@ -34,10 +34,9 @@ let SnippetConfigExtraParams = class SnippetConfigExtraParams extends Vue {
      */
     syncExtraParams(snippetConfig) {
         forEach({ ...this.values, ...snippetConfig }, (name, value) => {
-            if (this.excludedExtraParams.includes(name)) {
-                return;
+            if (!this.excludedExtraParams.includes(name)) {
+                this.$set(this.extraParams, name, value);
             }
-            this.$set(this.extraParams, name, value);
         });
     }
 };
@@ -56,7 +55,9 @@ __decorate([
             'consent',
             'documentDirection',
             'currency',
-            'filters'
+            'filters',
+            'isSpa',
+            'queriesPreview'
         ]
     })
 ], SnippetConfigExtraParams.prototype, "excludedExtraParams", void 0);

package/js/x-modules/extra-params/components/snippet-config-extra-params.vue_rollup-plugin-vue_script.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"snippet-config-extra-params.vue_rollup-plugin-vue_script.vue.js","sources":["../../../../../src/x-modules/extra-params/components/snippet-config-extra-params.vue?rollup-plugin-vue=script.ts"],"sourcesContent":["\n\n\n\n\nimport { forEach, Dictionary } from '@empathyco/x-utils';\nimport Vue from 'vue';\nimport { Component, Watch, Inject, Prop } from 'vue-property-decorator';\nimport { xComponentMixin } from '../../../components/x-component.mixin';\nimport { SnippetConfig } from '../../../x-installer/api/api.types';\nimport { extraParamsXModule } from '../x-module';\nimport ExtraParams from './extra-params.vue';\n\n/**\n * Extracts the extra parameters from the {@link SnippetConfig} and syncs it with the request\n * objects of every x-module.\n *\n * @public\n */\n@Component({\n  components: { ExtraParams },\n  mixins: [xComponentMixin(extraParamsXModule)]\n})\nexport default class SnippetConfigExtraParams extends Vue {\n  /**\n   * It injects {@link SnippetConfig} provided by an ancestor as snippetConfig.\n   *\n   * @internal\n   */\n  @Inject('snippetConfig')\n  public snippetConfig!: SnippetConfig;\n\n  /**\n   * A Dictionary where the keys are the extra param names and its values.\n   *\n   * @public\n   */\n  @Prop()\n  protected values?: Dictionary<unknown>;\n\n  /**\n   * Custom object containing the extra params from the snippet config.\n   *\n   * @remarks This object keeps manually the desired snippet config properties to avoid\n   * unnecessary re-renders.\n   *\n   * @internal\n   */\n  protected extraParams: Dictionary<unknown> = {};\n\n  /**\n   * Collection of properties from the snippet config to exclude from the\n   * extra params object.\n   *\n   * @public\n   */\n  @Prop({\n    default: (): Array<keyof SnippetConfig> => [\n      'callbacks',\n      'productId',\n      'searchLang',\n      'consent',\n      'documentDirection',\n      'currency',\n      'filters'\n    ]\n  })\n  protected excludedExtraParams!: Array<keyof SnippetConfig>;\n\n  /**\n   * Updates the extraParams object when the snippet config changes.\n   *\n   * @param snippetConfig - The new snippet config.\n   *\n   * @internal\n   */\n  @Watch('snippetConfig', { deep: true, immediate: true })\n  syncExtraParams(snippetConfig: SnippetConfig): void {\n    forEach({ ...this.values, ...snippetConfig }, (name, value) => {\n      if (this.excludedExtraParams.includes(name)) {\n        return;\n      }\n      this.$set(this.extraParams, name, value);\n    });\n  }\n}\n"],"names":["ExtraParams"],"mappings":";;;;;;;;AAaA;;;;;;AAUA,IAAqB,wBAAwB,GAA7C,MAAqB,wBAAyB,SAAQ,GAAG;IAAzD;;;;;;;;;;QAyBY,gBAAW,GAAwB,EAAE,CAAC;KAqCjD;;;;;;;;IARC,eAAe,CAAC,aAA4B;QAC1C,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,aAAa,EAAE,EAAE,CAAC,IAAI,EAAE,KAAK;YACxD,IAAI,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBAC3C,OAAO;aACR;YACD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;SAC1C,CAAC,CAAC;KACJ;CACF,CAAA;AAvDC;IADC,MAAM,CAAC,eAAe,CAAC;+DACa;AAQrC;IADC,IAAI,EAAE;wDACgC;AA6BvC;IAXC,IAAI,CAAC;QACJ,OAAO,EAAE,MAAkC;YACzC,WAAW;YACX,WAAW;YACX,YAAY;YACZ,SAAS;YACT,mBAAmB;YACnB,UAAU;YACV,SAAS;SACV;KACF,CAAC;qEACyD;AAU3D;IADC,KAAK,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;+DAQvD;AA7DkB,wBAAwB;IAJ5C,SAAS,CAAC;QACT,UAAU,EAAE,eAAEA,iBAAW,EAAE;QAC3B,MAAM,EAAE,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC;KAC9C,CAAC;GACmB,wBAAwB,CA8D5C;aA9DoB,wBAAwB;;;;"}
+{"version":3,"file":"snippet-config-extra-params.vue_rollup-plugin-vue_script.vue.js","sources":["../../../../../src/x-modules/extra-params/components/snippet-config-extra-params.vue?rollup-plugin-vue=script.ts"],"sourcesContent":["\n\n\n\n\nimport { forEach, Dictionary } from '@empathyco/x-utils';\nimport Vue from 'vue';\nimport { Component, Watch, Inject, Prop } from 'vue-property-decorator';\nimport { xComponentMixin } from '../../../components/x-component.mixin';\nimport { SnippetConfig } from '../../../x-installer/api/api.types';\nimport { extraParamsXModule } from '../x-module';\nimport ExtraParams from './extra-params.vue';\n\n/**\n * Extracts the extra parameters from the {@link SnippetConfig} and syncs it with the request\n * objects of every x-module.\n *\n * @public\n */\n@Component({\n  components: { ExtraParams },\n  mixins: [xComponentMixin(extraParamsXModule)]\n})\nexport default class SnippetConfigExtraParams extends Vue {\n  /**\n   * It injects {@link SnippetConfig} provided by an ancestor as snippetConfig.\n   *\n   * @internal\n   */\n  @Inject('snippetConfig')\n  public snippetConfig!: SnippetConfig;\n\n  /**\n   * A Dictionary where the keys are the extra param names and its values.\n   *\n   * @public\n   */\n  @Prop()\n  protected values?: Dictionary<unknown>;\n\n  /**\n   * Custom object containing the extra params from the snippet config.\n   *\n   * @remarks This object keeps manually the desired snippet config properties to avoid\n   * unnecessary re-renders.\n   *\n   * @internal\n   */\n  protected extraParams: Dictionary<unknown> = {};\n\n  /**\n   * Collection of properties from the snippet config to exclude from the\n   * extra params object.\n   *\n   * @public\n   */\n  @Prop({\n    default: (): Array<keyof SnippetConfig> => [\n      'callbacks',\n      'productId',\n      'searchLang',\n      'consent',\n      'documentDirection',\n      'currency',\n      'filters',\n      'isSpa',\n      'queriesPreview'\n    ]\n  })\n  protected excludedExtraParams!: Array<keyof SnippetConfig>;\n\n  /**\n   * Updates the extraParams object when the snippet config changes.\n   *\n   * @param snippetConfig - The new snippet config.\n   *\n   * @internal\n   */\n  @Watch('snippetConfig', { deep: true, immediate: true })\n  syncExtraParams(snippetConfig: SnippetConfig): void {\n    forEach({ ...this.values, ...snippetConfig }, (name, value) => {\n      if (!this.excludedExtraParams.includes(name)) {\n        this.$set(this.extraParams, name, value);\n      }\n    });\n  }\n}\n"],"names":["ExtraParams"],"mappings":";;;;;;;;AAaA;;;;;;AAUA,IAAqB,wBAAwB,GAA7C,MAAqB,wBAAyB,SAAQ,GAAG;IAAzD;;;;;;;;;;QAyBY,gBAAW,GAAwB,EAAE,CAAC;KAsCjD;;;;;;;;IAPC,eAAe,CAAC,aAA4B;QAC1C,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,aAAa,EAAE,EAAE,CAAC,IAAI,EAAE,KAAK;YACxD,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBAC5C,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;aAC1C;SACF,CAAC,CAAC;KACJ;CACF,CAAA;AAxDC;IADC,MAAM,CAAC,eAAe,CAAC;+DACa;AAQrC;IADC,IAAI,EAAE;wDACgC;AA+BvC;IAbC,IAAI,CAAC;QACJ,OAAO,EAAE,MAAkC;YACzC,WAAW;YACX,WAAW;YACX,YAAY;YACZ,SAAS;YACT,mBAAmB;YACnB,UAAU;YACV,SAAS;YACT,OAAO;YACP,gBAAgB;SACjB;KACF,CAAC;qEACyD;AAU3D;IADC,KAAK,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;+DAOvD;AA9DkB,wBAAwB;IAJ5C,SAAS,CAAC;QACT,UAAU,EAAE,eAAEA,iBAAW,EAAE;QAC3B,MAAM,EAAE,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC;KAC9C,CAAC;GACmB,wBAAwB,CA+D5C;aA/DoB,wBAAwB;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empathyco/x-components",
-  "version": "3.0.0-alpha.153",
+  "version": "3.0.0-alpha.154",
   "description": "Empathy X Components",
   "author": "Empathy Systems Corporation S.L.",
   "license": "Apache-2.0",
@@ -125,5 +125,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "bd382b4a1cbf85f43f1a9091f63caa328edcf719"
+  "gitHead": "2b7cac6055cfecd1d120bb541e2b4fda0494b2cd"
 }

package/report/x-components.api.json

@@ -30539,6 +30539,116 @@
             "endIndex": 7
           }
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@empathyco/x-components!QueryPreview:interface",
+          "docComment": "/**\n * Information to render a query preview with.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface QueryPreview "
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "QueryPreview",
+          "members": [
+            {
+              "kind": "IndexSignature",
+              "canonicalReference": "@empathyco/x-components!QueryPreview:index(1)",
+              "docComment": "/**\n * Any other additional information to render the preview with.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "[extra: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "]: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "unknown"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "extra",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!QueryPreview#query:member",
+              "docComment": "/**\n * The query to search for.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "query: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "query",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!QueryPreview#title:member",
+              "docComment": "/**\n * An optional title for the container.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "title?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "title",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Class",
           "canonicalReference": "@empathyco/x-components!QuerySuggestion:class",
@@ -43364,7 +43474,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "any"
+                  "text": "unknown"
                 },
                 {
                   "kind": "Content",
@@ -43649,6 +43759,37 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!SnippetConfig#queriesPreview:member",
+              "docComment": "/**\n * List of queries to preview.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "queriesPreview?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "QueryPreview",
+                  "canonicalReference": "@empathyco/x-components!QueryPreview:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "queriesPreview",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!SnippetConfig#scope:member",

package/report/x-components.api.md

@@ -2868,6 +2868,13 @@ export type QueryOrigin = `${QueryFeature}:${FeatureLocation}`;
 // @public
 export type QueryOriginInit = Partial<Pick<WireMetadata, 'feature' | 'location'>>;
 
+// @public
+export interface QueryPreview {
+    [extra: string]: unknown;
+    query: string;
+    title?: string;
+}
+
 // @public
 export class QuerySuggestion extends Vue_3 {
     // @internal
@@ -4177,7 +4184,7 @@ export class SnippetCallbacks extends Vue_2 {
 
 // @public
 export interface SnippetConfig {
-    [extra: string]: any;
+    [extra: string]: unknown;
     callbacks?: XEventListeners;
     consent?: boolean;
     currency?: string;
@@ -4188,6 +4195,7 @@ export interface SnippetConfig {
     isSpa?: boolean;
     lang: string;
     productId?: string;
+    queriesPreview?: QueryPreview[];
     scope: string;
     searchLang?: string;
 }

package/types/x-installer/api/api.types.d.ts

@@ -105,7 +105,22 @@ export interface SnippetConfig {
     productId?: string;
     /** The filters to be applied on the first request. */
     filters?: string[];
+    /** List of queries to preview. */
+    queriesPreview?: QueryPreview[];
     /** Any extra param to send in all backend calls. */
-    [extra: string]: any;
+    [extra: string]: unknown;
+}
+/**
+ * Information to render a query preview with.
+ *
+ * @public
+ */
+export interface QueryPreview {
+    /** The query to search for. */
+    query: string;
+    /** An optional title for the container. */
+    title?: string;
+    /** Any other additional information to render the preview with. */
+    [extra: string]: unknown;
 }
 //# sourceMappingURL=api.types.d.ts.map

package/types/x-installer/api/api.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.types.d.ts","sourceRoot":"","sources":["../../../../src/x-installer/api/api.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD;;;;;GAKG;AACH,MAAM,WAAW,IAAI;IACnB;;;;;;;OAOG;IACH,gBAAgB,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3C;;;;;OAKG;IACH,MAAM,CAAC,GAAG,EAAE,IAAI,GAAG,IAAI,CAAC;IAExB;;;;;;;OAOG;IACH,eAAe,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,aAAa,KAAK,IAAI,GAAG,IAAI,CAAC;IAErE;;;;;;OAMG;IACH,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;IAEvD;;;;;;OAMG;IACH,wBAAwB,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;IAEnF;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;;;OAMG;IACH,IAAI,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC;CACnC;AAED;;;;GAIG;AACH,oBAAY,eAAe,GAAG,OAAO,CACnC;KACG,KAAK,IAAI,MAAM,GAAG,CAAC,OAAO,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,YAAY,KAAK,OAAO;CACtF,CACF,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,yBAAyB;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,mDAAmD;IACnD,KAAK,EAAE,MAAM,CAAC;IACd,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yBAAyB;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,0BAA0B;IAC1B,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC,+FAA+F;IAC/F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2DAA2D;IAC3D,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,wEAAwE;IACxE,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,kEAAkE;IAClE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sDAAsD;IACtD,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,oDAAoD;IACpD,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB"}
+{"version":3,"file":"api.types.d.ts","sourceRoot":"","sources":["../../../../src/x-installer/api/api.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD;;;;;GAKG;AACH,MAAM,WAAW,IAAI;IACnB;;;;;;;OAOG;IACH,gBAAgB,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3C;;;;;OAKG;IACH,MAAM,CAAC,GAAG,EAAE,IAAI,GAAG,IAAI,CAAC;IAExB;;;;;;;OAOG;IACH,eAAe,CAAC,YAAY,EAAE,CAAC,MAAM,EAAE,aAAa,KAAK,IAAI,GAAG,IAAI,CAAC;IAErE;;;;;;OAMG;IACH,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;IAEvD;;;;;;OAMG;IACH,wBAAwB,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;IAEnF;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;;;;OAMG;IACH,IAAI,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC;CACnC;AAED;;;;GAIG;AACH,oBAAY,eAAe,GAAG,OAAO,CACnC;KACG,KAAK,IAAI,MAAM,GAAG,CAAC,OAAO,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,YAAY,KAAK,OAAO;CACtF,CACF,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,yBAAyB;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,mDAAmD;IACnD,KAAK,EAAE,MAAM,CAAC;IACd,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,yBAAyB;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,0BAA0B;IAC1B,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC,+FAA+F;IAC/F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2DAA2D;IAC3D,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,wEAAwE;IACxE,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,kEAAkE;IAClE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sDAAsD;IACtD,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,kCAAkC;IAClC,cAAc,CAAC,EAAE,YAAY,EAAE,CAAC;IAChC,oDAAoD;IACpD,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,mEAAmE;IACnE,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B"}

package/types/x-modules/extra-params/components/snippet-config-extra-params.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"snippet-config-extra-params.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/extra-params/components/snippet-config-extra-params.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAKA,OAAO,EAAW,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,GAAG,MAAM,KAAK,CAAC;AAGtB,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAInE;;;;;GAKG;AAKH,MAAM,CAAC,OAAO,OAAO,wBAAyB,SAAQ,GAAG;IACvD;;;;OAIG;IAEI,aAAa,EAAG,aAAa,CAAC;IAErC;;;;OAIG;IAEH,SAAS,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;IAEvC;;;;;;;OAOG;IACH,SAAS,CAAC,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,CAAM;IAEhD;;;;;OAKG;IAYH,SAAS,CAAC,mBAAmB,EAAG,KAAK,CAAC,MAAM,aAAa,CAAC,CAAC;IAE3D;;;;;;OAMG;IAEH,eAAe,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;CAQpD"}
+{"version":3,"file":"snippet-config-extra-params.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/extra-params/components/snippet-config-extra-params.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAKA,OAAO,EAAW,UAAU,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,GAAG,MAAM,KAAK,CAAC;AAGtB,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAInE;;;;;GAKG;AAKH,MAAM,CAAC,OAAO,OAAO,wBAAyB,SAAQ,GAAG;IACvD;;;;OAIG;IAEI,aAAa,EAAG,aAAa,CAAC;IAErC;;;;OAIG;IAEH,SAAS,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;IAEvC;;;;;;;OAOG;IACH,SAAS,CAAC,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,CAAM;IAEhD;;;;;OAKG;IAcH,SAAS,CAAC,mBAAmB,EAAG,KAAK,CAAC,MAAM,aAAa,CAAC,CAAC;IAE3D;;;;;;OAMG;IAEH,eAAe,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;CAOpD"}