@empathyco/x-components 4.1.0-alpha.21 → 4.1.0-alpha.23

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

@@ -191,6 +191,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [use$x()](./x-components.use_x.md) | Function which returns the <code>$x</code> object from the current component instance. |
 |  [useEmitDisplayEvent({ element, taggingRequest, eventMetadata })](./x-components.useemitdisplayevent.md) | Composable that emits a <code>TrackableElementDisplayed</code> event whenever the provided element appears in the viewport for the first time. |
 |  [useGetter(module, getters)](./x-components.usegetter.md) | Function which returns the requested getters as a dictionary of getters. |
+|  [useHybridInject(key, defaultValue)](./x-components.usehybridinject.md) | Function to use a hybrid inject, which allows to inject a value provided by the regular provide of vue or by the XProvide decorator. |
 |  [useNoElementRender(slots)](./x-components.usenoelementrender.md) | Returns a render function that returns the default slot or nothing if it's not defined. |
 |  [useOnDisplay({ element, callback, triggerOnce })](./x-components.useondisplay.md) | Composable that triggers a callback whenever the provided element appears in the viewport. It can trigger the first time only or every time the element appears in the viewport. |
 |  [useRegisterXModule(module)](./x-components.useregisterxmodule.md) | Initializes a component as an X-Component: \* Registers the module passed as parameter. \* Flags the component as X-Component, so then it can be detected with the [isXComponent()](./x-components.isxcomponent.md) function. |

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

@@ -4,7 +4,7 @@
 
 ## PreselectedFilters.created() method
 
-Emits the provided preselected filters prioritizing the [SnippetConfig](./x-components.snippetconfig.md) over the filters prop.
+Emits the [FacetsXEvents.PreselectedFiltersProvided](./x-components.facetsxevents.preselectedfiltersprovided.md) when the component is created.
 
 **Signature:**
 

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

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [PreselectedFilters](./x-components.preselectedfilters.md) &gt; [emitPreselectedFilters](./x-components.preselectedfilters.emitpreselectedfilters.md)
+
+## PreselectedFilters.emitPreselectedFilters() method
+
+Emits the [FacetsXEvents.PreselectedFiltersProvided](./x-components.facetsxevents.preselectedfiltersprovided.md) to save the provided filters in the state.
+
+**Signature:**
+
+```typescript
+protected emitPreselectedFilters(): void;
+```
+**Returns:**
+
+void
+

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

@@ -18,11 +18,13 @@ export default class PreselectedFilters extends Vue
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [filters](./x-components.preselectedfilters.filters.md) |  | string\[\] | A list of filters to preselect. |
+|  [preselectedFilters](./x-components.preselectedfilters.preselectedfilters.md) | <p><code>protected</code></p><p><code>readonly</code></p> | string\[\] | Gets the provided preselected filters prioritizing the [SnippetConfig](./x-components.snippetconfig.md) over the filters prop. |
 
 ## Methods
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [created()](./x-components.preselectedfilters.created.md) |  | Emits the provided preselected filters prioritizing the [SnippetConfig](./x-components.snippetconfig.md) over the filters prop. |
+|  [created()](./x-components.preselectedfilters.created.md) |  | Emits the [FacetsXEvents.PreselectedFiltersProvided](./x-components.facetsxevents.preselectedfiltersprovided.md) when the component is created. |
+|  [emitPreselectedFilters()](./x-components.preselectedfilters.emitpreselectedfilters.md) | <code>protected</code> | Emits the [FacetsXEvents.PreselectedFiltersProvided](./x-components.facetsxevents.preselectedfiltersprovided.md) to save the provided filters in the state. |
 |  [render()](./x-components.preselectedfilters.render.md) |  |  |
 

package/docs/API-reference/api/x-components.preselectedfilters.preselectedfilters.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; [PreselectedFilters](./x-components.preselectedfilters.md) &gt; [preselectedFilters](./x-components.preselectedfilters.preselectedfilters.md)
+
+## PreselectedFilters.preselectedFilters property
+
+Gets the provided preselected filters prioritizing the [SnippetConfig](./x-components.snippetconfig.md) over the filters prop.
+
+**Signature:**
+
+```typescript
+protected get preselectedFilters(): string[];
+```

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

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [useHybridInject](./x-components.usehybridinject.md)
+
+## useHybridInject() function
+
+Function to use a hybrid inject, which allows to inject a value provided by the regular provide of vue or by the XProvide decorator.
+
+**Signature:**
+
+```typescript
+export declare function useHybridInject<SomeValue>(key: string, defaultValue?: SomeValue): ComputedRef<SomeValue | undefined>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  key | string | The key of the value to inject. |
+|  defaultValue | SomeValue | _(Optional)_ The default value to use if the value is not provided. |
+
+**Returns:**
+
+ComputedRef&lt;SomeValue \| undefined&gt;
+
+The computed value of the injected value.
+

package/js/composables/use-hybrid-inject.js

@@ -0,0 +1,24 @@
+import { computed, inject } from 'vue';
+
+/**
+ * Function to use a hybrid inject, which allows to inject a value provided by the regular provide
+ * of vue or by the XProvide decorator.
+ *
+ * @param key - The key of the value to inject.
+ * @param defaultValue - The default value to use if the value is not provided.
+ * @returns The computed value of the injected value.
+ * @public
+ */
+function useHybridInject(key, defaultValue) {
+    return computed(() => {
+        const injectedValue = defaultValue
+            ? inject(key, defaultValue)
+            : inject(key);
+        return injectedValue && typeof injectedValue === 'object' && 'value' in injectedValue
+            ? injectedValue.value
+            : injectedValue;
+    });
+}
+
+export { useHybridInject };
+//# sourceMappingURL=use-hybrid-inject.js.map

package/js/composables/use-hybrid-inject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-hybrid-inject.js","sources":["../../../src/composables/use-hybrid-inject.ts"],"sourcesContent":["import { computed, ComputedRef, inject } from 'vue';\n\n/**\n * Function to use a hybrid inject, which allows to inject a value provided by the regular provide\n * of vue or by the XProvide decorator.\n *\n * @param key - The key of the value to inject.\n * @param defaultValue - The default value to use if the value is not provided.\n * @returns The computed value of the injected value.\n * @public\n */\nexport function useHybridInject<SomeValue>(\n  key: string,\n  defaultValue?: SomeValue\n): ComputedRef<SomeValue | undefined> {\n  type WrappedValue = { value: SomeValue };\n\n  return computed<SomeValue | undefined>(() => {\n    const injectedValue = defaultValue\n      ? inject<SomeValue | WrappedValue>(key, defaultValue)\n      : inject<SomeValue | WrappedValue>(key);\n\n    return injectedValue && typeof injectedValue === 'object' && 'value' in injectedValue\n      ? injectedValue.value\n      : injectedValue;\n  });\n}\n"],"names":[],"mappings":";;AAEA;;;;;;;;AAQG;AACa,SAAA,eAAe,CAC7B,GAAW,EACX,YAAwB,EAAA;IAIxB,OAAO,QAAQ,CAAwB,MAAK;QAC1C,MAAM,aAAa,GAAG,YAAY;AAChC,cAAE,MAAM,CAA2B,GAAG,EAAE,YAAY,CAAC;AACrD,cAAE,MAAM,CAA2B,GAAG,CAAC,CAAC;QAE1C,OAAO,aAAa,IAAI,OAAO,aAAa,KAAK,QAAQ,IAAI,OAAO,IAAI,aAAa;cACjF,aAAa,CAAC,KAAK;cACnB,aAAa,CAAC;AACpB,KAAC,CAAC,CAAC;AACL;;;;"}

package/js/index.js

@@ -155,6 +155,7 @@ export { useEmitDisplayEvent, useOnDisplay } from './composables/use-on-display.
 export { useStore } from './composables/use-store.js';
 export { useState } from './composables/use-state.js';
 export { useGetter } from './composables/use-getter.js';
+export { useHybridInject } from './composables/use-hybrid-inject.js';
 export { infiniteScroll } from './directives/infinite-scroll/infinite-scroll.js';
 export { setupDevtools } from './plugins/devtools/devtools.plugin.js';
 export { bus } from './plugins/x-bus.js';

package/js/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/js/x-modules/facets/components/preselected-filters.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"preselected-filters.vue.js","sources":["../../../../../src/x-modules/facets/components/preselected-filters.vue"],"sourcesContent":["<script lang=\"ts\">\n  import { Component, Inject, Prop } from 'vue-property-decorator';\n  import Vue from 'vue';\n  import { createRawFilters } from '../../../utils/filters';\n  import { isArrayEmpty } from '../../../utils/array';\n  import { SnippetConfig } from '../../../x-installer/api/api.types';\n\n  /**\n   * This component emits {@link FacetsXEvents.PreselectedFiltersProvided} when a preselected filter\n   * is set in the snippet config or by using the prop of the component.\n   *\n   * @public\n   */\n  @Component\n  export default class PreselectedFilters extends Vue {\n    /**\n     * Injects {@link SnippetConfig} provided by an ancestor as snippetConfig.\n     *\n     * @internal\n     */\n    @Inject()\n    public snippetConfig?: SnippetConfig;\n\n    /**\n     * A list of filters to preselect.\n     *\n     * @remarks Emits the {@link FacetsXEvents.PreselectedFiltersProvided} when the\n     * component is created.\n     *\n     * @public\n     */\n    @Prop({ default: () => [] })\n    public filters!: string[];\n\n    /**\n     * Emits the provided preselected filters prioritizing the {@link SnippetConfig} over the\n     * filters prop.\n     */\n    created(): void {\n      const preselectedFilters = this.snippetConfig?.filters ?? this.filters;\n      if (!isArrayEmpty(preselectedFilters)) {\n        this.$x.emit('PreselectedFiltersProvided', createRawFilters(preselectedFilters));\n      }\n    }\n\n    // eslint-disable-next-line @typescript-eslint/no-empty-function\n    render(): void {}\n  }\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n[`PreselectedFiltersProvided`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts).\n\n## See it in action\n\n_See how the event is triggered when the component is rendered._\n\n```vue\n<template>\n  <PreselectedFilters />\n</template>\n\n<script>\n  import { PreselectedFilters } from '@empathyco/x-components';\n  export default {\n    name: 'PreselectedFiltersDemo',\n    components: {\n      PreselectedFilters\n    },\n    provide: {\n      snippetConfig: {\n        filters: ['{!tag=brand_facet}brand_facet:\"Lego\"', '{!tag=age_facet}age_facet:\"toddler\"']\n      }\n    }\n  };\n</script>\n```\n\n### Play with props\n\nIn this example, the preselected filters have been configured to use a list of configured filters by\nprop:\n\n```vue\n<template>\n  <PreselectedFilters :filters=\"filters\" />\n</template>\n\n<script>\n  import { PreselectedFilters } from '@empathyco/x-components';\n  export default {\n    name: 'PreselectedFiltersDemo',\n    components: {\n      PreselectedFilters\n    },\n    computed: {\n      filters() {\n        return ['{!tag=brand_facet}brand_facet:\"Lego\"', '{!tag=age_facet}age_facet:\"toddler\"'];\n      }\n    }\n  };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;AAEA,MAAc,cAAA,GAAA,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"preselected-filters.vue.js","sources":["../../../../../src/x-modules/facets/components/preselected-filters.vue"],"sourcesContent":["<script lang=\"ts\">\n  import { Component, Inject, Prop, Watch } from 'vue-property-decorator';\n  import Vue from 'vue';\n  import { createRawFilters } from '../../../utils/filters';\n  import { isArrayEmpty } from '../../../utils/array';\n  import { SnippetConfig } from '../../../x-installer/api/api.types';\n\n  /**\n   * This component emits {@link FacetsXEvents.PreselectedFiltersProvided} when a preselected filter\n   * is set in the snippet config or by using the prop of the component.\n   *\n   * @public\n   */\n  @Component\n  export default class PreselectedFilters extends Vue {\n    /**\n     * Injects {@link SnippetConfig} provided by an ancestor as snippetConfig.\n     *\n     * @internal\n     */\n    @Inject('snippetConfig')\n    public snippetConfig?: SnippetConfig;\n\n    /**\n     * A list of filters to preselect.\n     *\n     * @remarks Emits the {@link FacetsXEvents.PreselectedFiltersProvided} when the\n     * component is created.\n     *\n     * @public\n     */\n    @Prop({ default: () => [] })\n    public filters!: string[];\n\n    /**\n     * Gets the provided preselected filters prioritizing the {@link SnippetConfig} over the\n     * filters prop.\n     *\n     * @returns An array of filter's ids.\n     */\n    protected get preselectedFilters(): string[] {\n      return this.snippetConfig?.filters ?? this.filters;\n    }\n\n    /**\n     * Emits the {@link FacetsXEvents.PreselectedFiltersProvided} to save\n     * the provided filters in the state.\n     */\n    @Watch('preselectedFilters')\n    protected emitPreselectedFilters(): void {\n      if (!isArrayEmpty(this.preselectedFilters)) {\n        this.$x.emit('PreselectedFiltersProvided', createRawFilters(this.preselectedFilters));\n      }\n    }\n\n    /**\n     * Emits the {@link FacetsXEvents.PreselectedFiltersProvided} when the\n     * component is created.\n     */\n    created(): void {\n      this.emitPreselectedFilters();\n    }\n\n    // eslint-disable-next-line @typescript-eslint/no-empty-function\n    render(): void {}\n  }\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n[`PreselectedFiltersProvided`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts).\n\n## See it in action\n\n_See how the event is triggered when the component is rendered._\n\n```vue\n<template>\n  <PreselectedFilters />\n</template>\n\n<script>\n  import { PreselectedFilters } from '@empathyco/x-components';\n  export default {\n    name: 'PreselectedFiltersDemo',\n    components: {\n      PreselectedFilters\n    },\n    provide: {\n      snippetConfig: {\n        filters: ['{!tag=brand_facet}brand_facet:\"Lego\"', '{!tag=age_facet}age_facet:\"toddler\"']\n      }\n    }\n  };\n</script>\n```\n\n### Play with props\n\nIn this example, the preselected filters have been configured to use a list of configured filters by\nprop:\n\n```vue\n<template>\n  <PreselectedFilters :filters=\"filters\" />\n</template>\n\n<script>\n  import { PreselectedFilters } from '@empathyco/x-components';\n  export default {\n    name: 'PreselectedFiltersDemo',\n    components: {\n      PreselectedFilters\n    },\n    computed: {\n      filters() {\n        return ['{!tag=brand_facet}brand_facet:\"Lego\"', '{!tag=age_facet}age_facet:\"toddler\"'];\n      }\n    }\n  };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;AAEA,MAAc,cAAA,GAAA,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/js/x-modules/facets/components/preselected-filters.vue2.js

@@ -1,5 +1,5 @@
 import { __decorate } from 'tslib';
-import { Inject, Prop, Component } from 'vue-property-decorator';
+import { Inject, Prop, Watch, Component } from 'vue-property-decorator';
 import Vue from 'vue';
 import { createRawFilters } from '../../../utils/filters.js';
 import { isArrayEmpty } from '../../../utils/array.js';
@@ -12,24 +12,42 @@ import { isArrayEmpty } from '../../../utils/array.js';
  */
 let PreselectedFilters = class PreselectedFilters extends Vue {
     /**
-     * Emits the provided preselected filters prioritizing the {@link SnippetConfig} over the
+     * Gets the provided preselected filters prioritizing the {@link SnippetConfig} over the
      * filters prop.
+     *
+     * @returns An array of filter's ids.
      */
-    created() {
-        const preselectedFilters = this.snippetConfig?.filters ?? this.filters;
-        if (!isArrayEmpty(preselectedFilters)) {
-            this.$x.emit('PreselectedFiltersProvided', createRawFilters(preselectedFilters));
+    get preselectedFilters() {
+        return this.snippetConfig?.filters ?? this.filters;
+    }
+    /**
+     * Emits the {@link FacetsXEvents.PreselectedFiltersProvided} to save
+     * the provided filters in the state.
+     */
+    emitPreselectedFilters() {
+        if (!isArrayEmpty(this.preselectedFilters)) {
+            this.$x.emit('PreselectedFiltersProvided', createRawFilters(this.preselectedFilters));
         }
     }
+    /**
+     * Emits the {@link FacetsXEvents.PreselectedFiltersProvided} when the
+     * component is created.
+     */
+    created() {
+        this.emitPreselectedFilters();
+    }
     // eslint-disable-next-line @typescript-eslint/no-empty-function
     render() { }
 };
 __decorate([
-    Inject()
+    Inject('snippetConfig')
 ], PreselectedFilters.prototype, "snippetConfig", void 0);
 __decorate([
     Prop({ default: () => [] })
 ], PreselectedFilters.prototype, "filters", void 0);
+__decorate([
+    Watch('preselectedFilters')
+], PreselectedFilters.prototype, "emitPreselectedFilters", null);
 PreselectedFilters = __decorate([
     Component
 ], PreselectedFilters);

package/js/x-modules/facets/components/preselected-filters.vue2.js.map

@@ -1 +1 @@
-{"version":3,"file":"preselected-filters.vue2.js","sources":["../../../../../src/x-modules/facets/components/preselected-filters.vue?rollup-plugin-vue=script.ts"],"sourcesContent":["\n  import { Component, Inject, Prop } from 'vue-property-decorator';\n  import Vue from 'vue';\n  import { createRawFilters } from '../../../utils/filters';\n  import { isArrayEmpty } from '../../../utils/array';\n  import { SnippetConfig } from '../../../x-installer/api/api.types';\n\n  /**\n   * This component emits {@link FacetsXEvents.PreselectedFiltersProvided} when a preselected filter\n   * is set in the snippet config or by using the prop of the component.\n   *\n   * @public\n   */\n  @Component\n  export default class PreselectedFilters extends Vue {\n    /**\n     * Injects {@link SnippetConfig} provided by an ancestor as snippetConfig.\n     *\n     * @internal\n     */\n    @Inject()\n    public snippetConfig?: SnippetConfig;\n\n    /**\n     * A list of filters to preselect.\n     *\n     * @remarks Emits the {@link FacetsXEvents.PreselectedFiltersProvided} when the\n     * component is created.\n     *\n     * @public\n     */\n    @Prop({ default: () => [] })\n    public filters!: string[];\n\n    /**\n     * Emits the provided preselected filters prioritizing the {@link SnippetConfig} over the\n     * filters prop.\n     */\n    created(): void {\n      const preselectedFilters = this.snippetConfig?.filters ?? this.filters;\n      if (!isArrayEmpty(preselectedFilters)) {\n        this.$x.emit('PreselectedFiltersProvided', createRawFilters(preselectedFilters));\n      }\n    }\n\n    // eslint-disable-next-line @typescript-eslint/no-empty-function\n    render(): void {}\n  }\n"],"names":[],"mappings":";;;;;;AAOE;;;;;AAKG;AAEY,IAAM,kBAAkB,GAAxB,MAAM,kBAAmB,SAAQ,GAAG,CAAA;AAoBjD;;;AAGG;IACH,OAAO,GAAA;QACL,MAAM,kBAAkB,GAAG,IAAI,CAAC,aAAa,EAAE,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;AACvE,QAAA,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,EAAE;AACrC,YAAA,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,4BAA4B,EAAE,gBAAgB,CAAC,kBAAkB,CAAC,CAAC,CAAC;AAClF,SAAA;KACF;;AAGD,IAAA,MAAM,MAAW;CAClB,CAAA;AA1BC,UAAA,CAAA;AADC,IAAA,MAAM,EAAE;AAC4B,CAAA,EAAA,kBAAA,CAAA,SAAA,EAAA,eAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAWrC,UAAA,CAAA;IADC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC;AACF,CAAA,EAAA,kBAAA,CAAA,SAAA,EAAA,SAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAlBP,kBAAkB,GAAA,UAAA,CAAA;IADtC,SAAS;AACW,CAAA,EAAA,kBAAkB,CAiCtC,CAAA;aAjCoB,kBAAkB;;;;"}
+{"version":3,"file":"preselected-filters.vue2.js","sources":["../../../../../src/x-modules/facets/components/preselected-filters.vue?rollup-plugin-vue=script.ts"],"sourcesContent":["\n  import { Component, Inject, Prop, Watch } from 'vue-property-decorator';\n  import Vue from 'vue';\n  import { createRawFilters } from '../../../utils/filters';\n  import { isArrayEmpty } from '../../../utils/array';\n  import { SnippetConfig } from '../../../x-installer/api/api.types';\n\n  /**\n   * This component emits {@link FacetsXEvents.PreselectedFiltersProvided} when a preselected filter\n   * is set in the snippet config or by using the prop of the component.\n   *\n   * @public\n   */\n  @Component\n  export default class PreselectedFilters extends Vue {\n    /**\n     * Injects {@link SnippetConfig} provided by an ancestor as snippetConfig.\n     *\n     * @internal\n     */\n    @Inject('snippetConfig')\n    public snippetConfig?: SnippetConfig;\n\n    /**\n     * A list of filters to preselect.\n     *\n     * @remarks Emits the {@link FacetsXEvents.PreselectedFiltersProvided} when the\n     * component is created.\n     *\n     * @public\n     */\n    @Prop({ default: () => [] })\n    public filters!: string[];\n\n    /**\n     * Gets the provided preselected filters prioritizing the {@link SnippetConfig} over the\n     * filters prop.\n     *\n     * @returns An array of filter's ids.\n     */\n    protected get preselectedFilters(): string[] {\n      return this.snippetConfig?.filters ?? this.filters;\n    }\n\n    /**\n     * Emits the {@link FacetsXEvents.PreselectedFiltersProvided} to save\n     * the provided filters in the state.\n     */\n    @Watch('preselectedFilters')\n    protected emitPreselectedFilters(): void {\n      if (!isArrayEmpty(this.preselectedFilters)) {\n        this.$x.emit('PreselectedFiltersProvided', createRawFilters(this.preselectedFilters));\n      }\n    }\n\n    /**\n     * Emits the {@link FacetsXEvents.PreselectedFiltersProvided} when the\n     * component is created.\n     */\n    created(): void {\n      this.emitPreselectedFilters();\n    }\n\n    // eslint-disable-next-line @typescript-eslint/no-empty-function\n    render(): void {}\n  }\n"],"names":[],"mappings":";;;;;;AAOE;;;;;AAKG;AAEY,IAAM,kBAAkB,GAAxB,MAAM,kBAAmB,SAAQ,GAAG,CAAA;AAoBjD;;;;;AAKG;AACH,IAAA,IAAc,kBAAkB,GAAA;QAC9B,OAAO,IAAI,CAAC,aAAa,EAAE,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;KACpD;AAED;;;AAGG;IAEO,sBAAsB,GAAA;AAC9B,QAAA,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE;AAC1C,YAAA,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,4BAA4B,EAAE,gBAAgB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC;AACvF,SAAA;KACF;AAED;;;AAGG;IACH,OAAO,GAAA;QACL,IAAI,CAAC,sBAAsB,EAAE,CAAC;KAC/B;;AAGD,IAAA,MAAM,MAAW;CAClB,CAAA;AA5CC,UAAA,CAAA;IADC,MAAM,CAAC,eAAe,CAAC;AACa,CAAA,EAAA,kBAAA,CAAA,SAAA,EAAA,eAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAWrC,UAAA,CAAA;IADC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC;AACF,CAAA,EAAA,kBAAA,CAAA,SAAA,EAAA,SAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAiB1B,UAAA,CAAA;IADC,KAAK,CAAC,oBAAoB,CAAC;AAK3B,CAAA,EAAA,kBAAA,CAAA,SAAA,EAAA,wBAAA,EAAA,IAAA,CAAA,CAAA;AAvCkB,kBAAkB,GAAA,UAAA,CAAA;IADtC,SAAS;AACW,CAAA,EAAA,kBAAkB,CAmDtC,CAAA;aAnDoB,kBAAkB;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empathyco/x-components",
-  "version": "4.1.0-alpha.21",
+  "version": "4.1.0-alpha.23",
   "description": "Empathy X Components",
   "author": "Empathy Systems Corporation S.L.",
   "license": "Apache-2.0",
@@ -143,5 +143,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "fb1f2f29e0ab2fcbc6c32bd89450cee79aa985c4"
+  "gitHead": "ae3bb29c745057c0b50dc3ee0d96b79c2297305e"
 }

package/report/x-components.api.json

@@ -37605,7 +37605,7 @@
             {
               "kind": "Method",
               "canonicalReference": "@empathyco/x-components!PreselectedFilters#created:member(1)",
-              "docComment": "/**\n * Emits the provided preselected filters prioritizing the {@link SnippetConfig} over the filters prop.\n */\n",
+              "docComment": "/**\n * Emits the {@link FacetsXEvents.PreselectedFiltersProvided} when the component is created.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -37633,6 +37633,37 @@
               "isAbstract": false,
               "name": "created"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@empathyco/x-components!PreselectedFilters#emitPreselectedFilters:member(1)",
+              "docComment": "/**\n * Emits the {@link FacetsXEvents.PreselectedFiltersProvided} to save the provided filters in the state.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected emitPreselectedFilters(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": true,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "emitPreselectedFilters"
+            },
             {
               "kind": "Property",
               "canonicalReference": "@empathyco/x-components!PreselectedFilters#filters:member",
@@ -37663,6 +37694,36 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@empathyco/x-components!PreselectedFilters#preselectedFilters:member",
+              "docComment": "/**\n * Gets the provided preselected filters prioritizing the {@link SnippetConfig} over the filters prop.\n *\n * @returns An array of filter's ids.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected get preselectedFilters(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "preselectedFilters",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": true,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "@empathyco/x-components!PreselectedFilters#render:member(1)",
@@ -63676,6 +63737,85 @@
           ],
           "name": "useGetter"
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@empathyco/x-components!useHybridInject:function(1)",
+          "docComment": "/**\n * Function to use a hybrid inject, which allows to inject a value provided by the regular provide of vue or by the XProvide decorator.\n *\n * @param key - The key of the value to inject.\n *\n * @param defaultValue - The default value to use if the value is not provided.\n *\n * @returns The computed value of the injected value.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function useHybridInject<SomeValue>(key: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ", defaultValue?: "
+            },
+            {
+              "kind": "Content",
+              "text": "SomeValue"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "ComputedRef",
+              "canonicalReference": "vue!ComputedRef:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<SomeValue | undefined>"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/composables/use-hybrid-inject.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 7
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "key",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            },
+            {
+              "parameterName": "defaultValue",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": true
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "SomeValue",
+              "constraintTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "useHybridInject"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@empathyco/x-components!useNoElementRender:function(1)",

package/report/x-components.api.md

@@ -3554,7 +3554,9 @@ export const popularSearchesXStoreModule: PopularSearchesXStoreModule;
 // @public
 export class PreselectedFilters extends Vue_2 {
     created(): void;
+    protected emitPreselectedFilters(): void;
     filters: string[];
+    protected get preselectedFilters(): string[];
     // (undocumented)
     render(): void;
     // @internal
@@ -6163,6 +6165,9 @@ export function useEmitDisplayEvent({ element, taggingRequest, eventMetadata }:
 // @public
 export function useGetter<Module extends XModuleName, GetterName extends keyof ExtractGetters<Module> & string>(module: Module, getters: GetterName[]): Dictionary<ComputedRef<GetterName[]>>;
 
+// @public
+export function useHybridInject<SomeValue>(key: string, defaultValue?: SomeValue): ComputedRef<SomeValue | undefined>;
+
 // @public
 export function useNoElementRender(slots: {
     [key: string]: VNode_2[] | undefined;

package/types/composables/index.d.ts

@@ -6,4 +6,5 @@ export * from './use-on-display';
 export * from './use-store';
 export * from './use-state';
 export * from './use-getter';
+export * from './use-hybrid-inject';
 //# sourceMappingURL=index.d.ts.map

package/types/composables/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/composables/index.ts"],"names":[],"mappings":"AAAA,cAAc,gCAAgC,CAAC;AAC/C,cAAc,yBAAyB,CAAC;AACxC,cAAc,UAAU,CAAC;AACzB,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/composables/index.ts"],"names":[],"mappings":"AAAA,cAAc,gCAAgC,CAAC;AAC/C,cAAc,yBAAyB,CAAC;AACxC,cAAc,UAAU,CAAC;AACzB,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC"}

package/types/composables/use-hybrid-inject.d.ts

@@ -0,0 +1,12 @@
+import { ComputedRef } from 'vue';
+/**
+ * Function to use a hybrid inject, which allows to inject a value provided by the regular provide
+ * of vue or by the XProvide decorator.
+ *
+ * @param key - The key of the value to inject.
+ * @param defaultValue - The default value to use if the value is not provided.
+ * @returns The computed value of the injected value.
+ * @public
+ */
+export declare function useHybridInject<SomeValue>(key: string, defaultValue?: SomeValue): ComputedRef<SomeValue | undefined>;
+//# sourceMappingURL=use-hybrid-inject.d.ts.map

package/types/composables/use-hybrid-inject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-hybrid-inject.d.ts","sourceRoot":"","sources":["../../../src/composables/use-hybrid-inject.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,WAAW,EAAU,MAAM,KAAK,CAAC;AAEpD;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,SAAS,EACvC,GAAG,EAAE,MAAM,EACX,YAAY,CAAC,EAAE,SAAS,GACvB,WAAW,CAAC,SAAS,GAAG,SAAS,CAAC,CAYpC"}

package/types/x-modules/facets/components/preselected-filters.vue.d.ts

@@ -23,8 +23,20 @@ export default class PreselectedFilters extends Vue {
      */
     filters: string[];
     /**
-     * Emits the provided preselected filters prioritizing the {@link SnippetConfig} over the
+     * Gets the provided preselected filters prioritizing the {@link SnippetConfig} over the
      * filters prop.
+     *
+     * @returns An array of filter's ids.
+     */
+    protected get preselectedFilters(): string[];
+    /**
+     * Emits the {@link FacetsXEvents.PreselectedFiltersProvided} to save
+     * the provided filters in the state.
+     */
+    protected emitPreselectedFilters(): void;
+    /**
+     * Emits the {@link FacetsXEvents.PreselectedFiltersProvided} when the
+     * component is created.
      */
     created(): void;
     render(): void;

package/types/x-modules/facets/components/preselected-filters.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"preselected-filters.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/facets/components/preselected-filters.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAEE,OAAO,GAAG,MAAM,KAAK,CAAC;AAGtB,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAEnE;;;;;GAKG;AAEH,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,GAAG;IACjD;;;;OAIG;IAEI,aAAa,CAAC,EAAE,aAAa,CAAC;IAErC;;;;;;;OAOG;IAEI,OAAO,EAAG,MAAM,EAAE,CAAC;IAE1B;;;OAGG;IACH,OAAO,IAAI,IAAI;IAQf,MAAM,IAAI,IAAI;CACf"}
+{"version":3,"file":"preselected-filters.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/facets/components/preselected-filters.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAEE,OAAO,GAAG,MAAM,KAAK,CAAC;AAGtB,OAAO,EAAE,aAAa,EAAE,MAAM,oCAAoC,CAAC;AAEnE;;;;;GAKG;AAEH,MAAM,CAAC,OAAO,OAAO,kBAAmB,SAAQ,GAAG;IACjD;;;;OAIG;IAEI,aAAa,CAAC,EAAE,aAAa,CAAC;IAErC;;;;;;;OAOG;IAEI,OAAO,EAAG,MAAM,EAAE,CAAC;IAE1B;;;;;OAKG;IACH,SAAS,KAAK,kBAAkB,IAAI,MAAM,EAAE,CAE3C;IAED;;;OAGG;IAEH,SAAS,CAAC,sBAAsB,IAAI,IAAI;IAMxC;;;OAGG;IACH,OAAO,IAAI,IAAI;IAKf,MAAM,IAAI,IAAI;CACf"}