@empathyco/x-components 5.0.0-alpha.9 → 6.0.0-alpha.2

package/js/x-modules/queries-preview/components/query-preview-list.vue.js

@@ -1,88 +1,54 @@
-import script from './query-preview-list.vue2.js';
-import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.mjs';
+import _sfc_main from './query-preview-list.vue2.js';
+import { resolveComponent, openBlock, createBlock, resolveDynamicComponent, withCtx, createElementBlock, Fragment, renderList, createVNode, createSlots, renderSlot, mergeProps } from 'vue';
+import _export_sfc from '../../../_virtual/_plugin-vue_export-helper.js';
 
-/* script */
-const __vue_script__ = script;
+function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
+  const _component_QueryPreview = resolveComponent("QueryPreview");
+  return openBlock(), createBlock(resolveDynamicComponent(_ctx.animation), {
+    class: "x-query-preview-list",
+    tag: "ul"
+  }, {
+    default: withCtx(() => [
+      (openBlock(true), createElementBlock(
+        Fragment,
+        null,
+        renderList(_ctx.renderedQueryPreviews, (queryPreview, index) => {
+          return openBlock(), createElementBlock("li", {
+            key: index,
+            "data-test": "query-preview-item"
+          }, [
+            createVNode(_component_QueryPreview, {
+              onLoad: _ctx.flagAsLoaded,
+              onError: _ctx.flagAsFailed,
+              debounceTimeMs: _ctx.debounceTimeMs,
+              maxItemsToRender: _ctx.maxItemsToRender,
+              persistInCache: _ctx.persistInCache,
+              queryFeature: _ctx.queryFeature,
+              queryPreviewInfo: queryPreview
+            }, createSlots({
+              _: 2
+              /* DYNAMIC */
+            }, [
+              renderList(_ctx.$slots, (_, slotName) => {
+                return {
+                  name: slotName,
+                  fn: withCtx((scope) => [
+                    renderSlot(_ctx.$slots, slotName, mergeProps({ ref_for: true }, scope))
+                  ])
+                };
+              })
+            ]), 1032, ["onLoad", "onError", "debounceTimeMs", "maxItemsToRender", "persistInCache", "queryFeature", "queryPreviewInfo"])
+          ]);
+        }),
+        128
+        /* KEYED_FRAGMENT */
+      ))
+    ]),
+    _: 3
+    /* FORWARDED */
+  });
+}
+var queryPreviewList = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
 
-/* template */
-var __vue_render__ = function () {
-  var _vm = this;
-  var _h = _vm.$createElement;
-  var _c = _vm._self._c || _h;
-  return _c(
-    _vm.animation,
-    {
-      tag: "component",
-      staticClass: "x-query-preview-list",
-      attrs: { tag: "ul" },
-    },
-    _vm._l(_vm.renderedQueryPreviews, function (queryPreview, index) {
-      return _c(
-        "li",
-        { key: index, attrs: { "data-test": "query-preview-item" } },
-        [
-          _c("QueryPreview", {
-            attrs: {
-              debounceTimeMs: _vm.debounceTimeMs,
-              maxItemsToRender: _vm.maxItemsToRender,
-              persistInCache: _vm.persistInCache,
-              queryFeature: _vm.queryFeature,
-              queryPreviewInfo: queryPreview,
-            },
-            on: { load: _vm.flagAsLoaded, error: _vm.flagAsFailed },
-            scopedSlots: _vm._u(
-              [
-                _vm._l(_vm.renderSlots, function (_, slotName) {
-                  return {
-                    key: slotName,
-                    fn: function (scope) {
-                      return [_vm._t(slotName, null, null, scope)]
-                    },
-                  }
-                }),
-              ],
-              null,
-              true
-            ),
-          }),
-        ],
-        1
-      )
-    }),
-    0
-  )
-};
-var __vue_staticRenderFns__ = [];
-__vue_render__._withStripped = true;
-
-  /* style */
-  const __vue_inject_styles__ = undefined;
-  /* scoped */
-  const __vue_scope_id__ = undefined;
-  /* module identifier */
-  const __vue_module_identifier__ = undefined;
-  /* functional template */
-  const __vue_is_functional_template__ = false;
-  /* style inject */
-  
-  /* style inject SSR */
-  
-  /* style inject shadow dom */
-  
-
-  
-  const __vue_component__ = /*#__PURE__*/__vue_normalize__(
-    { render: __vue_render__, staticRenderFns: __vue_staticRenderFns__ },
-    __vue_inject_styles__,
-    __vue_script__,
-    __vue_scope_id__,
-    __vue_is_functional_template__,
-    __vue_module_identifier__,
-    false,
-    undefined,
-    undefined,
-    undefined
-  );
-
-export { __vue_component__ as default };
+export { queryPreviewList as default };
 //# sourceMappingURL=query-preview-list.vue.js.map

package/js/x-modules/queries-preview/components/query-preview-list.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"query-preview-list.vue.js","sources":["../../../../../src/x-modules/queries-preview/components/query-preview-list.vue"],"sourcesContent":["<template>\n  <component :is=\"animation\" class=\"x-query-preview-list\" tag=\"ul\">\n    <li\n      v-for=\"(queryPreview, index) in renderedQueryPreviews\"\n      :key=\"index\"\n      data-test=\"query-preview-item\"\n    >\n      <QueryPreview\n        @load=\"flagAsLoaded\"\n        @error=\"flagAsFailed\"\n        :debounceTimeMs=\"debounceTimeMs\"\n        :maxItemsToRender=\"maxItemsToRender\"\n        :persistInCache=\"persistInCache\"\n        :queryFeature=\"queryFeature\"\n        :queryPreviewInfo=\"queryPreview\"\n      >\n        <template v-for=\"(_, slotName) in renderSlots\" v-slot:[slotName]=\"scope\">\n          <slot :name=\"slotName\" v-bind=\"scope\" />\n        </template>\n      </QueryPreview>\n    </li>\n  </component>\n</template>\n\n<script lang=\"ts\">\n  import Vue, { computed, defineComponent, PropType, ref, watch } from 'vue';\n  import { RequestStatus } from '../../../store';\n  import { queriesPreviewXModule } from '../x-module';\n  import { QueryPreviewInfo } from '../store/types';\n  import { getHashFromQueryPreviewInfo } from '../utils/get-hash-from-query-preview';\n  import { AnimationProp, QueryFeature } from '../../../types';\n  import { useRegisterXModule } from '../../../composables/use-register-x-module';\n  import QueryPreview from './query-preview.vue';\n\n  interface QueryPreviewStatusRecord {\n    [query: string]: RequestStatus;\n  }\n\n  /**\n   * Renders the results previews of a list of objects with the information about the query preview,\n   * and exposes the {@link QueryPreview} slots to modify the content.\n   * The requests are made in sequential order.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'QueryPreviewList',\n    xModule: queriesPreviewXModule.name,\n    components: { QueryPreview },\n    props: {\n      /**\n       * The list of queries preview to render.\n       *\n       * @public\n       */\n      queriesPreviewInfo: {\n        type: Array as PropType<QueryPreviewInfo[]>,\n        required: true\n      },\n      /**\n       * The origin property for the request on each query preview.\n       *\n       * @public\n       */\n      queryFeature: {\n        type: String as PropType<QueryFeature>\n      },\n      /**\n       * Number of query preview results to be rendered on each query preview.\n       *\n       * @public\n       */\n      maxItemsToRender: {\n        type: Number\n      },\n      /**\n       * Debounce time in milliseconds for triggering the search requests\n       * on each query preview.\n       * It will default to 0 to fit the most common use case (pre-search),\n       * and it would work properly with a 250 value inside empathize.\n       */\n      debounceTimeMs: {\n        type: Number,\n        default: 0\n      },\n      /**\n       * Controls whether all the QueryPreview should be removed from the state\n       * when the component is destroyed.\n       *\n       * @public\n       */\n      persistInCache: Boolean,\n      /**\n       * Animation component that will be used to animate the elements.\n       *\n       * @public\n       */\n      animation: {\n        type: AnimationProp,\n        default: 'ul'\n      }\n    },\n    setup(props, { slots }) {\n      useRegisterXModule(queriesPreviewXModule);\n\n      const renderSlots = slots;\n\n      /**\n       * Contains the status of the preview requests, indexed by query.\n       */\n      let queriesStatus = ref<QueryPreviewStatusRecord>({});\n\n      /**\n       * The list of queries to preview.\n       *\n       * @returns The list of queries in the queriesPreviewInfo list.\n       * @internal\n       */\n      const queries = computed((): string[] =>\n        props.queriesPreviewInfo.map(item => getHashFromQueryPreviewInfo(item))\n      );\n\n      /**\n       * Gets all the queries to render, that are those that don't have an `error` status.\n       *\n       * @returns A list of queries.\n       * @internal\n       */\n      const renderedQueryPreviews = computed((): QueryPreviewInfo[] => {\n        return props.queriesPreviewInfo.filter(item => {\n          const queryPreviewHash = getHashFromQueryPreviewInfo(item);\n          return (\n            queriesStatus.value[queryPreviewHash] === 'success' ||\n            queriesStatus.value[queryPreviewHash] === 'loading'\n          );\n        });\n      });\n\n      /**\n       * Tries to load the next query.\n       *\n       * @internal\n       */\n      const loadNext = (): void => {\n        const queryToLoad = queries.value.find(query => !(query in queriesStatus.value));\n        if (queryToLoad) {\n          //TODO - change this logic when we migrate to vue@3. It won't be necessary. Check this link https://v2.vuejs.org/v2/guide/migration-vue-2-7#Behavior-Differences-from-Vue-3\n          Vue.set(queriesStatus.value, queryToLoad, 'loading');\n        }\n      };\n\n      /**\n       * Resets the status of all queries if they change.\n       *\n       * @param newQueries - The new queries.\n       * @param oldQueries - The old queries.\n       * @internal\n       */\n      watch(\n        queries,\n        (newQueries: string[], oldQueries: string[] | undefined) => {\n          if (newQueries.toString() !== oldQueries?.toString()) {\n            queriesStatus.value = {};\n            loadNext();\n          }\n        },\n        { immediate: true, deep: true }\n      );\n\n      /**\n       * Sets the status of a given query to `success`.\n       *\n       * @param loadedQuery - The query to flag as loaded.\n       * @internal\n       */\n      const flagAsLoaded = (loadedQuery: string): void => {\n        queriesStatus.value[loadedQuery] = 'success';\n        loadNext();\n      };\n\n      /**\n       * Sets the status of a given query to `error`.\n       *\n       * @param failedQuery - The query to flag as failed.\n       * @internal\n       */\n      const flagAsFailed = (failedQuery: string): void => {\n        queriesStatus.value[failedQuery] = 'error';\n        loadNext();\n      };\n\n      return {\n        renderedQueryPreviews,\n        flagAsFailed,\n        flagAsLoaded,\n        renderSlots\n      };\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## See it in action\n\nHere you have a basic example of how the QueryPreviewList is rendered. Keep in mind that this\ncomponent is intended to be used overriding its default slot. By default it will only render the\nnames of the results.\n\n```vue live\n<template>\n  <QueryPreviewList :queriesPreviewInfo=\"queriesPreviewInfo\" />\n</template>\n\n<script>\n  import { QueryPreviewList } from '@empathyco/x-components/queries-preview';\n\n  export default {\n    name: 'QueryPreviewListDemo',\n    components: {\n      QueryPreviewList\n    },\n    data() {\n      return {\n        queriesPreviewInfo: [{ query: 'sandals' }, { query: 'tshirt' }, { query: 'jacket' }]\n      };\n    }\n  };\n</script>\n```\n\n### Play with the default slot\n\nIn this example, the results will be rendered inside a sliding panel.\n\n```vue live\n<template>\n  <QueryPreviewList\n    :queriesPreviewInfo=\"queriesPreviewInfo\"\n    #default=\"{ queryPreviewInfo, totalResults, results }\"\n  >\n    <div class=\"x-flex x-flex-col x-gap-8 x-mb-16\">\n      <h1 class=\"x-title2\">{{ queryPreviewInfo.query }} ({{ totalResults }})</h1>\n      <SlidingPanel :resetOnContentChange=\"false\">\n        <div class=\"x-flex x-gap-8\">\n          <Result\n            v-for=\"result in results\"\n            :key=\"result.id\"\n            :result=\"result\"\n            style=\"max-width: 180px\"\n          />\n        </div>\n      </SlidingPanel>\n    </div>\n  </QueryPreviewList>\n</template>\n\n<script>\n  import { QueryPreviewList } from '@empathyco/x-components/queries-preview';\n  import { BaseResultImage, BaseResultLink, SlidingPanel } from '@empathyco/x-components';\n\n  export default {\n    name: 'QueryPreviewListDemoOverridingSlot',\n    components: {\n      BaseResultImage,\n      BaseResultLink,\n      QueryPreviewList,\n      SlidingPanel\n    },\n    data() {\n      return {\n        queriesPreviewInfo: [{ query: 'sandals' }, { query: 'tshirt' }, { query: 'jacket' }]\n      };\n    }\n  };\n</script>\n```\n\n### Play with the result slot\n\nThe component exposes a slot to override the result content, without modifying the list.\n\nIn this example, the ID of the results will be rendered along with the name.\n\n```vue\n<template>\n  <QueryPreviewList\n    class=\"x-flex x-gap-8\"\n    :queriesPreviewInfo=\"queriesPreviewInfo\"\n    #result=\"{ result }\"\n  >\n    <span class=\"x-font-bold\">{{ result.id }}:</span>\n    <span>{{ result.name }}</span>\n  </QueryPreviewList>\n</template>\n\n<script>\n  import { QueryPreviewList } from '@empathyco/x-components/queries-preview';\n\n  export default {\n    name: 'QueryPreviewListDemoOverridingResultSlot',\n    components: {\n      QueryPreviewList\n    },\n    data() {\n      return {\n        queriesPreviewInfo: [{ query: 'sandals' }, { query: 'tshirt' }, { query: 'jacket' }]\n      };\n    }\n  };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;AAEA,MAAc,cAAA,GAAA,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"query-preview-list.vue.js","sources":["../../../../../src/x-modules/queries-preview/components/query-preview-list.vue"],"sourcesContent":["<template>\n  <component :is=\"animation\" class=\"x-query-preview-list\" tag=\"ul\">\n    <li\n      v-for=\"(queryPreview, index) in renderedQueryPreviews\"\n      :key=\"index\"\n      data-test=\"query-preview-item\"\n    >\n      <QueryPreview\n        @load=\"flagAsLoaded\"\n        @error=\"flagAsFailed\"\n        :debounceTimeMs=\"debounceTimeMs\"\n        :maxItemsToRender=\"maxItemsToRender\"\n        :persistInCache=\"persistInCache\"\n        :queryFeature=\"queryFeature\"\n        :queryPreviewInfo=\"queryPreview\"\n      >\n        <template v-for=\"(_, slotName) in $slots\" v-slot:[slotName]=\"scope\">\n          <slot :name=\"slotName\" v-bind=\"scope\" />\n        </template>\n      </QueryPreview>\n    </li>\n  </component>\n</template>\n\n<script lang=\"ts\">\n  import { computed, defineComponent, PropType, ref, watch } from 'vue';\n  import { RequestStatus } from '../../../store';\n  import { queriesPreviewXModule } from '../x-module';\n  import { QueryPreviewInfo } from '../store/types';\n  import { getHashFromQueryPreviewInfo } from '../utils/get-hash-from-query-preview';\n  import { AnimationProp, QueryFeature } from '../../../types';\n  import QueryPreview from './query-preview.vue';\n\n  interface QueryPreviewStatusRecord {\n    [query: string]: RequestStatus;\n  }\n\n  /**\n   * Renders the results previews of a list of objects with the information about the query preview,\n   * and exposes the {@link QueryPreview} slots to modify the content.\n   * The requests are made in sequential order.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'QueryPreviewList',\n    xModule: queriesPreviewXModule.name,\n    components: { QueryPreview },\n    props: {\n      /**\n       * The list of queries preview to render.\n       *\n       * @public\n       */\n      queriesPreviewInfo: {\n        type: Array as PropType<QueryPreviewInfo[]>,\n        required: true\n      },\n      /**\n       * The origin property for the request on each query preview.\n       *\n       * @public\n       */\n      queryFeature: {\n        type: String as PropType<QueryFeature>\n      },\n      /**\n       * Number of query preview results to be rendered on each query preview.\n       *\n       * @public\n       */\n      maxItemsToRender: {\n        type: Number\n      },\n      /**\n       * Debounce time in milliseconds for triggering the search requests\n       * on each query preview.\n       * It will default to 0 to fit the most common use case (pre-search),\n       * and it would work properly with a 250 value inside empathize.\n       */\n      debounceTimeMs: {\n        type: Number,\n        default: 0\n      },\n      /**\n       * Controls whether all the QueryPreview should be removed from the state\n       * when the component is destroyed.\n       *\n       * @public\n       */\n      persistInCache: Boolean,\n      /**\n       * Animation component that will be used to animate the elements.\n       *\n       * @public\n       */\n      animation: {\n        type: AnimationProp,\n        default: 'ul'\n      }\n    },\n    setup(props) {\n      /**\n       * Contains the status of the preview requests, indexed by query.\n       */\n      let queriesStatus = ref<QueryPreviewStatusRecord>({});\n\n      /**\n       * The list of queries to preview.\n       *\n       * @returns The list of queries in the queriesPreviewInfo list.\n       * @internal\n       */\n      const queries = computed((): string[] =>\n        props.queriesPreviewInfo.map(item => getHashFromQueryPreviewInfo(item))\n      );\n\n      /**\n       * Gets all the queries to render, that are those that don't have an `error` status.\n       *\n       * @returns A list of queries.\n       * @internal\n       */\n      const renderedQueryPreviews = computed((): QueryPreviewInfo[] => {\n        return props.queriesPreviewInfo.filter(item => {\n          const queryPreviewHash = getHashFromQueryPreviewInfo(item);\n          return (\n            queriesStatus.value[queryPreviewHash] === 'success' ||\n            queriesStatus.value[queryPreviewHash] === 'loading'\n          );\n        });\n      });\n\n      /**\n       * Tries to load the next query.\n       *\n       * @internal\n       */\n      const loadNext = (): void => {\n        const queryToLoad = queries.value.find(query => !(query in queriesStatus.value));\n        if (queryToLoad) {\n          queriesStatus.value[queryToLoad] = 'loading';\n        }\n      };\n\n      /**\n       * Resets the status of all queries if they change.\n       *\n       * @param newQueries - The new queries.\n       * @param oldQueries - The old queries.\n       * @internal\n       */\n      watch(\n        queries,\n        (newQueries: string[], oldQueries: string[] | undefined) => {\n          if (newQueries.toString() !== oldQueries?.toString()) {\n            for (const key of Object.keys(queriesStatus.value)) {\n              if (!newQueries.includes(key)) {\n                delete queriesStatus.value[key];\n              }\n            }\n            loadNext();\n          }\n        },\n        { immediate: true, deep: true }\n      );\n\n      /**\n       * Sets the status of a given query to `success`.\n       *\n       * @param loadedQuery - The query to flag as loaded.\n       * @internal\n       */\n      const flagAsLoaded = (loadedQuery: string): void => {\n        queriesStatus.value[loadedQuery] = 'success';\n        loadNext();\n      };\n\n      /**\n       * Sets the status of a given query to `error`.\n       *\n       * @param failedQuery - The query to flag as failed.\n       * @internal\n       */\n      const flagAsFailed = (failedQuery: string): void => {\n        queriesStatus.value[failedQuery] = 'error';\n        loadNext();\n      };\n\n      return {\n        renderedQueryPreviews,\n        flagAsFailed,\n        flagAsLoaded\n      };\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## See it in action\n\nHere you have a basic example of how the QueryPreviewList is rendered. Keep in mind that this\ncomponent is intended to be used overriding its default slot. By default it will only render the\nnames of the results.\n\n```vue live\n<template>\n  <QueryPreviewList :queriesPreviewInfo=\"queriesPreviewInfo\" />\n</template>\n\n<script>\n  import { QueryPreviewList } from '@empathyco/x-components/queries-preview';\n\n  export default {\n    name: 'QueryPreviewListDemo',\n    components: {\n      QueryPreviewList\n    },\n    data() {\n      return {\n        queriesPreviewInfo: [{ query: 'sandals' }, { query: 'tshirt' }, { query: 'jacket' }]\n      };\n    }\n  };\n</script>\n```\n\n### Play with the default slot\n\nIn this example, the results will be rendered inside a sliding panel.\n\n```vue live\n<template>\n  <QueryPreviewList\n    :queriesPreviewInfo=\"queriesPreviewInfo\"\n    #default=\"{ queryPreviewInfo, totalResults, results }\"\n  >\n    <div class=\"x-flex x-flex-col x-gap-8 x-mb-16\">\n      <h1 class=\"x-title2\">{{ queryPreviewInfo.query }} ({{ totalResults }})</h1>\n      <SlidingPanel :resetOnContentChange=\"false\">\n        <div class=\"x-flex x-gap-8\">\n          <Result\n            v-for=\"result in results\"\n            :key=\"result.id\"\n            :result=\"result\"\n            style=\"max-width: 180px\"\n          />\n        </div>\n      </SlidingPanel>\n    </div>\n  </QueryPreviewList>\n</template>\n\n<script>\n  import { QueryPreviewList } from '@empathyco/x-components/queries-preview';\n  import { BaseResultImage, BaseResultLink, SlidingPanel } from '@empathyco/x-components';\n\n  export default {\n    name: 'QueryPreviewListDemoOverridingSlot',\n    components: {\n      BaseResultImage,\n      BaseResultLink,\n      QueryPreviewList,\n      SlidingPanel\n    },\n    data() {\n      return {\n        queriesPreviewInfo: [{ query: 'sandals' }, { query: 'tshirt' }, { query: 'jacket' }]\n      };\n    }\n  };\n</script>\n```\n\n### Play with the result slot\n\nThe component exposes a slot to override the result content, without modifying the list.\n\nIn this example, the ID of the results will be rendered along with the name.\n\n```vue\n<template>\n  <QueryPreviewList\n    class=\"x-flex x-gap-8\"\n    :queriesPreviewInfo=\"queriesPreviewInfo\"\n    #result=\"{ result }\"\n  >\n    <span class=\"x-font-bold\">{{ result.id }}:</span>\n    <span>{{ result.name }}</span>\n  </QueryPreviewList>\n</template>\n\n<script>\n  import { QueryPreviewList } from '@empathyco/x-components/queries-preview';\n\n  export default {\n    name: 'QueryPreviewListDemoOverridingResultSlot',\n    components: {\n      QueryPreviewList\n    },\n    data() {\n      return {\n        queriesPreviewInfo: [{ query: 'sandals' }, { query: 'tshirt' }, { query: 'jacket' }]\n      };\n    }\n  };\n</script>\n```\n</docs>\n"],"names":["_resolveComponent","animation","_openBlock","_createBlock","_resolveDynamicComponent","_createElementBlock","_Fragment","_renderList","flagAsFailed","persistInCache","queryFeature","$slots","_withCtx"],"mappings":";;;;;AACE,EAAA,MAAA,uBAAA,GAAAA,gBAAA,CADF,cACkBC,CAAAA,CAAAA;SAA4CC,SAAI,EAAA,EAAAC,WAAA,CAAAC,uBAAA,CAAA,IAAA,CAAA,SAAA,CAAA,EAAA;AAAA,IAAA,KAAA,EAAA,sBAAA;AADlE,IAAA,GAAA,EAAA,IAAA;AAAA,GAAA,EAAA;;iBAIY,IAAK,CAAA,EAAAC,kBAAA;AAAA,QAAAC,QAAA;AAAA,QAAA,IAAA;AAAA,QAAAC,UAAA,CAAA,IAAA,CAAA,qBAAA,EAAA,CAAA,YAAA,EAAA,KAAA,KAAA;AACX,UAAA,OAAAL,SAAA,EAA8B,EAAAG,kBAAA,CAAA,IAAA,EAAA;AAAA,YAAA,GAAA,EAAA,KAAA;YAE9B,WAYe,EAAA,oBAAA;AAAA,WAAA,EAAA;wBAVLG,uBAAY,EAAA;AAAA,cACnB,MAAA,EAAA,IAAA,CAAA,YAAA;AAAA,cACA,OAAA,EAAA,IAAA,CAAA,YAAA;AAAA,cACA,cAAgBC,EAAAA,IAAAA,CAAAA,cAAAA;AAAAA,cAChB,gBAAcC,EAAAA,IAAAA,CAAAA,gBAAAA;AAAAA,cACd,gBAAgB,IAAE,CAAA,cAAA;AAAA,cAd3B,YAAA,EAAA,IAAA,CAAA,YAAA;AAAA,cAgB0CC,gBAAAA,EAAAA,YAAAA;AAAAA,aAAAA,EAAAA,WAAAA,CAAAA;;;;yBAAe,IAAU,CAAA,MAAA,EAAA,CAAA,CAAA,EAAA,QAAA,KAAA;AAhBnE,gBAAA,OAAA;AAAA,kBAiBU,IAAA,EAAA,QAAA;AAAA,kBAAA,EAAA,EAAAC,OAAA,CAAA,CAAA,KAAA,KAAA;;;;;;;AAjBV,SAAA,CAAA;AAAA,QAAA,GAAA;AAAA;AAAA,OAAA;AAAA,KAAA,CAAA;;;;;;;;;"}

package/js/x-modules/queries-preview/components/query-preview-list.vue2.js

@@ -1,9 +1,8 @@
-import Vue, { defineComponent, ref, computed, watch } from 'vue';
+import { defineComponent, ref, computed, watch } from 'vue';
 import { queriesPreviewXModule } from '../x-module.js';
 import { getHashFromQueryPreviewInfo } from '../utils/get-hash-from-query-preview.js';
 import { AnimationProp } from '../../../types/animation-prop.js';
-import { useRegisterXModule } from '../../../composables/use-register-x-module.js';
-import __vue_component__ from './query-preview.vue.js';
+import QueryPreview from './query-preview.vue.js';
 
 /**
  * Renders the results previews of a list of objects with the information about the query preview,
@@ -12,10 +11,10 @@ import __vue_component__ from './query-preview.vue.js';
  *
  * @public
  */
-var script = defineComponent({
+var _sfc_main = defineComponent({
     name: 'QueryPreviewList',
     xModule: queriesPreviewXModule.name,
-    components: { QueryPreview: __vue_component__ },
+    components: { QueryPreview },
     props: {
         /**
          * The list of queries preview to render.
@@ -69,9 +68,7 @@ var script = defineComponent({
             default: 'ul'
         }
     },
-    setup(props, { slots }) {
-        useRegisterXModule(queriesPreviewXModule);
-        const renderSlots = slots;
+    setup(props) {
         /**
          * Contains the status of the preview requests, indexed by query.
          */
@@ -104,8 +101,7 @@ var script = defineComponent({
         const loadNext = () => {
             const queryToLoad = queries.value.find(query => !(query in queriesStatus.value));
             if (queryToLoad) {
-                //TODO - change this logic when we migrate to vue@3. It won't be necessary. Check this link https://v2.vuejs.org/v2/guide/migration-vue-2-7#Behavior-Differences-from-Vue-3
-                Vue.set(queriesStatus.value, queryToLoad, 'loading');
+                queriesStatus.value[queryToLoad] = 'loading';
             }
         };
         /**
@@ -117,7 +113,11 @@ var script = defineComponent({
          */
         watch(queries, (newQueries, oldQueries) => {
             if (newQueries.toString() !== oldQueries?.toString()) {
-                queriesStatus.value = {};
+                for (const key of Object.keys(queriesStatus.value)) {
+                    if (!newQueries.includes(key)) {
+                        delete queriesStatus.value[key];
+                    }
+                }
                 loadNext();
             }
         }, { immediate: true, deep: true });
@@ -144,11 +144,10 @@ var script = defineComponent({
         return {
             renderedQueryPreviews,
             flagAsFailed,
-            flagAsLoaded,
-            renderSlots
+            flagAsLoaded
         };
     }
 });
 
-export { script as default };
+export { _sfc_main as default };
 //# sourceMappingURL=query-preview-list.vue2.js.map

package/js/x-modules/queries-preview/components/query-preview-list.vue2.js.map

@@ -1 +1 @@
-{"version":3,"file":"query-preview-list.vue2.js","sources":["../../../../../src/x-modules/queries-preview/components/query-preview-list.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  import Vue, { computed, defineComponent, PropType, ref, watch } from 'vue';\n  import { RequestStatus } from '../../../store';\n  import { queriesPreviewXModule } from '../x-module';\n  import { QueryPreviewInfo } from '../store/types';\n  import { getHashFromQueryPreviewInfo } from '../utils/get-hash-from-query-preview';\n  import { AnimationProp, QueryFeature } from '../../../types';\n  import { useRegisterXModule } from '../../../composables/use-register-x-module';\n  import QueryPreview from './query-preview.vue';\n\n  interface QueryPreviewStatusRecord {\n    [query: string]: RequestStatus;\n  }\n\n  /**\n   * Renders the results previews of a list of objects with the information about the query preview,\n   * and exposes the {@link QueryPreview} slots to modify the content.\n   * The requests are made in sequential order.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'QueryPreviewList',\n    xModule: queriesPreviewXModule.name,\n    components: { QueryPreview },\n    props: {\n      /**\n       * The list of queries preview to render.\n       *\n       * @public\n       */\n      queriesPreviewInfo: {\n        type: Array as PropType<QueryPreviewInfo[]>,\n        required: true\n      },\n      /**\n       * The origin property for the request on each query preview.\n       *\n       * @public\n       */\n      queryFeature: {\n        type: String as PropType<QueryFeature>\n      },\n      /**\n       * Number of query preview results to be rendered on each query preview.\n       *\n       * @public\n       */\n      maxItemsToRender: {\n        type: Number\n      },\n      /**\n       * Debounce time in milliseconds for triggering the search requests\n       * on each query preview.\n       * It will default to 0 to fit the most common use case (pre-search),\n       * and it would work properly with a 250 value inside empathize.\n       */\n      debounceTimeMs: {\n        type: Number,\n        default: 0\n      },\n      /**\n       * Controls whether all the QueryPreview should be removed from the state\n       * when the component is destroyed.\n       *\n       * @public\n       */\n      persistInCache: Boolean,\n      /**\n       * Animation component that will be used to animate the elements.\n       *\n       * @public\n       */\n      animation: {\n        type: AnimationProp,\n        default: 'ul'\n      }\n    },\n    setup(props, { slots }) {\n      useRegisterXModule(queriesPreviewXModule);\n\n      const renderSlots = slots;\n\n      /**\n       * Contains the status of the preview requests, indexed by query.\n       */\n      let queriesStatus = ref<QueryPreviewStatusRecord>({});\n\n      /**\n       * The list of queries to preview.\n       *\n       * @returns The list of queries in the queriesPreviewInfo list.\n       * @internal\n       */\n      const queries = computed((): string[] =>\n        props.queriesPreviewInfo.map(item => getHashFromQueryPreviewInfo(item))\n      );\n\n      /**\n       * Gets all the queries to render, that are those that don't have an `error` status.\n       *\n       * @returns A list of queries.\n       * @internal\n       */\n      const renderedQueryPreviews = computed((): QueryPreviewInfo[] => {\n        return props.queriesPreviewInfo.filter(item => {\n          const queryPreviewHash = getHashFromQueryPreviewInfo(item);\n          return (\n            queriesStatus.value[queryPreviewHash] === 'success' ||\n            queriesStatus.value[queryPreviewHash] === 'loading'\n          );\n        });\n      });\n\n      /**\n       * Tries to load the next query.\n       *\n       * @internal\n       */\n      const loadNext = (): void => {\n        const queryToLoad = queries.value.find(query => !(query in queriesStatus.value));\n        if (queryToLoad) {\n          //TODO - change this logic when we migrate to vue@3. It won't be necessary. Check this link https://v2.vuejs.org/v2/guide/migration-vue-2-7#Behavior-Differences-from-Vue-3\n          Vue.set(queriesStatus.value, queryToLoad, 'loading');\n        }\n      };\n\n      /**\n       * Resets the status of all queries if they change.\n       *\n       * @param newQueries - The new queries.\n       * @param oldQueries - The old queries.\n       * @internal\n       */\n      watch(\n        queries,\n        (newQueries: string[], oldQueries: string[] | undefined) => {\n          if (newQueries.toString() !== oldQueries?.toString()) {\n            queriesStatus.value = {};\n            loadNext();\n          }\n        },\n        { immediate: true, deep: true }\n      );\n\n      /**\n       * Sets the status of a given query to `success`.\n       *\n       * @param loadedQuery - The query to flag as loaded.\n       * @internal\n       */\n      const flagAsLoaded = (loadedQuery: string): void => {\n        queriesStatus.value[loadedQuery] = 'success';\n        loadNext();\n      };\n\n      /**\n       * Sets the status of a given query to `error`.\n       *\n       * @param failedQuery - The query to flag as failed.\n       * @internal\n       */\n      const flagAsFailed = (failedQuery: string): void => {\n        queriesStatus.value[failedQuery] = 'error';\n        loadNext();\n      };\n\n      return {\n        renderedQueryPreviews,\n        flagAsFailed,\n        flagAsLoaded,\n        renderSlots\n      };\n    }\n  });\n"],"names":["QueryPreview"],"mappings":";;;;;;;AAsCE;;;;;;AAMG;AACH,aAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,kBAAkB;IACxB,OAAO,EAAE,qBAAqB,CAAC,IAAI;IACnC,UAAU,EAAE,gBAAEA,iBAAY,EAAE;AAC5B,IAAA,KAAK,EAAE;AACL;;;;AAIG;AACH,QAAA,kBAAkB,EAAE;AAClB,YAAA,IAAI,EAAE,KAAqC;AAC3C,YAAA,QAAQ,EAAE,IAAI;AACf,SAAA;AACD;;;;AAIG;AACH,QAAA,YAAY,EAAE;AACZ,YAAA,IAAI,EAAE,MAAgC;AACvC,SAAA;AACD;;;;AAIG;AACH,QAAA,gBAAgB,EAAE;AAChB,YAAA,IAAI,EAAE,MAAM;AACb,SAAA;AACD;;;;;AAKG;AACH,QAAA,cAAc,EAAE;AACd,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,OAAO,EAAE,CAAC;AACX,SAAA;AACD;;;;;AAKG;AACH,QAAA,cAAc,EAAE,OAAO;AACvB;;;;AAIG;AACH,QAAA,SAAS,EAAE;AACT,YAAA,IAAI,EAAE,aAAa;AACnB,YAAA,OAAO,EAAE,IAAI;AACd,SAAA;AACF,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,EAAA;QACpB,kBAAkB,CAAC,qBAAqB,CAAC,CAAC;QAE1C,MAAM,WAAW,GAAG,KAAK,CAAC;AAE1B;;AAEG;AACH,QAAA,IAAI,aAAa,GAAG,GAAG,CAA2B,EAAE,CAAC,CAAC;AAEtD;;;;;AAKG;QACH,MAAM,OAAO,GAAG,QAAQ,CAAC,MACvB,KAAK,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,IAAI,2BAA2B,CAAC,IAAI,CAAC,CAAC,CACxE,CAAC;AAEF;;;;;AAKG;AACH,QAAA,MAAM,qBAAqB,GAAG,QAAQ,CAAC,MAAyB;YAC9D,OAAO,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,IAAI,IAAG;AAC5C,gBAAA,MAAM,gBAAgB,GAAG,2BAA2B,CAAC,IAAI,CAAC,CAAC;gBAC3D,QACE,aAAa,CAAC,KAAK,CAAC,gBAAgB,CAAC,KAAK,SAAS;oBACnD,aAAa,CAAC,KAAK,CAAC,gBAAgB,CAAC,KAAK,SAAS,EACnD;AACJ,aAAC,CAAC,CAAC;AACL,SAAC,CAAC,CAAC;AAEH;;;;AAIG;QACH,MAAM,QAAQ,GAAG,MAAW;YAC1B,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,KAAK,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;AACjF,YAAA,IAAI,WAAW,EAAE;;gBAEf,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;AACtD,aAAA;AACH,SAAC,CAAC;AAEF;;;;;;AAMG;QACH,KAAK,CACH,OAAO,EACP,CAAC,UAAoB,EAAE,UAAgC,KAAI;YACzD,IAAI,UAAU,CAAC,QAAQ,EAAE,KAAK,UAAU,EAAE,QAAQ,EAAE,EAAE;AACpD,gBAAA,aAAa,CAAC,KAAK,GAAG,EAAE,CAAC;AACzB,gBAAA,QAAQ,EAAE,CAAC;AACZ,aAAA;SACF,EACD,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAChC,CAAC;AAEF;;;;;AAKG;AACH,QAAA,MAAM,YAAY,GAAG,CAAC,WAAmB,KAAU;AACjD,YAAA,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;AAC7C,YAAA,QAAQ,EAAE,CAAC;AACb,SAAC,CAAC;AAEF;;;;;AAKG;AACH,QAAA,MAAM,YAAY,GAAG,CAAC,WAAmB,KAAU;AACjD,YAAA,aAAa,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC;AAC3C,YAAA,QAAQ,EAAE,CAAC;AACb,SAAC,CAAC;QAEF,OAAO;YACL,qBAAqB;YACrB,YAAY;YACZ,YAAY;YACZ,WAAW;SACZ,CAAC;KACH;AACF,CAAA,CAAC;;;;"}
+{"version":3,"file":"query-preview-list.vue2.js","sources":["../../../../../src/x-modules/queries-preview/components/query-preview-list.vue"],"sourcesContent":["<template>\n  <component :is=\"animation\" class=\"x-query-preview-list\" tag=\"ul\">\n    <li\n      v-for=\"(queryPreview, index) in renderedQueryPreviews\"\n      :key=\"index\"\n      data-test=\"query-preview-item\"\n    >\n      <QueryPreview\n        @load=\"flagAsLoaded\"\n        @error=\"flagAsFailed\"\n        :debounceTimeMs=\"debounceTimeMs\"\n        :maxItemsToRender=\"maxItemsToRender\"\n        :persistInCache=\"persistInCache\"\n        :queryFeature=\"queryFeature\"\n        :queryPreviewInfo=\"queryPreview\"\n      >\n        <template v-for=\"(_, slotName) in $slots\" v-slot:[slotName]=\"scope\">\n          <slot :name=\"slotName\" v-bind=\"scope\" />\n        </template>\n      </QueryPreview>\n    </li>\n  </component>\n</template>\n\n<script lang=\"ts\">\n  import { computed, defineComponent, PropType, ref, watch } from 'vue';\n  import { RequestStatus } from '../../../store';\n  import { queriesPreviewXModule } from '../x-module';\n  import { QueryPreviewInfo } from '../store/types';\n  import { getHashFromQueryPreviewInfo } from '../utils/get-hash-from-query-preview';\n  import { AnimationProp, QueryFeature } from '../../../types';\n  import QueryPreview from './query-preview.vue';\n\n  interface QueryPreviewStatusRecord {\n    [query: string]: RequestStatus;\n  }\n\n  /**\n   * Renders the results previews of a list of objects with the information about the query preview,\n   * and exposes the {@link QueryPreview} slots to modify the content.\n   * The requests are made in sequential order.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'QueryPreviewList',\n    xModule: queriesPreviewXModule.name,\n    components: { QueryPreview },\n    props: {\n      /**\n       * The list of queries preview to render.\n       *\n       * @public\n       */\n      queriesPreviewInfo: {\n        type: Array as PropType<QueryPreviewInfo[]>,\n        required: true\n      },\n      /**\n       * The origin property for the request on each query preview.\n       *\n       * @public\n       */\n      queryFeature: {\n        type: String as PropType<QueryFeature>\n      },\n      /**\n       * Number of query preview results to be rendered on each query preview.\n       *\n       * @public\n       */\n      maxItemsToRender: {\n        type: Number\n      },\n      /**\n       * Debounce time in milliseconds for triggering the search requests\n       * on each query preview.\n       * It will default to 0 to fit the most common use case (pre-search),\n       * and it would work properly with a 250 value inside empathize.\n       */\n      debounceTimeMs: {\n        type: Number,\n        default: 0\n      },\n      /**\n       * Controls whether all the QueryPreview should be removed from the state\n       * when the component is destroyed.\n       *\n       * @public\n       */\n      persistInCache: Boolean,\n      /**\n       * Animation component that will be used to animate the elements.\n       *\n       * @public\n       */\n      animation: {\n        type: AnimationProp,\n        default: 'ul'\n      }\n    },\n    setup(props) {\n      /**\n       * Contains the status of the preview requests, indexed by query.\n       */\n      let queriesStatus = ref<QueryPreviewStatusRecord>({});\n\n      /**\n       * The list of queries to preview.\n       *\n       * @returns The list of queries in the queriesPreviewInfo list.\n       * @internal\n       */\n      const queries = computed((): string[] =>\n        props.queriesPreviewInfo.map(item => getHashFromQueryPreviewInfo(item))\n      );\n\n      /**\n       * Gets all the queries to render, that are those that don't have an `error` status.\n       *\n       * @returns A list of queries.\n       * @internal\n       */\n      const renderedQueryPreviews = computed((): QueryPreviewInfo[] => {\n        return props.queriesPreviewInfo.filter(item => {\n          const queryPreviewHash = getHashFromQueryPreviewInfo(item);\n          return (\n            queriesStatus.value[queryPreviewHash] === 'success' ||\n            queriesStatus.value[queryPreviewHash] === 'loading'\n          );\n        });\n      });\n\n      /**\n       * Tries to load the next query.\n       *\n       * @internal\n       */\n      const loadNext = (): void => {\n        const queryToLoad = queries.value.find(query => !(query in queriesStatus.value));\n        if (queryToLoad) {\n          queriesStatus.value[queryToLoad] = 'loading';\n        }\n      };\n\n      /**\n       * Resets the status of all queries if they change.\n       *\n       * @param newQueries - The new queries.\n       * @param oldQueries - The old queries.\n       * @internal\n       */\n      watch(\n        queries,\n        (newQueries: string[], oldQueries: string[] | undefined) => {\n          if (newQueries.toString() !== oldQueries?.toString()) {\n            for (const key of Object.keys(queriesStatus.value)) {\n              if (!newQueries.includes(key)) {\n                delete queriesStatus.value[key];\n              }\n            }\n            loadNext();\n          }\n        },\n        { immediate: true, deep: true }\n      );\n\n      /**\n       * Sets the status of a given query to `success`.\n       *\n       * @param loadedQuery - The query to flag as loaded.\n       * @internal\n       */\n      const flagAsLoaded = (loadedQuery: string): void => {\n        queriesStatus.value[loadedQuery] = 'success';\n        loadNext();\n      };\n\n      /**\n       * Sets the status of a given query to `error`.\n       *\n       * @param failedQuery - The query to flag as failed.\n       * @internal\n       */\n      const flagAsFailed = (failedQuery: string): void => {\n        queriesStatus.value[failedQuery] = 'error';\n        loadNext();\n      };\n\n      return {\n        renderedQueryPreviews,\n        flagAsFailed,\n        flagAsLoaded\n      };\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## See it in action\n\nHere you have a basic example of how the QueryPreviewList is rendered. Keep in mind that this\ncomponent is intended to be used overriding its default slot. By default it will only render the\nnames of the results.\n\n```vue live\n<template>\n  <QueryPreviewList :queriesPreviewInfo=\"queriesPreviewInfo\" />\n</template>\n\n<script>\n  import { QueryPreviewList } from '@empathyco/x-components/queries-preview';\n\n  export default {\n    name: 'QueryPreviewListDemo',\n    components: {\n      QueryPreviewList\n    },\n    data() {\n      return {\n        queriesPreviewInfo: [{ query: 'sandals' }, { query: 'tshirt' }, { query: 'jacket' }]\n      };\n    }\n  };\n</script>\n```\n\n### Play with the default slot\n\nIn this example, the results will be rendered inside a sliding panel.\n\n```vue live\n<template>\n  <QueryPreviewList\n    :queriesPreviewInfo=\"queriesPreviewInfo\"\n    #default=\"{ queryPreviewInfo, totalResults, results }\"\n  >\n    <div class=\"x-flex x-flex-col x-gap-8 x-mb-16\">\n      <h1 class=\"x-title2\">{{ queryPreviewInfo.query }} ({{ totalResults }})</h1>\n      <SlidingPanel :resetOnContentChange=\"false\">\n        <div class=\"x-flex x-gap-8\">\n          <Result\n            v-for=\"result in results\"\n            :key=\"result.id\"\n            :result=\"result\"\n            style=\"max-width: 180px\"\n          />\n        </div>\n      </SlidingPanel>\n    </div>\n  </QueryPreviewList>\n</template>\n\n<script>\n  import { QueryPreviewList } from '@empathyco/x-components/queries-preview';\n  import { BaseResultImage, BaseResultLink, SlidingPanel } from '@empathyco/x-components';\n\n  export default {\n    name: 'QueryPreviewListDemoOverridingSlot',\n    components: {\n      BaseResultImage,\n      BaseResultLink,\n      QueryPreviewList,\n      SlidingPanel\n    },\n    data() {\n      return {\n        queriesPreviewInfo: [{ query: 'sandals' }, { query: 'tshirt' }, { query: 'jacket' }]\n      };\n    }\n  };\n</script>\n```\n\n### Play with the result slot\n\nThe component exposes a slot to override the result content, without modifying the list.\n\nIn this example, the ID of the results will be rendered along with the name.\n\n```vue\n<template>\n  <QueryPreviewList\n    class=\"x-flex x-gap-8\"\n    :queriesPreviewInfo=\"queriesPreviewInfo\"\n    #result=\"{ result }\"\n  >\n    <span class=\"x-font-bold\">{{ result.id }}:</span>\n    <span>{{ result.name }}</span>\n  </QueryPreviewList>\n</template>\n\n<script>\n  import { QueryPreviewList } from '@empathyco/x-components/queries-preview';\n\n  export default {\n    name: 'QueryPreviewListDemoOverridingResultSlot',\n    components: {\n      QueryPreviewList\n    },\n    data() {\n      return {\n        queriesPreviewInfo: [{ query: 'sandals' }, { query: 'tshirt' }, { query: 'jacket' }]\n      };\n    }\n  };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;;;AAqCE;;;;;;AAME;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,kBAAkB;IACxB,OAAO,EAAE,qBAAqB,CAAC,IAAI;IACnC,UAAU,EAAE,EAAE,YAAW,EAAG;AAC5B,IAAA,KAAK,EAAE;AACL;;;;AAIE;AACF,QAAA,kBAAkB,EAAE;AAClB,YAAA,IAAI,EAAE,KAAqC;AAC3C,YAAA,QAAQ,EAAE,IAAG;AACd,SAAA;AACD;;;;AAIE;AACF,QAAA,YAAY,EAAE;AACZ,YAAA,IAAI,EAAE,MAA+B;AACtC,SAAA;AACD;;;;AAIE;AACF,QAAA,gBAAgB,EAAE;AAChB,YAAA,IAAI,EAAE,MAAK;AACZ,SAAA;AACD;;;;;AAKE;AACF,QAAA,cAAc,EAAE;AACd,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,OAAO,EAAE,CAAA;AACV,SAAA;AACD;;;;;AAKE;AACF,QAAA,cAAc,EAAE,OAAO;AACvB;;;;AAIE;AACF,QAAA,SAAS,EAAE;AACT,YAAA,IAAI,EAAE,aAAa;AACnB,YAAA,OAAO,EAAE,IAAG;AACd,SAAA;AACD,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAA;AACT;;AAEE;AACF,QAAA,IAAI,gBAAgB,GAAG,CAA2B,EAAE,CAAC,CAAA;AAErD;;;;;AAKE;QACF,MAAM,OAAM,GAAI,QAAQ,CAAC,MACvB,KAAK,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAK,IAAG,2BAA2B,CAAC,IAAI,CAAC,CAAA,CACvE,CAAA;AAED;;;;;AAKE;AACF,QAAA,MAAM,qBAAsB,GAAE,QAAQ,CAAC,MAA0B;YAC/D,OAAO,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,IAAG,IAAK;AAC7C,gBAAA,MAAM,mBAAmB,2BAA2B,CAAC,IAAI,CAAC,CAAA;gBAC1D,QACE,aAAa,CAAC,KAAK,CAAC,gBAAgB,CAAE,KAAI,SAAQ;oBAClD,aAAa,CAAC,KAAK,CAAC,gBAAgB,MAAM,SAAQ,EACnD;AACH,aAAC,CAAC,CAAA;AACJ,SAAC,CAAC,CAAA;AAEF;;;;AAIE;QACF,MAAM,QAAS,GAAE,MAAY;YAC3B,MAAM,WAAY,GAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAM,IAAG,EAAE,KAAI,IAAK,aAAa,CAAC,KAAK,CAAC,CAAC,CAAA;AAChF,YAAA,IAAI,WAAW,EAAE;AACf,gBAAA,aAAa,CAAC,KAAK,CAAC,WAAW,CAAA,GAAI,SAAS,CAAA;AAC9C,aAAA;AACF,SAAC,CAAA;AAED;;;;;;AAME;QACF,KAAK,CACH,OAAO,EACP,CAAC,UAAoB,EAAE,UAAgC,KAAK;YAC1D,IAAI,UAAU,CAAC,QAAQ,EAAG,KAAI,UAAU,EAAE,QAAQ,EAAE,EAAE;gBACpD,KAAK,MAAM,OAAO,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE;AAClD,oBAAA,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;AAC7B,wBAAA,OAAO,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;AACjC,qBAAA;AACF,iBAAA;AACA,gBAAA,QAAQ,EAAE,CAAA;AACZ,aAAA;SACD,EACD,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAK,EAAA,CAC/B,CAAA;AAED;;;;;AAKE;AACF,QAAA,MAAM,eAAe,CAAC,WAAmB,KAAW;AAClD,YAAA,aAAa,CAAC,KAAK,CAAC,WAAW,CAAA,GAAI,SAAS,CAAA;AAC5C,YAAA,QAAQ,EAAE,CAAA;AACZ,SAAC,CAAA;AAED;;;;;AAKE;AACF,QAAA,MAAM,eAAe,CAAC,WAAmB,KAAW;AAClD,YAAA,aAAa,CAAC,KAAK,CAAC,WAAW,CAAA,GAAI,OAAO,CAAA;AAC1C,YAAA,QAAQ,EAAE,CAAA;AACZ,SAAC,CAAA;QAED,OAAO;YACL,qBAAqB;YACrB,YAAY;YACZ,YAAW;SACZ,CAAA;KACH;AACD,CAAA,CAAC;;;;"}

package/js/x-modules/queries-preview/components/query-preview.vue.js

@@ -1,102 +1,42 @@
-import script from './query-preview.vue2.js';
-import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.mjs';
+import _sfc_main from './query-preview.vue2.js';
+import { openBlock, createElementBlock, Fragment, renderList, createCommentVNode, renderSlot, createElementVNode, toDisplayString } from 'vue';
+import _export_sfc from '../../../_virtual/_plugin-vue_export-helper.js';
 
-/* script */
-const __vue_script__ = script;
-
-/* template */
-var __vue_render__ = function () {
-  var _vm = this;
-  var _h = _vm.$createElement;
-  var _c = _vm._self._c || _h;
-  return _vm.queryPreviewResults && _vm.queryPreviewResults.totalResults > 0
-    ? _c(
-        "NoElement",
-        [
-          _vm._t(
-            "default",
-            function () {
-              return [
-                _c(
-                  "ul",
-                  {
-                    staticClass: "x-query-preview",
-                    attrs: { "data-test": "query-preview" },
-                  },
-                  _vm._l(_vm.queryPreviewResults.results, function (result) {
-                    return _c(
-                      "li",
-                      {
-                        key: result.id,
-                        staticClass: "x-query-preview__item",
-                        attrs: { "data-test": "query-preview-item" },
-                      },
-                      [
-                        _vm._t(
-                          "result",
-                          function () {
-                            return [
-                              _c(
-                                "span",
-                                { attrs: { "data-test": "result-name" } },
-                                [_vm._v(_vm._s(result.name))]
-                              ),
-                            ]
-                          },
-                          { result: result }
-                        ),
-                      ],
-                      2
-                    )
-                  }),
-                  0
-                ),
-              ]
-            },
-            {
-              queryPreviewInfo: _vm.queryPreviewInfo,
-              results: _vm.queryPreviewResults.results,
-              totalResults: _vm.queryPreviewResults.totalResults,
-              displayTagging: _vm.queryPreviewResults.displayTagging,
-              queryTagging: _vm.queryPreviewResults.queryTagging,
-            }
-          ),
-        ],
-        2
-      )
-    : _vm._e()
+const _hoisted_1 = {
+  key: 0,
+  "data-test": "query-preview",
+  class: "x-query-preview"
 };
-var __vue_staticRenderFns__ = [];
-__vue_render__._withStripped = true;
-
-  /* style */
-  const __vue_inject_styles__ = undefined;
-  /* scoped */
-  const __vue_scope_id__ = undefined;
-  /* module identifier */
-  const __vue_module_identifier__ = undefined;
-  /* functional template */
-  const __vue_is_functional_template__ = false;
-  /* style inject */
-  
-  /* style inject SSR */
-  
-  /* style inject shadow dom */
-  
-
-  
-  const __vue_component__ = /*#__PURE__*/__vue_normalize__(
-    { render: __vue_render__, staticRenderFns: __vue_staticRenderFns__ },
-    __vue_inject_styles__,
-    __vue_script__,
-    __vue_scope_id__,
-    __vue_is_functional_template__,
-    __vue_module_identifier__,
-    false,
-    undefined,
-    undefined,
-    undefined
-  );
+const _hoisted_2 = { "data-test": "result-name" };
+function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
+  return _ctx.hasResults ? (openBlock(), createElementBlock("ul", _hoisted_1, [
+    (openBlock(true), createElementBlock(
+      Fragment,
+      null,
+      renderList(_ctx.queryPreviewResults?.results, (result) => {
+        return openBlock(), createElementBlock("li", {
+          key: result.id,
+          class: "x-query-preview__item",
+          "data-test": "query-preview-item"
+        }, [
+          createCommentVNode("\n        @slot Query Preview result slot.\n        @binding {Result} result - A Query Preview result\n      "),
+          renderSlot(_ctx.$slots, "result", { result }, () => [
+            createElementVNode(
+              "span",
+              _hoisted_2,
+              toDisplayString(result.name),
+              1
+              /* TEXT */
+            )
+          ])
+        ]);
+      }),
+      128
+      /* KEYED_FRAGMENT */
+    ))
+  ])) : createCommentVNode("v-if", true);
+}
+var QueryPreview = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
 
-export { __vue_component__ as default };
+export { QueryPreview as default };
 //# sourceMappingURL=query-preview.vue.js.map

package/js/x-modules/queries-preview/components/query-preview.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"query-preview.vue.js","sources":["../../../../../src/x-modules/queries-preview/components/query-preview.vue"],"sourcesContent":["<template>\n  <NoElement v-if=\"queryPreviewResults && queryPreviewResults.totalResults > 0\">\n    <!--\n      @slot Query Preview default slot.\n          @binding {QueryPreviewInfo} queryPreviewInfo - The information about the request of the\n          query preview\n          @binding {Result[]} results - The results preview of the query preview\n          @binding {number} totalResults - The total results of the search request\n    -->\n    <slot\n      :queryPreviewInfo=\"queryPreviewInfo\"\n      :results=\"queryPreviewResults.results\"\n      :totalResults=\"queryPreviewResults.totalResults\"\n      :displayTagging=\"queryPreviewResults.displayTagging\"\n      :queryTagging=\"queryPreviewResults.queryTagging\"\n    >\n      <ul data-test=\"query-preview\" class=\"x-query-preview\">\n        <li\n          v-for=\"result in queryPreviewResults.results\"\n          :key=\"result.id\"\n          class=\"x-query-preview__item\"\n          data-test=\"query-preview-item\"\n        >\n          <!--\n          @slot Query Preview result slot.\n              @binding {Result} result - A Query Preview result\n          -->\n          <slot name=\"result\" :result=\"result\">\n            <span data-test=\"result-name\">{{ result.name }}</span>\n          </slot>\n        </li>\n      </ul>\n    </slot>\n  </NoElement>\n</template>\n\n<script lang=\"ts\">\n  import {\n    computed,\n    ComputedRef,\n    defineComponent,\n    inject,\n    onBeforeUnmount,\n    PropType,\n    provide,\n    Ref,\n    watch\n  } from 'vue';\n  import { SearchRequest, Result, Filter } from '@empathyco/x-types';\n  import { deepEqual, Dictionary } from '@empathyco/x-utils';\n  import { LIST_ITEMS_KEY } from '../../../components/decorators/injection.consts';\n  import { NoElement } from '../../../components/no-element';\n  import { QueryFeature, FeatureLocation } from '../../../types/origin';\n  import { QueryPreviewInfo, QueryPreviewItem } from '../store/types';\n  import { QueriesPreviewConfig } from '../config.types';\n  import { queriesPreviewXModule } from '../x-module';\n  import { createOrigin } from '../../../utils/origin';\n  import { debounce } from '../../../utils/debounce';\n  import { DebouncedFunction } from '../../../utils';\n  import { createRawFilter } from '../../../__stubs__/filters-stubs.factory';\n  import { getHashFromQueryPreviewInfo } from '../utils/get-hash-from-query-preview';\n  import { useRegisterXModule } from '../../../composables/use-register-x-module';\n  import { useState } from '../../../composables/use-state';\n  import { useXBus } from '../../../composables/use-x-bus';\n\n  /**\n   * Retrieves a preview of the results of a query and exposes them in the default slot,\n   * along with the query preview and the totalResults of the search request.\n   * By default, it renders the names of the results.\n   *\n   * @public\n   */\n\n  export default defineComponent({\n    name: 'QueryPreview',\n    components: {\n      NoElement\n    },\n    xModule: queriesPreviewXModule.name,\n    props: {\n      /**\n       * The information about the request of the query preview.\n       *\n       * @public\n       */\n      queryPreviewInfo: {\n        type: Object as PropType<QueryPreviewInfo>,\n        required: true\n      },\n      /**\n       * The origin property for the request.\n       *\n       * @public\n       */\n      queryFeature: {\n        type: String as PropType<QueryFeature>\n      },\n      /**\n       * Number of query preview results to be rendered.\n       *\n       * @public\n       */\n      maxItemsToRender: {\n        type: Number\n      },\n      /**\n       * Debounce time in milliseconds for triggering the search requests.\n       * It will default to 0 to fit the most common use case (pre-search),\n       * and it would work properly with a 250 value inside empathize.\n       */\n      debounceTimeMs: {\n        type: Number,\n        default: 0\n      },\n      /**\n       * Controls whether the QueryPreview should be removed from the state\n       * when the component is destroyed.\n       *\n       * @public\n       */\n      persistInCache: {\n        type: Boolean,\n        default: false\n      }\n    },\n    emits: ['load', 'error'],\n    setup(props, { emit }) {\n      useRegisterXModule(queriesPreviewXModule);\n\n      const xBus = useXBus();\n\n      const queriesPreviewState = useState('queriesPreview', [\n        'queriesPreview',\n        'params',\n        'config'\n      ]);\n\n      /**\n       * The results preview of the queries preview cacheable mounted.\n       * It is a dictionary, indexed by the query preview query.\n       */\n      const previewResults: ComputedRef<Dictionary<QueryPreviewItem>> =\n        queriesPreviewState.queriesPreview;\n\n      /**\n       * As the request is handled in this component, we need\n       * the extra params that will be used in the request.\n       */\n      const params: ComputedRef<Dictionary<unknown>> = queriesPreviewState.params;\n\n      /**\n       * As the request is handled in this component, we need\n       * the config that will be used in the request.\n       */\n      const config: ComputedRef<QueriesPreviewConfig> = queriesPreviewState.config;\n\n      /**\n       * Query Preview key converted into a unique id.\n       *\n       * @returns The query hash.\n       * @internal\n       */\n      const queryPreviewHash = computed((): string => {\n        return getHashFromQueryPreviewInfo(props.queryPreviewInfo);\n      });\n\n      /**\n       * Gets from the state the results preview of the query preview.\n       *\n       * @returns The results preview of the actual query preview.\n       */\n      const queryPreviewResults = computed((): Partial<QueryPreviewItem> | undefined => {\n        const resultsPreview = previewResults.value[queryPreviewHash.value];\n        return resultsPreview?.results\n          ? {\n              ...resultsPreview,\n              results: resultsPreview.results.slice(0, props.maxItemsToRender)\n            }\n          : undefined;\n      });\n\n      /**\n       * The results to render from the state.\n       *\n       * @remarks The results list are provided with `items` key. It can be\n       * concatenated with list items from components such as `BannersList`, `PromotedsList`,\n       * `BaseGrid` or any component that injects the list.\n       *\n       * @returns A list of results.\n       * @public\n       */\n      const results = computed((): Result[] | undefined => {\n        return queryPreviewResults.value?.results;\n      });\n      provide<Ref<Result[] | undefined>>(LIST_ITEMS_KEY as string, results);\n\n      /**\n       * It injects the provided {@link FeatureLocation} of the selected query in the search request.\n       *\n       * @internal\n       */\n      const injectedLocation = inject<Ref<FeatureLocation> | FeatureLocation>('location', 'none');\n      const location =\n        typeof injectedLocation === 'object' && 'value' in injectedLocation\n          ? injectedLocation.value\n          : injectedLocation;\n\n      /**\n       * The computed request object to be used to retrieve the query preview results.\n       *\n       * @returns The search request object.\n       * @internal\n       */\n      const queryPreviewRequest = computed((): SearchRequest => {\n        const origin = createOrigin({\n          feature: props.queryFeature,\n          location: location\n        });\n        const filters = props.queryPreviewInfo.filters?.reduce((filtersList, filterId) => {\n          const facetId = filterId.split(':')[0];\n          const rawFilter = createRawFilter(filterId);\n          filtersList[facetId] = filtersList[facetId]\n            ? filtersList[facetId].concat(rawFilter)\n            : [rawFilter];\n\n          return filtersList;\n        }, {} as Record<string, Filter[]>);\n\n        return {\n          query: props.queryPreviewInfo.query,\n          rows: config.value.maxItemsToRequest,\n          extraParams: {\n            ...params.value,\n            ...props.queryPreviewInfo.extraParams\n          },\n          filters: filters,\n          ...(origin && { origin })\n        };\n      });\n\n      /**\n       * The debounce method to trigger the request after the debounceTimeMs defined\n       * for cacheable queries.\n       *\n       * @returns The search request object.\n       * @internal\n       */\n      const emitQueryPreviewRequestUpdated = computed((): DebouncedFunction<[SearchRequest]> => {\n        return debounce(request => {\n          xBus.emit('QueryPreviewRequestUpdated', request, { priority: 0, replaceable: false });\n        }, props.debounceTimeMs);\n      });\n\n      /**\n       * Initialises watcher to emit debounced requests, and first value for the requests.\n       *\n       * @internal\n       */\n      watch(queryPreviewRequest, (newRequest, oldRequest) => {\n        if (!deepEqual(newRequest, oldRequest)) {\n          emitQueryPreviewRequestUpdated.value(newRequest);\n        }\n      });\n\n      const cachedQueryPreview = previewResults.value[queryPreviewHash.value];\n\n      // If the query has been saved it will emit load instead of the emitting the updated request.\n      if (cachedQueryPreview?.status === 'success') {\n        emit('load', queryPreviewHash.value);\n        xBus.emit('QueryPreviewMounted', queryPreviewHash.value, {\n          priority: 0,\n          replaceable: false\n        });\n      } else {\n        emitQueryPreviewRequestUpdated.value(queryPreviewRequest.value);\n      }\n\n      /**\n       * Cancels the (remaining) requests when the component is destroyed\n       * via the `debounce.cancel()` method.\n       * If the prop 'persistInCache' is set to false, it also removes the QueryPreview\n       * from the state when the component is destroyed.\n       *\n       * @internal\n       */\n      onBeforeUnmount(() => {\n        emitQueryPreviewRequestUpdated.value.cancel();\n        xBus.emit(\n          'QueryPreviewUnmounted',\n          { queryPreviewHash: queryPreviewHash.value, cache: props.persistInCache },\n          {\n            priority: 0,\n            replaceable: false\n          }\n        );\n      });\n\n      /**\n       * Cancels the previous request when the debounced function changes (e.g: the debounceTimeMs\n       * prop changes or there is a request in progress that cancels it).\n       *\n       * @param _new - The new debounced function.\n       * @param old - The previous debounced function.\n       * @internal\n       */\n      watch(\n        emitQueryPreviewRequestUpdated,\n        (_new: DebouncedFunction<[SearchRequest]>, old: DebouncedFunction<[SearchRequest]>) => {\n          old.cancel();\n        }\n      );\n\n      const queryPreviewResultsStatus = computed(() => queryPreviewResults.value?.status);\n\n      /**\n       * Emits an event when the query results are loaded or fail to load.\n       *\n       * @param status - The status of the query preview request.\n       * @internal\n       */\n      watch(queryPreviewResultsStatus, () => {\n        if (queryPreviewResultsStatus.value === 'success') {\n          emit(results.value?.length ? 'load' : 'error', queryPreviewHash.value);\n        } else if (queryPreviewResultsStatus.value === 'error') {\n          emit('error', queryPreviewHash.value);\n        }\n      });\n\n      return {\n        queryPreviewResults\n      };\n    }\n  });\n</script>\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`QueryPreviewRequestUpdated`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted when the component is mounted and when the properties of the request object\n  changes. The event payload is the `queryPreviewRequest` object.\n\n## Vue Events\n\nA list of vue events that the component will emit:\n\n- `load`: the event is emitted when the query results have been loaded.\n- `error`: the event is emitted if there is some error when retrieving the query results.\n\n## See it in action\n\nHere you have a basic example of how the QueryPreview is rendered. Keep in mind that this component\nis intended to be used overriding its default slot. By default it will only render the names of the\nresults.\n\n```vue live\n<template>\n  <QueryPreview :queryPreviewInfo=\"queryPreviewInfo\" />\n</template>\n\n<script>\n  import { QueryPreview } from '@empathyco/x-components/queries-preview';\n\n  export default {\n    name: 'QueryPreviewDemo',\n    components: {\n      QueryPreview\n    },\n    data() {\n      return {\n        queryPreviewInfo: { query: 'sandals' }\n      };\n    }\n  };\n</script>\n```\n\n### Play with the default slot\n\nIn this example, the results will be rendered inside a sliding panel.\n\n```vue live\n<template>\n  <QueryPreview :queryPreviewInfo=\"queryPreviewInfo\" #default=\"{ totalResults, results }\">\n    <section>\n      <p>Total results: {{ totalResults }}</p>\n      <SlidingPanel :resetOnContentChange=\"false\">\n        <article\n          v-for=\"result in results\"\n          :key=\"result.id\"\n          class=\"x-result\"\n          style=\"max-width: 300px; overflow: hidden\"\n        >\n          <BaseResultLink :result=\"result\">\n            <BaseResultImage :result=\"result\" class=\"x-result__picture\" />\n          </BaseResultLink>\n          <div class=\"x-result__description\">\n            <BaseResultLink :result=\"result\">\n              <h1 class=\"x-title3\">{{ result.name }}</h1>\n            </BaseResultLink>\n          </div>\n        </article>\n      </SlidingPanel>\n    </section>\n  </QueryPreview>\n</template>\n\n<script>\n  import { QueryPreview } from '@empathyco/x-components/queries-preview';\n  import { BaseResultImage, BaseResultLink, SlidingPanel } from '@empathyco/x-components';\n\n  export default {\n    name: 'QueryPreviewDemoOverridingSlot',\n    components: {\n      BaseResultImage,\n      BaseResultLink,\n      QueryPreview,\n      SlidingPanel\n    },\n    data() {\n      return {\n        queryPreviewInfo: { query: 'flip-flops' }\n      };\n    }\n  };\n</script>\n```\n\n### Play with the result slot\n\nThe component exposes a slot to override the result content, without modifying the list.\n\nIn this example, the ID of the results will be rendered along with the name.\n\n```vue\n<template>\n  <QueryPreview :queryPreviewInfo=\"queryPreviewInfo\" #result=\"{ result }\">\n    <span>{{ result.id }}</span>\n    <span>{{ result.name }}</span>\n  </QueryPreview>\n</template>\n\n<script>\n  import { QueryPreview } from '@empathyco/x-components/queries-preview';\n\n  export default {\n    name: 'QueryPreviewDemoOverridingResultSlot',\n    components: {\n      QueryPreview\n    },\n    data() {\n      return {\n        queryPreviewInfo: { query: 'flip-flops' }\n      };\n    }\n  };\n</script>\n```\n\n### Play with props\n\nIn this example, the query preview has been limited to render a maximum of 4 results.\n\n```vue\n<template>\n  <QueryPreview\n    :maxItemsToRender=\"maxItemsToRender\"\n    :queryPreviewInfo=\"queryPreviewInfo\"\n    #default=\"{ results }\"\n  >\n    <BaseGrid #default=\"{ item }\" :items=\"results\">\n      <BaseResultLink :result=\"item\">\n        <BaseResultImage :result=\"item\" />\n      </BaseResultLink>\n    </BaseGrid>\n  </QueryPreview>\n</template>\n\n<script>\n  import { BaseGrid, BaseResultImage, BaseResultLink } from '@empathyco/x-components';\n  import { QueryPreview } from '@empathyco/x-components/queries-preview';\n\n  export default {\n    name: 'QueryPreviewDemo',\n    components: {\n      BaseGrid,\n      BaseResultImage,\n      BaseResultLink,\n      QueryPreview\n    },\n    data() {\n      return {\n        maxItemsToRender: 4,\n        queryPreviewInfo: { query: 'flip-flops' }\n      };\n    }\n  };\n</script>\n```\n</docs>\n"],"names":[],"mappings":";;;;AAEA,MAAc,cAAA,GAAA,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"query-preview.vue.js","sources":["../../../../../src/x-modules/queries-preview/components/query-preview.vue"],"sourcesContent":["<template>\n  <ul v-if=\"hasResults\" data-test=\"query-preview\" class=\"x-query-preview\">\n    <li\n      v-for=\"result in queryPreviewResults?.results\"\n      :key=\"result.id\"\n      class=\"x-query-preview__item\"\n      data-test=\"query-preview-item\"\n    >\n      <!--\n        @slot Query Preview result slot.\n        @binding {Result} result - A Query Preview result\n      -->\n      <slot name=\"result\" :result=\"result\">\n        <span data-test=\"result-name\">{{ result.name }}</span>\n      </slot>\n    </li>\n  </ul>\n</template>\n\n<script lang=\"ts\">\n  import {\n    computed,\n    ComputedRef,\n    defineComponent,\n    inject,\n    onBeforeUnmount,\n    PropType,\n    provide,\n    Ref,\n    watch\n  } from 'vue';\n  import { SearchRequest, Filter } from '@empathyco/x-types';\n  import { deepEqual, Dictionary } from '@empathyco/x-utils';\n  import { LIST_ITEMS_KEY } from '../../../components';\n  import { QueryFeature, FeatureLocation } from '../../../types';\n  import { QueryPreviewInfo, QueryPreviewItem } from '../store/types';\n  import { QueriesPreviewConfig } from '../config.types';\n  import { queriesPreviewXModule } from '../x-module';\n  import {\n    DebouncedFunction,\n    debounceFunction,\n    createOrigin,\n    createRawFilters\n  } from '../../../utils';\n  import { getHashFromQueryPreviewInfo } from '../utils/get-hash-from-query-preview';\n  import { useXBus, useState } from '../../../composables';\n\n  /**\n   * Retrieves a preview of the results of a query and exposes them in the default slot,\n   * along with the query preview and the totalResults of the search request.\n   * By default, it renders the names of the results.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'QueryPreview',\n    xModule: queriesPreviewXModule.name,\n    props: {\n      /** The information about the request of the query preview. */\n      queryPreviewInfo: {\n        type: Object as PropType<QueryPreviewInfo>,\n        required: true\n      },\n      /** The origin property for the request. */\n      queryFeature: {\n        type: String as PropType<QueryFeature>\n      },\n      /** Number of query preview results to be rendered. */\n      maxItemsToRender: {\n        type: Number\n      },\n      /**\n       * Debounce time in milliseconds for triggering the search requests.\n       * It will default to 0 to fit the most common use case (pre-search),\n       * and it would work properly with a 250 value inside empathize.\n       */\n      debounceTimeMs: {\n        type: Number,\n        default: 0\n      },\n      /**\n       * Controls whether the QueryPreview should be removed from the state\n       * when the component is destroyed.\n       */\n      persistInCache: {\n        type: Boolean,\n        default: false\n      }\n    },\n    emits: ['load', 'error'],\n    setup(props, { emit, slots }) {\n      const xBus = useXBus();\n\n      const queriesPreviewState = useState('queriesPreview', [\n        'queriesPreview',\n        'params',\n        'config'\n      ]);\n\n      /**\n       * The results preview of the queries preview cacheable mounted.\n       * It is a dictionary, indexed by the query preview query.\n       */\n      const previewResults: ComputedRef<Dictionary<QueryPreviewItem>> =\n        queriesPreviewState.queriesPreview;\n\n      /**\n       * As the request is handled in this component, we need\n       * the extra params that will be used in the request.\n       */\n      const params: ComputedRef<Dictionary<unknown>> = queriesPreviewState.params;\n\n      /**\n       * As the request is handled in this component, we need\n       * the config that will be used in the request.\n       */\n      const config: ComputedRef<QueriesPreviewConfig> = queriesPreviewState.config;\n\n      /**\n       * Query Preview key converted into a unique id.\n       *\n       * @returns The query hash.\n       */\n      const queryPreviewHash = computed(() => getHashFromQueryPreviewInfo(props.queryPreviewInfo));\n\n      provide('queryPreviewHash', queryPreviewHash);\n\n      /**\n       * Gets from the state the results preview of the query preview.\n       *\n       * @returns The results preview of the actual query preview.\n       */\n      const queryPreviewResults = computed(() => {\n        const resultsPreview = previewResults.value[queryPreviewHash.value];\n        return resultsPreview?.results\n          ? {\n              ...resultsPreview,\n              results: resultsPreview.results.slice(0, props.maxItemsToRender)\n            }\n          : undefined;\n      });\n\n      /**\n       * The results to render from the state.\n       *\n       * @remarks The results list are provided with `items` key. It can be\n       * concatenated with list items from components such as `BannersList`, `PromotedsList`,\n       * `BaseGrid` or any component that injects the list.\n       *\n       * @returns A list of results.\n       */\n      const results = computed(() => queryPreviewResults.value?.results);\n      provide(LIST_ITEMS_KEY as string, results);\n\n      /**\n       * It injects the provided {@link FeatureLocation} of the selected query in the search request.\n       *\n       * @internal\n       */\n      const injectedLocation = inject<Ref<FeatureLocation> | FeatureLocation>('location', 'none');\n      const location =\n        typeof injectedLocation === 'object' && 'value' in injectedLocation\n          ? injectedLocation.value\n          : injectedLocation;\n\n      /**\n       * The computed request object to be used to retrieve the query preview results.\n       *\n       * @returns The search request object.\n       */\n      const queryPreviewRequest = computed<SearchRequest>(() => {\n        const origin = createOrigin({\n          feature: props.queryFeature,\n          location: location\n        });\n        const filters = props.queryPreviewInfo.filters?.reduce((filtersList, filterId) => {\n          const facetId = filterId.split(':')[0];\n          const rawFilter = createRawFilters([filterId])[0];\n          filtersList[facetId] = filtersList[facetId]\n            ? filtersList[facetId].concat(rawFilter)\n            : [rawFilter];\n\n          return filtersList;\n        }, {} as Record<string, Filter[]>);\n\n        return {\n          query: props.queryPreviewInfo.query,\n          rows: config.value.maxItemsToRequest,\n          extraParams: {\n            ...params.value,\n            ...props.queryPreviewInfo.extraParams\n          },\n          filters: filters,\n          ...(origin && { origin })\n        };\n      });\n\n      /**\n       * The debounce method to trigger the request after the debounceTimeMs defined\n       * for cacheable queries.\n       *\n       * @returns The search request object.\n       */\n      const emitQueryPreviewRequestUpdated = computed<DebouncedFunction<[SearchRequest]>>(() =>\n        debounceFunction(request => {\n          xBus.emit('QueryPreviewRequestUpdated', request, { priority: 0, replaceable: false });\n        }, props.debounceTimeMs)\n      );\n\n      /**\n       * Initialises watcher to emit debounced requests, and first value for the requests.\n       *\n       * @internal\n       */\n      watch(queryPreviewRequest, (newRequest, oldRequest) => {\n        if (!deepEqual(newRequest, oldRequest)) {\n          emitQueryPreviewRequestUpdated.value(newRequest);\n        }\n      });\n\n      const cachedQueryPreview = previewResults.value[queryPreviewHash.value];\n\n      // If the query has been saved it will emit load instead of the emitting the updated request.\n      if (cachedQueryPreview?.status === 'success') {\n        emit('load', queryPreviewHash.value);\n        xBus.emit('QueryPreviewMounted', queryPreviewHash.value, {\n          priority: 0,\n          replaceable: false\n        });\n      } else {\n        emitQueryPreviewRequestUpdated.value(queryPreviewRequest.value);\n      }\n\n      /**\n       * Cancels the (remaining) requests when the component is destroyed\n       * via the `debounce.cancel()` method.\n       * If the prop 'persistInCache' is set to false, it also removes the QueryPreview\n       * from the state when the component is destroyed.\n       */\n      onBeforeUnmount(() => {\n        emitQueryPreviewRequestUpdated.value.cancel();\n        xBus.emit(\n          'QueryPreviewUnmounted',\n          { queryPreviewHash: queryPreviewHash.value, cache: props.persistInCache },\n          {\n            priority: 0,\n            replaceable: false\n          }\n        );\n      });\n\n      /**\n       * Cancels the previous request when the debounced function changes (e.g: the debounceTimeMs\n       * prop changes or there is a request in progress that cancels it).\n       *\n       * @param _new - The new debounced function.\n       * @param old - The previous debounced function.\n       * @internal\n       */\n      watch(\n        emitQueryPreviewRequestUpdated,\n        (_new: DebouncedFunction<[SearchRequest]>, old: DebouncedFunction<[SearchRequest]>) => {\n          old.cancel();\n        }\n      );\n\n      const queryPreviewResultsStatus = computed(() => queryPreviewResults.value?.status);\n\n      /**\n       * Emits an event when the query results are loaded or fail to load.\n       *\n       * @param status - The status of the query preview request.\n       */\n      watch(queryPreviewResultsStatus, () => {\n        if (queryPreviewResultsStatus.value === 'success') {\n          emit(results.value?.length ? 'load' : 'error', queryPreviewHash.value);\n        } else if (queryPreviewResultsStatus.value === 'error') {\n          emit('error', queryPreviewHash.value);\n        }\n      });\n\n      const hasResults = computed(() => (queryPreviewResults.value?.totalResults ?? 0) > 0);\n\n      /**\n       * Render function to execute the `default` slot, binding `slotsProps` and getting only the\n       * first `vNode` to avoid Fragments and Text root nodes.\n       * If there are no results, nothing is rendered.\n       *\n       * @remarks `slotProps` must be values without Vue reactivity and located inside the\n       * render-function to update the binding data properly.\n       *\n       * @returns The root `vNode` of the `default` slot or empty string if there are no results.\n       */\n      function renderDefaultSlot() {\n        const slotProps = {\n          queryPreviewInfo: props.queryPreviewInfo,\n          results: queryPreviewResults.value?.results,\n          totalResults: queryPreviewResults.value?.totalResults,\n          displayTagging: queryPreviewResults.value?.displayTagging,\n          queryTagging: queryPreviewResults.value?.queryTagging\n        };\n\n        return hasResults.value ? slots.default?.(slotProps)[0] : '';\n      }\n\n      /* Hack to render through a render-function, the `default` slot or, in its absence,\n       the component itself. It is the alternative for the NoElement antipattern. */\n      const componentProps = { hasResults, queryPreviewResults };\n      return (slots.default ? renderDefaultSlot : componentProps) as typeof componentProps;\n    }\n  });\n</script>\n<docs lang=\"mdx\">\n## Events\n\nA list of events that the component will emit:\n\n- [`QueryPreviewRequestUpdated`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts):\n  the event is emitted when the component is mounted and when the properties of the request object\n  changes. The event payload is the `queryPreviewRequest` object.\n\n## Vue Events\n\nA list of vue events that the component will emit:\n\n- `load`: the event is emitted when the query results have been loaded.\n- `error`: the event is emitted if there is some error when retrieving the query results.\n\n## See it in action\n\nHere you have a basic example of how the QueryPreview is rendered. Keep in mind that this component\nis intended to be used overriding its default slot. By default it will only render the names of the\nresults.\n\n```vue live\n<template>\n  <QueryPreview :queryPreviewInfo=\"queryPreviewInfo\" />\n</template>\n\n<script>\n  import { QueryPreview } from '@empathyco/x-components/queries-preview';\n\n  export default {\n    name: 'QueryPreviewDemo',\n    components: {\n      QueryPreview\n    },\n    data() {\n      return {\n        queryPreviewInfo: { query: 'sandals' }\n      };\n    }\n  };\n</script>\n```\n\n### Play with the default slot\n\nIn this example, the results will be rendered inside a sliding panel.\n\n```vue live\n<template>\n  <QueryPreview :queryPreviewInfo=\"queryPreviewInfo\" #default=\"{ totalResults, results }\">\n    <section>\n      <p>Total results: {{ totalResults }}</p>\n      <SlidingPanel :resetOnContentChange=\"false\">\n        <article\n          v-for=\"result in results\"\n          :key=\"result.id\"\n          class=\"x-result\"\n          style=\"max-width: 300px; overflow: hidden\"\n        >\n          <BaseResultLink :result=\"result\">\n            <BaseResultImage :result=\"result\" class=\"x-result__picture\" />\n          </BaseResultLink>\n          <div class=\"x-result__description\">\n            <BaseResultLink :result=\"result\">\n              <h1 class=\"x-title3\">{{ result.name }}</h1>\n            </BaseResultLink>\n          </div>\n        </article>\n      </SlidingPanel>\n    </section>\n  </QueryPreview>\n</template>\n\n<script>\n  import { QueryPreview } from '@empathyco/x-components/queries-preview';\n  import { BaseResultImage, BaseResultLink, SlidingPanel } from '@empathyco/x-components';\n\n  export default {\n    name: 'QueryPreviewDemoOverridingSlot',\n    components: {\n      BaseResultImage,\n      BaseResultLink,\n      QueryPreview,\n      SlidingPanel\n    },\n    data() {\n      return {\n        queryPreviewInfo: { query: 'flip-flops' }\n      };\n    }\n  };\n</script>\n```\n\n### Play with the result slot\n\nThe component exposes a slot to override the result content, without modifying the list.\n\nIn this example, the ID of the results will be rendered along with the name.\n\n```vue\n<template>\n  <QueryPreview :queryPreviewInfo=\"queryPreviewInfo\" #result=\"{ result }\">\n    <span>{{ result.id }}</span>\n    <span>{{ result.name }}</span>\n  </QueryPreview>\n</template>\n\n<script>\n  import { QueryPreview } from '@empathyco/x-components/queries-preview';\n\n  export default {\n    name: 'QueryPreviewDemoOverridingResultSlot',\n    components: {\n      QueryPreview\n    },\n    data() {\n      return {\n        queryPreviewInfo: { query: 'flip-flops' }\n      };\n    }\n  };\n</script>\n```\n\n### Play with props\n\nIn this example, the query preview has been limited to render a maximum of 4 results.\n\n```vue\n<template>\n  <QueryPreview\n    :maxItemsToRender=\"maxItemsToRender\"\n    :queryPreviewInfo=\"queryPreviewInfo\"\n    #default=\"{ results }\"\n  >\n    <BaseGrid #default=\"{ item }\" :items=\"results\">\n      <BaseResultLink :result=\"item\">\n        <BaseResultImage :result=\"item\" />\n      </BaseResultLink>\n    </BaseGrid>\n  </QueryPreview>\n</template>\n\n<script>\n  import { BaseGrid, BaseResultImage, BaseResultLink } from '@empathyco/x-components';\n  import { QueryPreview } from '@empathyco/x-components/queries-preview';\n\n  export default {\n    name: 'QueryPreviewDemo',\n    components: {\n      BaseGrid,\n      BaseResultImage,\n      BaseResultLink,\n      QueryPreview\n    },\n    data() {\n      return {\n        maxItemsToRender: 4,\n        queryPreviewInfo: { query: 'flip-flops' }\n      };\n    }\n  };\n</script>\n```\n</docs>\n"],"names":["_openBlock","_createElementBlock","_Fragment","_renderList","_createCommentVNode","_renderSlot"],"mappings":";;;;MACwB,UAAU,GAAA;AAAA,EAAgB,GAAK,EAAA,CAAA;AAAA,EAAA,WAAA,EAAA,eAAA;;;;AAArD,SAAA,WAAA,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAeK,QAfL,KAeK,EAAA,QAAA,EAAA;4DAdH,IAaK,EAAA,UAAA,EAAA;AAAA,KAAAA,SAAA,CAXG,IAAO,CAAE,EAAAC,kBAAA;AAAA,MAAAC,QAAA;AAAA,MAAA,IAAA;AAAA,MAAAC,UAAA,CAAA,IAAA,CAAA,mBAAA,EAAA,OAAA,EAAA,CAAA,MAAA,KAAA;AACV,QAAA,OAAAH,SAAA,EAAwB,EAAAC,kBAAA,CAAA,IAAA,EAAA;AAAA,UAC7B,GAAS,EAAA,MAAA,CAAA,EAAA;AAAA,UAAA,KAAA,EAAA,uBAAA;AAET,UAAA,WAAA,EAAA,oBAAA;AAAA,SAIA,EAAA;AAAA,UAAAG,kBAAA,CACE,+GAA4C,CAAA;AAAA,UAAAC,UAAA,CAAA,IAAA,CAAA,MAAA,EAAA,QAAA,EAAA,EAAA,MAAA,EAAA,EAAA,MAAA;;;;;;;;;;AAbpD,OAAA,CAAA;AAAA,MAAA,GAAA;AAAA;AAAA,KAAA;AAAA,GAAA,CAAA,IAAAD,kBAAA,CAAA,MAAA,EAAA,IAAA,CAAA,CAAA;;;;;;"}