@empathyco/x-components 6.0.0-alpha.18 → 6.0.0-alpha.181

package/js/x-modules/semantic-queries/wiring.js

@@ -1,86 +1,91 @@
 import { namespacedWireCommit, namespacedWireDispatch } from '../../wiring/namespaced-wires.factory.js';
-import { createWiring } from '../../wiring/wiring.utils.js';
 import { mapWire } from '../../wiring/wires.operators.js';
+import { createWiring } from '../../wiring/wiring.utils.js';
 
-/**
- * `semanticQueries` {@link XModuleName | name}.
- *
- * @internal
- */
-const moduleName = 'semanticQueries';
-/**
- * WireCommit for {@link SemanticQueriesXModule}.
- *
- * @internal
- */
-const wireCommit = namespacedWireCommit(moduleName);
-/**
- * WireDispatch for {@link SemanticQueriesXModule}.
- *
- * @internal
- */
-const wireDispatch = namespacedWireDispatch(moduleName);
-/**
- * Requests and stores the semantic query results.
- *
- * @public
- */
-const fetchAndSaveSemanticQueryWire = wireDispatch('fetchAndSaveSemanticQuery');
-/**
- * Sets the query.
- *
- * @public
- */
-const setQueryWire = wireCommit('setQuery');
-/**
- * Sets the query taking the {@link SearchXEvents.SearchResponseChanged} payload.
- *
- * @public
- */
-const setQueryFromSearchResponseChangedWire = mapWire(setQueryWire, ({ request: { query } }) => query);
-/**
- * Clears the query.
- *
- * @public
- */
-const clearQueryWire = wireCommit('setQuery', '');
-/**
- * Sets the total results.
- *
- * @public
- */
-const setTotalResultsWire = wireCommit('setTotalResults');
-/**
- * Sets the total results taking the {@link SearchXEvents.SearchResponseChanged} payload.
- *
- * @public
- */
-const setTotalResultsFromSearchResponseChangedWire = mapWire(setTotalResultsWire, ({ totalResults }) => totalResults);
-/**
- * Sets the semantic queries state `params`.
- *
- * @public
- */
-const setSemanticQueriesExtraParamsWire = wireCommit('setParams');
-/**
- * Wiring configuration for the {@link SemanticQueriesXModule | semanticQueries module}.
- *
- * @internal
- */
-const semanticQueriesWiring = createWiring({
-    UserClearedQuery: {
-        clearQueryWire
-    },
-    SemanticQueryRequestUpdated: {
-        fetchAndSaveSemanticQueryWire
-    },
-    ExtraParamsChanged: {
-        setSemanticQueriesExtraParamsWire
-    },
-    SearchResponseChanged: {
-        setQueryFromSearchResponseChangedWire,
-        setTotalResultsFromSearchResponseChangedWire
-    }
+/**
+ * `semanticQueries` {@link XModuleName | name}.
+ *
+ * @internal
+ */
+const moduleName = 'semanticQueries';
+/**
+ * WireCommit for {@link SemanticQueriesXModule}.
+ *
+ * @internal
+ */
+const wireCommit = namespacedWireCommit(moduleName);
+/**
+ * WireDispatch for {@link SemanticQueriesXModule}.
+ *
+ * @internal
+ */
+const wireDispatch = namespacedWireDispatch(moduleName);
+/**
+ * Requests and stores the semantic query results.
+ *
+ * @public
+ */
+const fetchAndSaveSemanticQueryWire = wireDispatch('fetchAndSaveSemanticQuery');
+/**
+ * Sets the query.
+ *
+ * @public
+ */
+const setQueryWire = wireCommit('setQuery');
+/**
+ * Sets the query taking the {@link SearchXEvents.SearchResponseChanged} payload.
+ *
+ * @public
+ */
+const setQueryFromSearchResponseChangedWire = mapWire(setQueryWire, ({ request: { query } }) => query);
+/**
+ * Clears the query.
+ *
+ * @public
+ */
+const clearQueryWire = wireCommit('setQuery', '');
+/**
+ * Sets the total results.
+ *
+ * @public
+ */
+const setTotalResultsWire = wireCommit('setTotalResults');
+/** Sets the related prompts state `relatedTags`. */
+const setSemanticQueriesRelatedTags = wireCommit('setSemanticQueriesRelatedTags');
+/**
+ * Sets the total results taking the {@link SearchXEvents.SearchResponseChanged} payload.
+ *
+ * @public
+ */
+const setTotalResultsFromSearchResponseChangedWire = mapWire(setTotalResultsWire, ({ totalResults }) => totalResults);
+/**
+ * Sets the semantic queries state `params`.
+ *
+ * @public
+ */
+const setSemanticQueriesExtraParamsWire = wireCommit('setParams');
+/**
+ * Wiring configuration for the {@link SemanticQueriesXModule | semanticQueries module}.
+ *
+ * @internal
+ */
+const semanticQueriesWiring = createWiring({
+    UserClearedQuery: {
+        clearQueryWire,
+    },
+    SemanticQueryRequestUpdated: {
+        fetchAndSaveSemanticQueryWire,
+    },
+    ExtraParamsChanged: {
+        setSemanticQueriesExtraParamsWire,
+    },
+    SearchResponseChanged: {
+        setQueryFromSearchResponseChangedWire,
+        setTotalResultsFromSearchResponseChangedWire,
+    },
+    SelectedRelatedTagsChanged: {
+        setSemanticQueriesRelatedTags,
+    },
 });
 
 export { clearQueryWire, fetchAndSaveSemanticQueryWire, semanticQueriesWiring, setQueryFromSearchResponseChangedWire, setQueryWire, setSemanticQueriesExtraParamsWire, setTotalResultsFromSearchResponseChangedWire, setTotalResultsWire };

package/js/x-modules/semantic-queries/wiring.js.map

@@ -1 +1 @@
-{"version":3,"file":"wiring.js","sources":["../../../../src/x-modules/semantic-queries/wiring.ts"],"sourcesContent":["import {\n  namespacedWireCommit,\n  namespacedWireDispatch\n} from '../../wiring/namespaced-wires.factory';\nimport { createWiring } from '../../wiring/wiring.utils';\nimport { mapWire } from '../../wiring/wires.operators';\nimport { SearchXEvents } from '../search/events.types';\nimport { ExtractMutationPayload } from '../../store/store.types';\n\n/**\n * `semanticQueries` {@link XModuleName | name}.\n *\n * @internal\n */\nconst moduleName = 'semanticQueries';\n\n/**\n * WireCommit for {@link SemanticQueriesXModule}.\n *\n * @internal\n */\nconst wireCommit = namespacedWireCommit(moduleName);\n\n/**\n * WireDispatch for {@link SemanticQueriesXModule}.\n *\n * @internal\n */\nconst wireDispatch = namespacedWireDispatch(moduleName);\n\n/**\n * Requests and stores the semantic query results.\n *\n * @public\n */\nexport const fetchAndSaveSemanticQueryWire = wireDispatch('fetchAndSaveSemanticQuery');\n\n/**\n * Sets the query.\n *\n * @public\n */\nexport const setQueryWire = wireCommit('setQuery');\n\n/**\n * Sets the query taking the {@link SearchXEvents.SearchResponseChanged} payload.\n *\n * @public\n */\nexport const setQueryFromSearchResponseChangedWire = mapWire<\n  SearchXEvents['SearchResponseChanged'],\n  ExtractMutationPayload<'semanticQueries', 'setQuery'>\n>(setQueryWire, ({ request: { query } }) => query);\n\n/**\n * Clears the query.\n *\n * @public\n */\nexport const clearQueryWire = wireCommit('setQuery', '');\n\n/**\n * Sets the total results.\n *\n * @public\n */\nexport const setTotalResultsWire = wireCommit('setTotalResults');\n\n/**\n * Sets the total results taking the {@link SearchXEvents.SearchResponseChanged} payload.\n *\n * @public\n */\nexport const setTotalResultsFromSearchResponseChangedWire = mapWire<\n  SearchXEvents['SearchResponseChanged'],\n  ExtractMutationPayload<'semanticQueries', 'setTotalResults'>\n>(setTotalResultsWire, ({ totalResults }) => totalResults);\n\n/**\n * Sets the semantic queries state `params`.\n *\n * @public\n */\nexport const setSemanticQueriesExtraParamsWire = wireCommit('setParams');\n\n/**\n * Wiring configuration for the {@link SemanticQueriesXModule | semanticQueries module}.\n *\n * @internal\n */\nexport const semanticQueriesWiring = createWiring({\n  UserClearedQuery: {\n    clearQueryWire\n  },\n  SemanticQueryRequestUpdated: {\n    fetchAndSaveSemanticQueryWire\n  },\n  ExtraParamsChanged: {\n    setSemanticQueriesExtraParamsWire\n  },\n  SearchResponseChanged: {\n    setQueryFromSearchResponseChangedWire,\n    setTotalResultsFromSearchResponseChangedWire\n  }\n});\n"],"names":[],"mappings":";;;;AASA;;;;AAIG;AACH,MAAM,UAAU,GAAG,iBAAiB,CAAC;AAErC;;;;AAIG;AACH,MAAM,UAAU,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC;AAEpD;;;;AAIG;AACH,MAAM,YAAY,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;AAExD;;;;AAIG;MACU,6BAA6B,GAAG,YAAY,CAAC,2BAA2B,EAAE;AAEvF;;;;AAIG;MACU,YAAY,GAAG,UAAU,CAAC,UAAU,EAAE;AAEnD;;;;AAIG;MACU,qCAAqC,GAAG,OAAO,CAG1D,YAAY,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,KAAK,EAAE;AAEnD;;;;AAIG;AACU,MAAA,cAAc,GAAG,UAAU,CAAC,UAAU,EAAE,EAAE,EAAE;AAEzD;;;;AAIG;MACU,mBAAmB,GAAG,UAAU,CAAC,iBAAiB,EAAE;AAEjE;;;;AAIG;AACU,MAAA,4CAA4C,GAAG,OAAO,CAGjE,mBAAmB,EAAE,CAAC,EAAE,YAAY,EAAE,KAAK,YAAY,EAAE;AAE3D;;;;AAIG;MACU,iCAAiC,GAAG,UAAU,CAAC,WAAW,EAAE;AAEzE;;;;AAIG;AACI,MAAM,qBAAqB,GAAG,YAAY,CAAC;AAChD,IAAA,gBAAgB,EAAE;QAChB,cAAc;AACf,KAAA;AACD,IAAA,2BAA2B,EAAE;QAC3B,6BAA6B;AAC9B,KAAA;AACD,IAAA,kBAAkB,EAAE;QAClB,iCAAiC;AAClC,KAAA;AACD,IAAA,qBAAqB,EAAE;QACrB,qCAAqC;QACrC,4CAA4C;AAC7C,KAAA;AACF,CAAA;;;;"}
+{"version":3,"file":"wiring.js","sources":["../../../../src/x-modules/semantic-queries/wiring.ts"],"sourcesContent":["import type { ExtractMutationPayload } from '../../store/store.types'\nimport type { SearchXEvents } from '../search/events.types'\nimport { namespacedWireCommit, namespacedWireDispatch } from '../../wiring/namespaced-wires.factory'\nimport { mapWire } from '../../wiring/wires.operators'\nimport { createWiring } from '../../wiring/wiring.utils'\n\n/**\n * `semanticQueries` {@link XModuleName | name}.\n *\n * @internal\n */\nconst moduleName = 'semanticQueries'\n\n/**\n * WireCommit for {@link SemanticQueriesXModule}.\n *\n * @internal\n */\nconst wireCommit = namespacedWireCommit(moduleName)\n\n/**\n * WireDispatch for {@link SemanticQueriesXModule}.\n *\n * @internal\n */\nconst wireDispatch = namespacedWireDispatch(moduleName)\n\n/**\n * Requests and stores the semantic query results.\n *\n * @public\n */\nexport const fetchAndSaveSemanticQueryWire = wireDispatch('fetchAndSaveSemanticQuery')\n\n/**\n * Sets the query.\n *\n * @public\n */\nexport const setQueryWire = wireCommit('setQuery')\n\n/**\n * Sets the query taking the {@link SearchXEvents.SearchResponseChanged} payload.\n *\n * @public\n */\nexport const setQueryFromSearchResponseChangedWire = mapWire<\n  SearchXEvents['SearchResponseChanged'],\n  ExtractMutationPayload<'semanticQueries', 'setQuery'>\n>(setQueryWire, ({ request: { query } }) => query)\n\n/**\n * Clears the query.\n *\n * @public\n */\nexport const clearQueryWire = wireCommit('setQuery', '')\n\n/**\n * Sets the total results.\n *\n * @public\n */\nexport const setTotalResultsWire = wireCommit('setTotalResults')\n\n/** Sets the related prompts state `relatedTags`. */\nconst setSemanticQueriesRelatedTags = wireCommit('setSemanticQueriesRelatedTags')\n\n/**\n * Sets the total results taking the {@link SearchXEvents.SearchResponseChanged} payload.\n *\n * @public\n */\nexport const setTotalResultsFromSearchResponseChangedWire = mapWire<\n  SearchXEvents['SearchResponseChanged'],\n  ExtractMutationPayload<'semanticQueries', 'setTotalResults'>\n>(setTotalResultsWire, ({ totalResults }) => totalResults)\n\n/**\n * Sets the semantic queries state `params`.\n *\n * @public\n */\nexport const setSemanticQueriesExtraParamsWire = wireCommit('setParams')\n\n/**\n * Wiring configuration for the {@link SemanticQueriesXModule | semanticQueries module}.\n *\n * @internal\n */\nexport const semanticQueriesWiring = createWiring({\n  UserClearedQuery: {\n    clearQueryWire,\n  },\n  SemanticQueryRequestUpdated: {\n    fetchAndSaveSemanticQueryWire,\n  },\n  ExtraParamsChanged: {\n    setSemanticQueriesExtraParamsWire,\n  },\n  SearchResponseChanged: {\n    setQueryFromSearchResponseChangedWire,\n    setTotalResultsFromSearchResponseChangedWire,\n  },\n  SelectedRelatedTagsChanged: {\n    setSemanticQueriesRelatedTags,\n  },\n})\n"],"names":[],"mappings":";;;;AAMA;;;;AAIG;AACH,MAAM,UAAU,GAAG,iBAAiB,CAAA;AAEpC;;;;AAIG;AACH,MAAM,UAAU,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAA;AAEnD;;;;AAIG;AACH,MAAM,YAAY,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAA;AAEvD;;;;AAIG;MACU,6BAA6B,GAAG,YAAY,CAAC,2BAA2B,EAAC;AAEtF;;;;AAIG;MACU,YAAY,GAAG,UAAU,CAAC,UAAU,EAAC;AAElD;;;;AAIG;MACU,qCAAqC,GAAG,OAAO,CAG1D,YAAY,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,KAAK,KAAK,EAAC;AAElD;;;;AAIG;AACU,MAAA,cAAc,GAAG,UAAU,CAAC,UAAU,EAAE,EAAE,EAAC;AAExD;;;;AAIG;MACU,mBAAmB,GAAG,UAAU,CAAC,iBAAiB,EAAC;AAEhE;AACA,MAAM,6BAA6B,GAAG,UAAU,CAAC,+BAA+B,CAAC,CAAA;AAEjF;;;;AAIG;AACU,MAAA,4CAA4C,GAAG,OAAO,CAGjE,mBAAmB,EAAE,CAAC,EAAE,YAAY,EAAE,KAAK,YAAY,EAAC;AAE1D;;;;AAIG;MACU,iCAAiC,GAAG,UAAU,CAAC,WAAW,EAAC;AAExE;;;;AAIG;AACI,MAAM,qBAAqB,GAAG,YAAY,CAAC;AAChD,IAAA,gBAAgB,EAAE;QAChB,cAAc;AACf,KAAA;AACD,IAAA,2BAA2B,EAAE;QAC3B,6BAA6B;AAC9B,KAAA;AACD,IAAA,kBAAkB,EAAE;QAClB,iCAAiC;AAClC,KAAA;AACD,IAAA,qBAAqB,EAAE;QACrB,qCAAqC;QACrC,4CAA4C;AAC7C,KAAA;AACD,IAAA,0BAA0B,EAAE;QAC1B,6BAA6B;AAC9B,KAAA;AACF,CAAA;;;;"}

package/js/x-modules/semantic-queries/x-module.js

@@ -3,18 +3,18 @@ import { semanticQueriesEmitters } from './store/emitters.js';
 import { semanticQueriesXStoreModule } from './store/module.js';
 import { semanticQueriesWiring } from './wiring.js';
 
-/**
- * SemanticQueries {@link XModule} implementation. This module is auto-registered as soon as you
- * import any component from the `semantic-queries`entry point.
- *
- * @public
- */
-const semanticQueriesXModule = {
-    name: 'semanticQueries',
-    storeModule: semanticQueriesXStoreModule,
-    storeEmitters: semanticQueriesEmitters,
-    wiring: semanticQueriesWiring
-};
+/**
+ * SemanticQueries {@link XModule} implementation. This module is auto-registered as soon as you
+ * import any component from the `semantic-queries`entry point.
+ *
+ * @public
+ */
+const semanticQueriesXModule = {
+    name: 'semanticQueries',
+    storeModule: semanticQueriesXStoreModule,
+    storeEmitters: semanticQueriesEmitters,
+    wiring: semanticQueriesWiring,
+};
 XPlugin.registerXModule(semanticQueriesXModule);
 
 export { semanticQueriesXModule };

package/js/x-modules/semantic-queries/x-module.js.map

@@ -1 +1 @@
-{"version":3,"file":"x-module.js","sources":["../../../../src/x-modules/semantic-queries/x-module.ts"],"sourcesContent":["import { XPlugin } from '../../plugins/x-plugin';\nimport { XModule } from '../x-modules.types';\nimport { semanticQueriesEmitters } from './store/emitters';\nimport { semanticQueriesXStoreModule } from './store/module';\nimport { SemanticQueriesXStoreModule } from './store/types';\nimport { semanticQueriesWiring } from './wiring';\n\n/**\n * SemanticQueries {@link XModule} alias.\n *\n * @public\n */\nexport type SemanticQueriesXModule = XModule<SemanticQueriesXStoreModule>;\n\n/**\n * SemanticQueries {@link XModule} implementation. This module is auto-registered as soon as you\n * import any component from the `semantic-queries`entry point.\n *\n * @public\n */\nexport const semanticQueriesXModule: SemanticQueriesXModule = {\n  name: 'semanticQueries',\n  storeModule: semanticQueriesXStoreModule,\n  storeEmitters: semanticQueriesEmitters,\n  wiring: semanticQueriesWiring\n};\n\nXPlugin.registerXModule(semanticQueriesXModule);\n"],"names":[],"mappings":";;;;;AAcA;;;;;AAKG;AACU,MAAA,sBAAsB,GAA2B;AAC5D,IAAA,IAAI,EAAE,iBAAiB;AACvB,IAAA,WAAW,EAAE,2BAA2B;AACxC,IAAA,aAAa,EAAE,uBAAuB;AACtC,IAAA,MAAM,EAAE,qBAAqB;EAC7B;AAEF,OAAO,CAAC,eAAe,CAAC,sBAAsB,CAAC;;;;"}
+{"version":3,"file":"x-module.js","sources":["../../../../src/x-modules/semantic-queries/x-module.ts"],"sourcesContent":["import type { XModule } from '../x-modules.types'\nimport type { SemanticQueriesXStoreModule } from './store/types'\nimport { XPlugin } from '../../plugins/x-plugin'\nimport { semanticQueriesEmitters } from './store/emitters'\nimport { semanticQueriesXStoreModule } from './store/module'\nimport { semanticQueriesWiring } from './wiring'\n\n/**\n * SemanticQueries {@link XModule} alias.\n *\n * @public\n */\nexport type SemanticQueriesXModule = XModule<SemanticQueriesXStoreModule>\n\n/**\n * SemanticQueries {@link XModule} implementation. This module is auto-registered as soon as you\n * import any component from the `semantic-queries`entry point.\n *\n * @public\n */\nexport const semanticQueriesXModule: SemanticQueriesXModule = {\n  name: 'semanticQueries',\n  storeModule: semanticQueriesXStoreModule,\n  storeEmitters: semanticQueriesEmitters,\n  wiring: semanticQueriesWiring,\n}\n\nXPlugin.registerXModule(semanticQueriesXModule)\n"],"names":[],"mappings":";;;;;AAcA;;;;;AAKG;AACU,MAAA,sBAAsB,GAA2B;AAC5D,IAAA,IAAI,EAAE,iBAAiB;AACvB,IAAA,WAAW,EAAE,2BAA2B;AACxC,IAAA,aAAa,EAAE,uBAAuB;AACtC,IAAA,MAAM,EAAE,qBAAqB;EAC9B;AAED,OAAO,CAAC,eAAe,CAAC,sBAAsB,CAAC;;;;"}

package/js/x-modules/tagging/components/tagging.vue.js

@@ -1,103 +1,103 @@
 import { defineComponent, inject, computed, onMounted, watch } from 'vue';
-import { taggingXModule } from '../x-module.js';
 import { useXBus } from '../../../composables/use-x-bus.js';
+import { taggingXModule } from '../x-module.js';
 
-/**
- * This component enables and manages the sending of information to the
- * [Empathy Tagging API](https://docs.empathy.co/develop-empathy-platform/api-reference/tagging-api.html).
- * It allows you to activate or deactivate the session id management through the `consent` prop.
- *
- * @public
- */
-var _sfc_main = defineComponent({
-    name: 'Tagging',
-    xModule: taggingXModule.name,
-    props: {
-        /**
-         * The TTL in milliseconds for storing the clicked result info.
-         */
-        clickedResultStorageTTLMs: {
-            type: Number,
-            default: 30000
-        },
-        /**
-         * The Object key of the {@link @empathyco/x-types#Result} clicked by the user
-         * that will be used as id for the storage. By default, the Result url will be used.
-         */
-        clickedResultStorageKey: {
-            type: String,
-            default: 'url'
-        },
-        /**
-         * The session TTL in milliseconds.
-         */
-        sessionTTLMs: Number,
-        /**
-         * The debounce time in milliseconds to track the query.
-         */
-        queryTaggingDebounceMs: {
-            type: Number,
-            default: 2000
-        },
-        /**
-         * The consent to be emitted.
-         */
-        consent: {
-            type: Boolean,
-            default: null
-        }
-    },
-    setup(props) {
-        const xBus = useXBus();
-        /**
-         * It injects {@link SnippetConfig} provided by an ancestor as snippetConfig.
-         */
-        const snippetConfig = inject('snippetConfig');
-        /**
-         * The active consent, selected from the `consent` prop and the `snippetConfig.consent`
-         * property. False by default.
-         *
-         * @remarks If the consent is undefined in the prop and in the snippetConfig, it will return
-         * false.
-         *
-         * @returns A boolean that represents if the consent is accepted or not.
-         */
-        const activeConsent = computed(() => props.consent ?? snippetConfig?.consent ?? false);
-        /**
-         * The tagging config to be emitted.
-         */
-        const taggingConfig = computed(() => {
-            return {
-                queryTaggingDebounceMs: props.queryTaggingDebounceMs,
-                sessionTTLMs: props.sessionTTLMs,
-                clickedResultStorageTTLMs: props.clickedResultStorageTTLMs,
-                clickedResultStorageKey: props.clickedResultStorageKey
-            };
-        });
-        /**
-         * Emits the {@link TaggingXEvents.PDPIsLoaded} XEvent if the snippet config contains
-         * a product id.
-         */
-        onMounted(() => {
-            if (snippetConfig?.productId) {
-                xBus.emit('PDPIsLoaded', snippetConfig.productId);
-            }
-        });
-        /**
-         * Emmits the consent when it changes.
-         */
-        watch(activeConsent, () => xBus.emit('ConsentProvided', activeConsent.value), {
-            immediate: true
-        });
-        /**
-         * Emmits the tagging config when it changes.
-         */
-        watch(taggingConfig, () => xBus.emit('TaggingConfigProvided', taggingConfig.value), {
-            immediate: true
-        });
-        // eslint-disable-next-line @typescript-eslint/no-empty-function
-        return () => { };
-    }
+/**
+ * This component enables and manages the sending of information to the
+ * [Empathy Tagging API](https://docs.empathy.co/develop-empathy-platform/api-reference/tagging-api.html).
+ * It allows you to activate or deactivate the session id management through the `consent` prop.
+ *
+ * @public
+ */
+var _sfc_main = defineComponent({
+    name: 'Tagging',
+    xModule: taggingXModule.name,
+    props: {
+        /**
+         * The TTL in milliseconds for storing the result info.
+         */
+        storageTTLMs: {
+            type: Number,
+            default: 30000,
+        },
+        /**
+         * The Object key of the {@link @empathyco/x-types#Result} clicked or added to the cart by the user
+         * that will be used as id for the storage.
+         * By default, the Result url will be used.
+         */
+        storageKey: {
+            type: String,
+            default: 'url',
+        },
+        /**
+         * The session TTL in milliseconds.
+         */
+        sessionTTLMs: Number,
+        /**
+         * The debounce time in milliseconds to track the query.
+         */
+        queryTaggingDebounceMs: {
+            type: Number,
+            default: 2000,
+        },
+        /**
+         * The consent to be emitted.
+         */
+        consent: {
+            type: Boolean,
+            default: null,
+        },
+    },
+    setup(props) {
+        const xBus = useXBus();
+        /**
+         * It injects {@link SnippetConfig} provided by an ancestor as snippetConfig.
+         */
+        const snippetConfig = inject('snippetConfig');
+        /**
+         * The active consent, selected from the `consent` prop and the `snippetConfig.consent`
+         * property. False by default.
+         *
+         * @remarks If the consent is undefined in the prop and in the snippetConfig, it will return
+         * false.
+         *
+         * @returns A boolean that represents if the consent is accepted or not.
+         */
+        const activeConsent = computed(() => props.consent ?? snippetConfig?.consent ?? false);
+        /**
+         * The tagging config to be emitted.
+         */
+        const taggingConfig = computed(() => {
+            return {
+                queryTaggingDebounceMs: props.queryTaggingDebounceMs,
+                sessionTTLMs: props.sessionTTLMs,
+                storageTTLMs: props.storageTTLMs,
+                storageKey: props.storageKey,
+            };
+        });
+        /**
+         * Emits the {@link TaggingXEvents.PDPIsLoaded} XEvent if the snippet config contains
+         * a product id.
+         */
+        onMounted(() => {
+            if (snippetConfig?.productId) {
+                xBus.emit('PDPIsLoaded', snippetConfig.productId);
+            }
+        });
+        /**
+         * Emmits the consent when it changes.
+         */
+        watch(activeConsent, () => xBus.emit('ConsentProvided', activeConsent.value), {
+            immediate: true,
+        });
+        /**
+         * Emmits the tagging config when it changes.
+         */
+        watch(taggingConfig, () => xBus.emit('TaggingConfigProvided', taggingConfig.value), {
+            immediate: true,
+        });
+        return () => { };
+    },
 });
 
 export { _sfc_main as default };

package/js/x-modules/tagging/components/tagging.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"tagging.vue.js","sources":["../../../../../src/x-modules/tagging/components/tagging.vue"],"sourcesContent":["<script lang=\"ts\">\n  import { computed, defineComponent, inject, onMounted, watch } from 'vue';\n  import { SnippetConfig } from '../../../x-installer/api/api.types';\n  import { taggingXModule } from '../x-module';\n  import { TaggingConfig } from '../config.types';\n  import { useXBus } from '../../../composables/use-x-bus';\n  /**\n   * This component enables and manages the sending of information to the\n   * [Empathy Tagging API](https://docs.empathy.co/develop-empathy-platform/api-reference/tagging-api.html).\n   * It allows you to activate or deactivate the session id management through the `consent` prop.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'Tagging',\n    xModule: taggingXModule.name,\n    props: {\n      /**\n       * The TTL in milliseconds for storing the clicked result info.\n       */\n      clickedResultStorageTTLMs: {\n        type: Number,\n        default: 30000\n      },\n      /**\n       * The Object key of the {@link @empathyco/x-types#Result} clicked by the user\n       * that will be used as id for the storage. By default, the Result url will be used.\n       */\n      clickedResultStorageKey: {\n        type: String,\n        default: 'url'\n      },\n      /**\n       * The session TTL in milliseconds.\n       */\n      sessionTTLMs: Number,\n      /**\n       * The debounce time in milliseconds to track the query.\n       */\n      queryTaggingDebounceMs: {\n        type: Number,\n        default: 2000\n      },\n      /**\n       * The consent to be emitted.\n       */\n      consent: {\n        type: Boolean,\n        default: null\n      }\n    },\n    setup(props) {\n      const xBus = useXBus();\n\n      /**\n       * It injects {@link SnippetConfig} provided by an ancestor as snippetConfig.\n       */\n      const snippetConfig = inject<SnippetConfig | undefined>('snippetConfig');\n\n      /**\n       * The active consent, selected from the `consent` prop and the `snippetConfig.consent`\n       * property. False by default.\n       *\n       * @remarks If the consent is undefined in the prop and in the snippetConfig, it will return\n       * false.\n       *\n       * @returns A boolean that represents if the consent is accepted or not.\n       */\n      const activeConsent = computed(() => props.consent ?? snippetConfig?.consent ?? false);\n\n      /**\n       * The tagging config to be emitted.\n       */\n      const taggingConfig = computed<TaggingConfig>(() => {\n        return {\n          queryTaggingDebounceMs: props.queryTaggingDebounceMs,\n          sessionTTLMs: props.sessionTTLMs as number,\n          clickedResultStorageTTLMs: props.clickedResultStorageTTLMs,\n          clickedResultStorageKey: props.clickedResultStorageKey\n        };\n      });\n\n      /**\n       * Emits the {@link TaggingXEvents.PDPIsLoaded} XEvent if the snippet config contains\n       * a product id.\n       */\n      onMounted(() => {\n        if (snippetConfig?.productId) {\n          xBus.emit('PDPIsLoaded', snippetConfig.productId);\n        }\n      });\n\n      /**\n       * Emmits the consent when it changes.\n       */\n      watch(activeConsent, () => xBus.emit('ConsentProvided', activeConsent.value), {\n        immediate: true\n      });\n\n      /**\n       * Emmits the tagging config when it changes.\n       */\n      watch(taggingConfig, () => xBus.emit('TaggingConfigProvided', taggingConfig.value), {\n        immediate: true\n      });\n\n      // eslint-disable-next-line @typescript-eslint/no-empty-function\n      return () => {};\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nThis component emits the following events:\n\n- [`ConsentProvided`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`TaggingConfigProvided`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n\n## See it in action\n\nThis component manages the tagging of the API to track the different features. This component\ndoesn't render elements to the DOM.\n\n```vue\n<template>\n  <Tagging />\n</template>\n\n<script>\n  import { Tagging } from '@empathyco/x-components/tagging';\n\n  export default {\n    name: 'TaggingDemo',\n    components: {\n      Tagging\n    }\n  };\n</script>\n```\n\n### Play with props\n\nIn this example, the `Tagging` component will emit `ConsentProvided` with payload false by default\nif the consent is not provided, the `TaggingConfigProvided` event will be emitted only if the props\n`queryTaggingDebounceMs`, `sessionDurationMs`, `clickedResultStorageTTLMs` or\n`clickedResultStorageKey`are defined.\n\nEvery time the user clicks a result the information for the clicked product will be stored on the\nbrowser during 30 seconds which is the default value for the prop `clickedResultStorageTTLMs`. To\ndistinguish the storage information for the different results the product url will be used since\n`clickedResultStorageKey` default value is 'url'.\n\n```vue\n<template>\n  <Tagging :consent=\"true\" :queryTaggingDebounceMs=\"300\" :sessionDurationMs=\"30000\" />\n</template>\n\n<script>\n  import { Tagging } from '@empathyco/x-components/tagging';\n\n  export default {\n    name: 'TaggingDemo',\n    components: {\n      Tagging\n    }\n  };\n</script>\n```\n\nIn this example, the clicked result information will be stored on the browser during 60 seconds and\nthe product id will be used as storage key.\n\n```vue\n<template>\n  <Tagging :clickedResultStorageTTLMs=\"60000\" :clickedResultStorageKey=\"'id'\" />\n</template>\n\n<script>\n  import { Tagging } from '@empathyco/x-components/tagging';\n\n  export default {\n    name: 'TaggingDemo',\n    components: {\n      Tagging\n    }\n  };\n</script>\n```\n\n### Play with events\n\nThe `Tagging` will emit the `ConsentProvided` when the component is loaded and the consent is set by\nthe prop or getting the value from the snippet config.\n\nThe `Tagging` will emit the `TaggingConfigProvided` when the component is loaded with the new\n[`TaggingConfig`](./../../api/x-components.taggingconfig.md) using the prop values.\n</docs>\n"],"names":[],"mappings":";;;;AAME;;;;;;AAME;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,cAAc,CAAC,IAAI;AAC5B,IAAA,KAAK,EAAE;AACL;;AAEE;AACF,QAAA,yBAAyB,EAAE;AACzB,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,OAAO,EAAE,KAAI;AACd,SAAA;AACD;;;AAGE;AACF,QAAA,uBAAuB,EAAE;AACvB,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,OAAO,EAAE,KAAI;AACd,SAAA;AACD;;AAEE;AACF,QAAA,YAAY,EAAE,MAAM;AACpB;;AAEE;AACF,QAAA,sBAAsB,EAAE;AACtB,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,OAAO,EAAE,IAAG;AACb,SAAA;AACD;;AAEE;AACF,QAAA,OAAO,EAAE;AACP,YAAA,IAAI,EAAE,OAAO;AACb,YAAA,OAAO,EAAE,IAAG;AACd,SAAA;AACD,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAA;AACT,QAAA,MAAM,IAAG,GAAI,OAAO,EAAE,CAAA;AAEtB;;AAEE;AACF,QAAA,MAAM,aAAY,GAAI,MAAM,CAA4B,eAAe,CAAC,CAAA;AAExE;;;;;;;;AAQE;AACF,QAAA,MAAM,aAAY,GAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,OAAM,IAAK,aAAa,EAAE,OAAQ,IAAG,KAAK,CAAC,CAAA;AAEtF;;AAEE;AACF,QAAA,MAAM,gBAAgB,QAAQ,CAAgB,MAAM;YAClD,OAAO;gBACL,sBAAsB,EAAE,KAAK,CAAC,sBAAsB;gBACpD,YAAY,EAAE,KAAK,CAAC,YAAsB;gBAC1C,yBAAyB,EAAE,KAAK,CAAC,yBAAyB;gBAC1D,uBAAuB,EAAE,KAAK,CAAC,uBAAsB;aACtD,CAAA;AACH,SAAC,CAAC,CAAA;AAEF;;;AAGE;QACF,SAAS,CAAC,MAAM;YACd,IAAI,aAAa,EAAE,SAAS,EAAE;gBAC5B,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,aAAa,CAAC,SAAS,CAAC,CAAA;AACnD,aAAA;AACF,SAAC,CAAC,CAAA;AAEF;;AAEE;AACF,QAAA,KAAK,CAAC,aAAa,EAAE,MAAM,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE;AAC5E,YAAA,SAAS,EAAE,IAAG;AACf,SAAA,CAAC,CAAA;AAEF;;AAEE;AACF,QAAA,KAAK,CAAC,aAAa,EAAE,MAAM,IAAI,CAAC,IAAI,CAAC,uBAAuB,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE;AAClF,YAAA,SAAS,EAAE,IAAG;AACf,SAAA,CAAC,CAAA;;AAGF,QAAA,OAAO,MAAO,GAAC,CAAA;KACjB;AACD,CAAA,CAAC;;;;"}
+{"version":3,"file":"tagging.vue.js","sources":["../../../../../src/x-modules/tagging/components/tagging.vue"],"sourcesContent":["<script lang=\"ts\">\nimport type { SnippetConfig } from '../../../x-installer/api/api.types'\nimport type { TaggingConfig } from '../config.types'\nimport { computed, defineComponent, inject, onMounted, watch } from 'vue'\nimport { useXBus } from '../../../composables/use-x-bus'\nimport { taggingXModule } from '../x-module'\n/**\n * This component enables and manages the sending of information to the\n * [Empathy Tagging API](https://docs.empathy.co/develop-empathy-platform/api-reference/tagging-api.html).\n * It allows you to activate or deactivate the session id management through the `consent` prop.\n *\n * @public\n */\nexport default defineComponent({\n  name: 'Tagging',\n  xModule: taggingXModule.name,\n  props: {\n    /**\n     * The TTL in milliseconds for storing the result info.\n     */\n    storageTTLMs: {\n      type: Number,\n      default: 30000,\n    },\n    /**\n     * The Object key of the {@link @empathyco/x-types#Result} clicked or added to the cart by the user\n     * that will be used as id for the storage.\n     * By default, the Result url will be used.\n     */\n    storageKey: {\n      type: String,\n      default: 'url',\n    },\n    /**\n     * The session TTL in milliseconds.\n     */\n    sessionTTLMs: Number,\n    /**\n     * The debounce time in milliseconds to track the query.\n     */\n    queryTaggingDebounceMs: {\n      type: Number,\n      default: 2000,\n    },\n    /**\n     * The consent to be emitted.\n     */\n    consent: {\n      type: Boolean,\n      default: null,\n    },\n  },\n  setup(props) {\n    const xBus = useXBus()\n\n    /**\n     * It injects {@link SnippetConfig} provided by an ancestor as snippetConfig.\n     */\n    const snippetConfig = inject<SnippetConfig | undefined>('snippetConfig')\n\n    /**\n     * The active consent, selected from the `consent` prop and the `snippetConfig.consent`\n     * property. False by default.\n     *\n     * @remarks If the consent is undefined in the prop and in the snippetConfig, it will return\n     * false.\n     *\n     * @returns A boolean that represents if the consent is accepted or not.\n     */\n    const activeConsent = computed(() => props.consent ?? snippetConfig?.consent ?? false)\n\n    /**\n     * The tagging config to be emitted.\n     */\n    const taggingConfig = computed<TaggingConfig>(() => {\n      return {\n        queryTaggingDebounceMs: props.queryTaggingDebounceMs,\n        sessionTTLMs: props.sessionTTLMs as number,\n        storageTTLMs: props.storageTTLMs,\n        storageKey: props.storageKey,\n      }\n    })\n\n    /**\n     * Emits the {@link TaggingXEvents.PDPIsLoaded} XEvent if the snippet config contains\n     * a product id.\n     */\n    onMounted(() => {\n      if (snippetConfig?.productId) {\n        xBus.emit('PDPIsLoaded', snippetConfig.productId)\n      }\n    })\n\n    /**\n     * Emmits the consent when it changes.\n     */\n    watch(activeConsent, () => xBus.emit('ConsentProvided', activeConsent.value), {\n      immediate: true,\n    })\n\n    /**\n     * Emmits the tagging config when it changes.\n     */\n    watch(taggingConfig, () => xBus.emit('TaggingConfigProvided', taggingConfig.value), {\n      immediate: true,\n    })\n\n    return () => {}\n  },\n})\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nThis component emits the following events:\n\n- [`ConsentProvided`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`TaggingConfigProvided`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n\n## See it in action\n\nThis component manages the tagging of the API to track the different features. This component\ndoesn't render elements to the DOM.\n\n```vue\n<template>\n  <Tagging />\n</template>\n\n<script>\nimport { Tagging } from '@empathyco/x-components/tagging'\n\nexport default {\n  name: 'TaggingDemo',\n  components: {\n    Tagging,\n  },\n}\n</script>\n```\n\n### Play with props\n\nIn this example, the `Tagging` component will emit `ConsentProvided` with payload false by default\nif the consent is not provided, the `TaggingConfigProvided` event will be emitted only if the props\n`queryTaggingDebounceMs`, `sessionDurationMs`, `storageTTLMs` or `storageKey`are defined.\n\nEvery time the user clicks a result or adds a result to the cart, the information for the product\nwill be stored on the browser during 30 seconds which is the default value for the prop\n`storageTTLMs`. To distinguish the storage information for the different results the product url\nwill be used since `storageKey` default value is 'url'.\n\n```vue\n<template>\n  <Tagging :consent=\"true\" :queryTaggingDebounceMs=\"300\" :sessionDurationMs=\"30000\" />\n</template>\n\n<script>\nimport { Tagging } from '@empathyco/x-components/tagging'\n\nexport default {\n  name: 'TaggingDemo',\n  components: {\n    Tagging,\n  },\n}\n</script>\n```\n\nIn this example, the clicked or added to cart result information will be stored on the browser\nduring 60 seconds and the product id will be used as storage key\n\n```vue\n<template>\n  <Tagging :storageTTLMs=\"60000\" :storageKey=\"'id'\" />\n</template>\n\n<script>\nimport { Tagging } from '@empathyco/x-components/tagging'\n\nexport default {\n  name: 'TaggingDemo',\n  components: {\n    Tagging,\n  },\n}\n</script>\n```\n\n### Play with events\n\nThe `Tagging` will emit the `ConsentProvided` when the component is loaded and the consent is set by\nthe prop or getting the value from the snippet config.\n\nThe `Tagging` will emit the `TaggingConfigProvided` when the component is loaded with the new\n[`TaggingConfig`](./../../api/x-components.taggingconfig.md) using the prop values.\n</docs>\n"],"names":[],"mappings":";;;;AAMA;;;;;;AAME;AACF,gBAAe,eAAe,CAAC;AAC7B,IAAA,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,cAAc,CAAC,IAAI;AAC5B,IAAA,KAAK,EAAE;AACL;;AAEE;AACF,QAAA,YAAY,EAAE;AACZ,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,OAAO,EAAE,KAAK;AACf,SAAA;AACD;;;;AAIE;AACF,QAAA,UAAU,EAAE;AACV,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,OAAO,EAAE,KAAK;AACf,SAAA;AACD;;AAEE;AACF,QAAA,YAAY,EAAE,MAAM;AACpB;;AAEE;AACF,QAAA,sBAAsB,EAAE;AACtB,YAAA,IAAI,EAAE,MAAM;AACZ,YAAA,OAAO,EAAE,IAAI;AACd,SAAA;AACD;;AAEE;AACF,QAAA,OAAO,EAAE;AACP,YAAA,IAAI,EAAE,OAAO;AACb,YAAA,OAAO,EAAE,IAAI;AACd,SAAA;AACF,KAAA;AACD,IAAA,KAAK,CAAC,KAAK,EAAA;AACT,QAAA,MAAM,IAAG,GAAI,OAAO,EAAC,CAAA;AAErB;;AAEE;AACF,QAAA,MAAM,aAAY,GAAI,MAAM,CAA4B,eAAe,CAAA,CAAA;AAEvE;;;;;;;;AAQE;AACF,QAAA,MAAM,aAAY,GAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,WAAW,aAAa,EAAE,OAAM,IAAK,KAAK,CAAA,CAAA;AAErF;;AAEE;AACF,QAAA,MAAM,gBAAgB,QAAQ,CAAgB,MAAM;YAClD,OAAO;gBACL,sBAAsB,EAAE,KAAK,CAAC,sBAAsB;gBACpD,YAAY,EAAE,KAAK,CAAC,YAAsB;gBAC1C,YAAY,EAAE,KAAK,CAAC,YAAY;gBAChC,UAAU,EAAE,KAAK,CAAC,UAAU;aAC9B,CAAA;AACF,SAAC,CAAA,CAAA;AAED;;;AAGE;QACF,SAAS,CAAC,MAAM;AACd,YAAA,IAAI,aAAa,EAAE,SAAS,EAAE;gBAC5B,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,aAAa,CAAC,SAAS,CAAA,CAAA;aAClD;AACF,SAAC,CAAA,CAAA;AAED;;AAEE;AACF,QAAA,KAAK,CAAC,aAAa,EAAE,MAAM,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE;AAC5E,YAAA,SAAS,EAAE,IAAI;AAChB,SAAA,CAAA,CAAA;AAED;;AAEE;AACF,QAAA,KAAK,CAAC,aAAa,EAAE,MAAM,IAAI,CAAC,IAAI,CAAC,uBAAuB,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE;AAClF,YAAA,SAAS,EAAE,IAAI;AAChB,SAAA,CAAA,CAAA;AAED,QAAA,OAAO,MAAO,GAAA,CAAA;KACf;AACF,CAAA,CAAA;;;;"}