@empathyco/x-components 3.0.0-alpha.30 → 3.0.0-alpha.301

package/js/x-modules/tagging/components/tagging.vue_rollup-plugin-vue_script.vue.js

@@ -0,0 +1,89 @@
+import { __decorate } from 'tslib';
+import Vue from 'vue';
+import { Prop, Inject, Component } from 'vue-property-decorator';
+import { XEmit } from '../../../components/decorators/bus.decorators.js';
+import { xComponentMixin } from '../../../components/x-component.mixin.js';
+import { taggingXModule } from '../x-module.js';
+
+/**
+ * This component enables and manages the sending of information to the
+ * {@link https://docs.empathy.co/develop-empathy-platform/api-reference/tagging-api.html |
+ * Empathy Tagging API}. It allows to enable or disable the session id management through the
+ * `consent` prop.
+ *
+ * @public
+ */
+let Tagging = class Tagging extends Vue {
+    /**
+     * 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.
+     */
+    get activeConsent() {
+        return this.consent ?? this.snippetConfig?.consent ?? false;
+    }
+    get config() {
+        return {
+            queryTaggingDebounceMs: this.queryTaggingDebounceMs,
+            sessionTTLMs: this.sessionTTLMs,
+            clickedResultStorageTTLMs: this.clickedResultStorageTTLMs,
+            clickedResultStorageKey: this.clickedResultStorageKey
+        };
+    }
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    render() { }
+    /**
+     * To emit the event that PDP is loaded  just when the snippet config includes a product id.
+     */
+    created() {
+        this.emitEvents();
+    }
+    /**
+     * Emits the {@link TaggingXEvents.PDPIsLoaded} XEvent if the snippet config contains
+     * a product id.
+     *
+     * @internal
+     */
+    emitEvents() {
+        if (this.snippetConfig?.productId) {
+            this.$x.emit('PDPIsLoaded', this.snippetConfig.productId);
+        }
+    }
+};
+__decorate([
+    Prop({ default: 30000 })
+], Tagging.prototype, "clickedResultStorageTTLMs", void 0);
+__decorate([
+    Prop({ default: 'url' })
+], Tagging.prototype, "clickedResultStorageKey", void 0);
+__decorate([
+    Inject('snippetConfig')
+], Tagging.prototype, "snippetConfig", void 0);
+__decorate([
+    Prop()
+], Tagging.prototype, "sessionTTLMs", void 0);
+__decorate([
+    Prop()
+], Tagging.prototype, "queryTaggingDebounceMs", void 0);
+__decorate([
+    Prop()
+], Tagging.prototype, "consent", void 0);
+__decorate([
+    XEmit('ConsentProvided')
+], Tagging.prototype, "activeConsent", null);
+__decorate([
+    XEmit('TaggingConfigProvided')
+], Tagging.prototype, "config", null);
+Tagging = __decorate([
+    Component({
+        mixins: [xComponentMixin(taggingXModule)]
+    })
+], Tagging);
+var script = Tagging;
+
+export { script as default };
+//# sourceMappingURL=tagging.vue_rollup-plugin-vue_script.vue.js.map

package/js/x-modules/tagging/components/tagging.vue_rollup-plugin-vue_script.vue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tagging.vue_rollup-plugin-vue_script.vue.js","sources":["../../../../../src/x-modules/tagging/components/tagging.vue?rollup-plugin-vue=script.ts"],"sourcesContent":["\n  import Vue from 'vue';\n  import { Component, Inject, Prop } from 'vue-property-decorator';\n  import { XEmit } from '../../../components/decorators/bus.decorators';\n  import { xComponentMixin } from '../../../components/x-component.mixin';\n  import { SnippetConfig } from '../../../x-installer/api/api.types';\n  import { taggingXModule } from '../x-module';\n  import { TaggingConfig } from '../config.types';\n\n  /**\n   * This component enables and manages the sending of information to the\n   * {@link https://docs.empathy.co/develop-empathy-platform/api-reference/tagging-api.html |\n   * Empathy Tagging API}. It allows to enable or disable the session id management through the\n   * `consent` prop.\n   *\n   * @public\n   */\n  @Component({\n    mixins: [xComponentMixin(taggingXModule)]\n  })\n  export default class Tagging extends Vue {\n    /**\n     * The TTL in milliseconds for storing the clicked result info.\n     *\n     * @public\n     */\n    @Prop({ default: 30000 })\n    public clickedResultStorageTTLMs!: number;\n\n    /**\n     * The Object key of the {@link @empathyco/x-types#Result | 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     * @public\n     */\n    @Prop({ default: 'url' })\n    public clickedResultStorageKey!: string;\n\n    /**\n     * It injects {@link SnippetConfig} provided by an ancestor as snippetConfig.\n     *\n     * @internal\n     */\n    @Inject('snippetConfig')\n    protected snippetConfig?: SnippetConfig;\n\n    /**\n     * The session TTL in milliseconds.\n     *\n     * @internal\n     */\n    @Prop()\n    public sessionTTLMs: number | undefined;\n\n    /**\n     * The debounce time in milliseconds to track the query.\n     *\n     * @internal\n     */\n    @Prop()\n    public queryTaggingDebounceMs: number | undefined;\n\n    /**\n     * The consent to be emitted.\n     *\n     * @public\n     */\n    @Prop()\n    protected consent?: boolean;\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    @XEmit('ConsentProvided')\n    public get activeConsent(): boolean {\n      return this.consent ?? this.snippetConfig?.consent ?? false;\n    }\n\n    @XEmit('TaggingConfigProvided')\n    public get config(): TaggingConfig {\n      return {\n        queryTaggingDebounceMs: this.queryTaggingDebounceMs as number,\n        sessionTTLMs: this.sessionTTLMs as number,\n        clickedResultStorageTTLMs: this.clickedResultStorageTTLMs,\n        clickedResultStorageKey: this.clickedResultStorageKey\n      };\n    }\n\n    // eslint-disable-next-line @typescript-eslint/no-empty-function\n    render(): void {}\n\n    /**\n     * To emit the event that PDP is loaded  just when the snippet config includes a product id.\n     */\n    created(): void {\n      this.emitEvents();\n    }\n\n    /**\n     * Emits the {@link TaggingXEvents.PDPIsLoaded} XEvent if the snippet config contains\n     * a product id.\n     *\n     * @internal\n     */\n    protected emitEvents(): void {\n      if (this.snippetConfig?.productId) {\n        this.$x.emit('PDPIsLoaded', this.snippetConfig.productId);\n      }\n    }\n  }\n"],"names":[],"mappings":";;;;;;;AASE;;;;;;;AAOG;AAIY,IAAM,OAAO,GAAb,MAAM,OAAQ,SAAQ,GAAG,CAAA;AAkDtC;;;;;;;;AAQG;AAEH,IAAA,IAAW,aAAa,GAAA;QACtB,OAAO,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,aAAa,EAAE,OAAO,IAAI,KAAK,CAAC;KAC7D;AAGD,IAAA,IAAW,MAAM,GAAA;QACf,OAAO;YACL,sBAAsB,EAAE,IAAI,CAAC,sBAAgC;YAC7D,YAAY,EAAE,IAAI,CAAC,YAAsB;YACzC,yBAAyB,EAAE,IAAI,CAAC,yBAAyB;YACzD,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;SACtD,CAAC;KACH;;AAGD,IAAA,MAAM,MAAW;AAEjB;;AAEG;IACH,OAAO,GAAA;QACL,IAAI,CAAC,UAAU,EAAE,CAAC;KACnB;AAED;;;;;AAKG;IACO,UAAU,GAAA;AAClB,QAAA,IAAI,IAAI,CAAC,aAAa,EAAE,SAAS,EAAE;AACjC,YAAA,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;AAC3D,SAAA;KACF;CACF,CAAA;AAxFC,UAAA,CAAA;AADC,IAAA,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AACiB,CAAA,EAAA,OAAA,CAAA,SAAA,EAAA,2BAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAS1C,UAAA,CAAA;AADC,IAAA,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AACe,CAAA,EAAA,OAAA,CAAA,SAAA,EAAA,yBAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAQxC,UAAA,CAAA;IADC,MAAM,CAAC,eAAe,CAAC;AACgB,CAAA,EAAA,OAAA,CAAA,SAAA,EAAA,eAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAQxC,UAAA,CAAA;AADC,IAAA,IAAI,EAAE;AACiC,CAAA,EAAA,OAAA,CAAA,SAAA,EAAA,cAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAQxC,UAAA,CAAA;AADC,IAAA,IAAI,EAAE;AAC2C,CAAA,EAAA,OAAA,CAAA,SAAA,EAAA,wBAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAQlD,UAAA,CAAA;AADC,IAAA,IAAI,EAAE;AACqB,CAAA,EAAA,OAAA,CAAA,SAAA,EAAA,SAAA,EAAA,KAAA,CAAA,CAAA,CAAA;AAY5B,UAAA,CAAA;IADC,KAAK,CAAC,iBAAiB,CAAC;AAGxB,CAAA,EAAA,OAAA,CAAA,SAAA,EAAA,eAAA,EAAA,IAAA,CAAA,CAAA;AAGD,UAAA,CAAA;IADC,KAAK,CAAC,uBAAuB,CAAC;AAQ9B,CAAA,EAAA,OAAA,CAAA,SAAA,EAAA,QAAA,EAAA,IAAA,CAAA,CAAA;AAxEkB,OAAO,GAAA,UAAA,CAAA;AAH3B,IAAA,SAAS,CAAC;AACT,QAAA,MAAM,EAAE,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;KAC1C,CAAC;AACmB,CAAA,EAAA,OAAO,CA+F3B,CAAA;aA/FoB,OAAO;;;;"}

package/js/x-modules/tagging/service/pdp-add-to-cart.service.js

@@ -0,0 +1,157 @@
+import { BrowserStorageService } from '@empathyco/x-storage-service';
+import '@vue/devtools-api';
+import '../../../plugins/devtools/timeline.devtools.js';
+import '@empathyco/x-utils';
+import 'rxjs/operators';
+import 'rxjs';
+import '../../../plugins/devtools/colors.utils.js';
+import '../../../plugins/x-bus.js';
+import { XPlugin } from '../../../plugins/x-plugin.js';
+
+/**
+ * Default implementation for the {@link PDPAddToCartService}.
+ *
+ * @public
+ */
+class DefaultPDPAddToCartService {
+    constructor(localStorageService = new BrowserStorageService(localStorage, 'x'), sessionStorageService = new BrowserStorageService(sessionStorage, 'x')) {
+        this.localStorageService = localStorageService;
+        this.sessionStorageService = sessionStorageService;
+    }
+    get store() {
+        return XPlugin.store;
+    }
+    get clickedResultStorageKey() {
+        return this.store.state.x.tagging.config.clickedResultStorageKey;
+    }
+    get clickedResultStorageTTLMs() {
+        return this.store.state.x.tagging.config.clickedResultStorageTTLMs;
+    }
+    /**
+     * Stores in the local storage the information from the Result clicked by the user
+     * in order to be able to track later on.
+     *
+     * @param result - The result to store.
+     *
+     * @public
+     */
+    storeResultClicked(result) {
+        const key = result[this.clickedResultStorageKey];
+        const storageId = this.getStorageId(key);
+        if (storageId) {
+            this.localStorageService.setItem(storageId, result, this.clickedResultStorageTTLMs);
+        }
+    }
+    /**
+     * Checks if the local storage contains a result information for the given id and moves
+     * the result info from the local storage to the session storage.
+     *
+     * @param id - The id of the result to move to the session storage.
+     *
+     * @public
+     */
+    moveToSessionStorage(id) {
+        const storageId = this.getStorageId(id);
+        if (storageId) {
+            const result = this.localStorageService.removeItem(storageId);
+            if (result) {
+                this.sessionStorageService.setItem(storageId, result);
+            }
+        }
+    }
+    /**
+     * Checks if the session storage contains a result information for given id or the current url
+     * and tracks the add to cart if exists.
+     *
+     * @param id - The id of the result to track.
+     *
+     * @public
+     */
+    trackAddToCart(id) {
+        const storageId = this.clickedResultStorageKey === 'url' ? this.getStorageId() : this.getStorageId(id);
+        if (storageId) {
+            const result = this.sessionStorageService.getItem(storageId);
+            if (result?.tagging?.add2cart) {
+                result.tagging.add2cart.params.location = 'pdp';
+                this.store.dispatch('x/tagging/track', result.tagging.add2cart);
+            }
+        }
+    }
+    /**
+     * Calculates the browser storage key for the given id.
+     *
+     * @param id - The id to be used for the storage key.
+     *
+     * @returns The complete key to be used for storage.
+     *
+     * @internal
+     */
+    getStorageId(id) {
+        if (this.clickedResultStorageKey === 'url') {
+            let url = id ?? window.location.href;
+            url = url.replace(/\s|\+/g, '%20');
+            const pathName = this.getPathName(url);
+            return `${DefaultPDPAddToCartService.RESULT_CLICKED_ID_KEY}-${pathName}`;
+        }
+        else if (id) {
+            return `${DefaultPDPAddToCartService.RESULT_CLICKED_ID_KEY}-${id}`;
+        }
+        else {
+            this.showWarningMessage();
+            return null;
+        }
+    }
+    /**
+     * Logs a warning message in case the tracking cannot be done.
+     *
+     * @internal
+     */
+    showWarningMessage() {
+        if (this.clickedResultStorageKey !== 'url') {
+            //TODO: add here logger
+            //eslint-disable-next-line no-console
+            console.warn('No product id was provided but the storage was not configured to use the url');
+        }
+    }
+    /**
+     * Returns the pathname for a given url.
+     *
+     * @param url - The url to get the pathname from.
+     *
+     * @returns The pathname of the url.
+     *
+     * @internal
+     */
+    getPathName(url) {
+        let urlObject;
+        try {
+            // Check if the url is relative or absolute path
+            if (/^(\.\.\/|\.\/|\/)/.test(url)) {
+                urlObject = new URL(url, location.origin);
+            }
+            else {
+                urlObject = new URL(url);
+            }
+            return urlObject.pathname;
+        }
+        catch (e) {
+            //TODO: add here logger
+            //eslint-disable-next-line no-console
+            console.warn(`There was a problem with url ${url}`);
+            return url;
+        }
+    }
+}
+/**
+ * Session id key to use as key in the storage.
+ *
+ * @public
+ */
+DefaultPDPAddToCartService.RESULT_CLICKED_ID_KEY = 'add-to-cart';
+/**
+ * Global instance of the {@link PDPAddToCartService}.
+ */
+DefaultPDPAddToCartService.instance = new DefaultPDPAddToCartService();
+
+export { DefaultPDPAddToCartService };
+//# sourceMappingURL=pdp-add-to-cart.service.js.map

package/js/x-modules/tagging/service/pdp-add-to-cart.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pdp-add-to-cart.service.js","sources":["../../../../../src/x-modules/tagging/service/pdp-add-to-cart.service.ts"],"sourcesContent":["import { Store } from 'vuex';\nimport { Result } from '@empathyco/x-types';\nimport { BrowserStorageService, StorageService } from '@empathyco/x-storage-service';\nimport { RootXStoreState } from '../../../store/index';\nimport { XPlugin } from '../../../plugins/index';\nimport { PDPAddToCartService } from './types';\n\n/**\n * Default implementation for the {@link PDPAddToCartService}.\n *\n * @public\n */\nexport class DefaultPDPAddToCartService implements PDPAddToCartService {\n  /**\n   * Session id key to use as key in the storage.\n   *\n   * @public\n   */\n  public static readonly RESULT_CLICKED_ID_KEY = 'add-to-cart';\n\n  /**\n   * Global instance of the {@link PDPAddToCartService}.\n   */\n  public static instance: PDPAddToCartService = new DefaultPDPAddToCartService();\n\n  public constructor(\n    protected localStorageService: StorageService = new BrowserStorageService(localStorage, 'x'),\n    protected sessionStorageService: StorageService = new BrowserStorageService(sessionStorage, 'x')\n  ) {}\n\n  protected get store(): Store<RootXStoreState> {\n    return XPlugin.store;\n  }\n\n  protected get clickedResultStorageKey(): string {\n    return this.store.state.x.tagging.config.clickedResultStorageKey as string;\n  }\n\n  protected get clickedResultStorageTTLMs(): number {\n    return this.store.state.x.tagging.config.clickedResultStorageTTLMs as number;\n  }\n\n  /**\n   * Stores in the local storage the information from the Result clicked by the user\n   * in order to be able to track later on.\n   *\n   * @param result - The result to store.\n   *\n   * @public\n   */\n  storeResultClicked(result: Result): void {\n    const key = result[this.clickedResultStorageKey as keyof Result] as string;\n    const storageId = this.getStorageId(key);\n    if (storageId) {\n      this.localStorageService.setItem(storageId, result, this.clickedResultStorageTTLMs);\n    }\n  }\n\n  /**\n   * Checks if the local storage contains a result information for the given id and moves\n   * the result info from the local storage to the session storage.\n   *\n   * @param id - The id of the result to move to the session storage.\n   *\n   * @public\n   */\n  moveToSessionStorage(id?: string): void {\n    const storageId = this.getStorageId(id);\n    if (storageId) {\n      const result = this.localStorageService.removeItem(storageId);\n      if (result) {\n        this.sessionStorageService.setItem(storageId, result);\n      }\n    }\n  }\n\n  /**\n   * Checks if the session storage contains a result information for given id or the current url\n   * and tracks the add to cart if exists.\n   *\n   * @param id - The id of the result to track.\n   *\n   * @public\n   */\n  trackAddToCart(id?: string): void {\n    const storageId =\n      this.clickedResultStorageKey === 'url' ? this.getStorageId() : this.getStorageId(id);\n    if (storageId) {\n      const result = this.sessionStorageService.getItem<Result>(storageId);\n      if (result?.tagging?.add2cart) {\n        result.tagging.add2cart.params.location = 'pdp';\n        this.store.dispatch('x/tagging/track', result.tagging.add2cart);\n      }\n    }\n  }\n\n  /**\n   * Calculates the browser storage key for the given id.\n   *\n   * @param id - The id to be used for the storage key.\n   *\n   * @returns The complete key to be used for storage.\n   *\n   * @internal\n   */\n  protected getStorageId(id?: string): string | null {\n    if (this.clickedResultStorageKey === 'url') {\n      let url = id ?? window.location.href;\n      url = url.replace(/\\s|\\+/g, '%20');\n      const pathName = this.getPathName(url);\n      return `${DefaultPDPAddToCartService.RESULT_CLICKED_ID_KEY}-${pathName}`;\n    } else if (id) {\n      return `${DefaultPDPAddToCartService.RESULT_CLICKED_ID_KEY}-${id}`;\n    } else {\n      this.showWarningMessage();\n      return null;\n    }\n  }\n\n  /**\n   * Logs a warning message in case the tracking cannot be done.\n   *\n   * @internal\n   */\n  protected showWarningMessage(): void {\n    if (this.clickedResultStorageKey !== 'url') {\n      //TODO: add here logger\n      //eslint-disable-next-line no-console\n      console.warn('No product id was provided but the storage was not configured to use the url');\n    }\n  }\n\n  /**\n   * Returns the pathname for a given url.\n   *\n   * @param url - The url to get the pathname from.\n   *\n   * @returns The pathname of the url.\n   *\n   * @internal\n   */\n  protected getPathName(url: string): string {\n    let urlObject: URL;\n    try {\n      // Check if the url is relative or absolute path\n      if (/^(\\.\\.\\/|\\.\\/|\\/)/.test(url)) {\n        urlObject = new URL(url, location.origin);\n      } else {\n        urlObject = new URL(url);\n      }\n      return urlObject.pathname;\n    } catch (e) {\n      //TODO: add here logger\n      //eslint-disable-next-line no-console\n      console.warn(`There was a problem with url ${url}`);\n      return url;\n    }\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;;AAOA;;;;AAIG;MACU,0BAA0B,CAAA;AAarC,IAAA,WAAA,CACY,sBAAsC,IAAI,qBAAqB,CAAC,YAAY,EAAE,GAAG,CAAC,EAClF,qBAAA,GAAwC,IAAI,qBAAqB,CAAC,cAAc,EAAE,GAAG,CAAC,EAAA;QADtF,IAAmB,CAAA,mBAAA,GAAnB,mBAAmB,CAA+D;QAClF,IAAqB,CAAA,qBAAA,GAArB,qBAAqB,CAAiE;KAC9F;AAEJ,IAAA,IAAc,KAAK,GAAA;QACjB,OAAO,OAAO,CAAC,KAAK,CAAC;KACtB;AAED,IAAA,IAAc,uBAAuB,GAAA;AACnC,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,uBAAiC,CAAC;KAC5E;AAED,IAAA,IAAc,yBAAyB,GAAA;AACrC,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,yBAAmC,CAAC;KAC9E;AAED;;;;;;;AAOG;AACH,IAAA,kBAAkB,CAAC,MAAc,EAAA;QAC/B,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,uBAAuC,CAAW,CAAC;QAC3E,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;AACzC,QAAA,IAAI,SAAS,EAAE;AACb,YAAA,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,yBAAyB,CAAC,CAAC;AACrF,SAAA;KACF;AAED;;;;;;;AAOG;AACH,IAAA,oBAAoB,CAAC,EAAW,EAAA;QAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;AACxC,QAAA,IAAI,SAAS,EAAE;YACb,MAAM,MAAM,GAAG,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;AAC9D,YAAA,IAAI,MAAM,EAAE;gBACV,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;AACvD,aAAA;AACF,SAAA;KACF;AAED;;;;;;;AAOG;AACH,IAAA,cAAc,CAAC,EAAW,EAAA;QACxB,MAAM,SAAS,GACb,IAAI,CAAC,uBAAuB,KAAK,KAAK,GAAG,IAAI,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;AACvF,QAAA,IAAI,SAAS,EAAE;YACb,MAAM,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAS,SAAS,CAAC,CAAC;AACrE,YAAA,IAAI,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE;gBAC7B,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC;AAChD,gBAAA,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AACjE,aAAA;AACF,SAAA;KACF;AAED;;;;;;;;AAQG;AACO,IAAA,YAAY,CAAC,EAAW,EAAA;AAChC,QAAA,IAAI,IAAI,CAAC,uBAAuB,KAAK,KAAK,EAAE;YAC1C,IAAI,GAAG,GAAG,EAAE,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACrC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;AACvC,YAAA,OAAO,GAAG,0BAA0B,CAAC,qBAAqB,CAAI,CAAA,EAAA,QAAQ,EAAE,CAAC;AAC1E,SAAA;AAAM,aAAA,IAAI,EAAE,EAAE;AACb,YAAA,OAAO,GAAG,0BAA0B,CAAC,qBAAqB,CAAI,CAAA,EAAA,EAAE,EAAE,CAAC;AACpE,SAAA;AAAM,aAAA;YACL,IAAI,CAAC,kBAAkB,EAAE,CAAC;AAC1B,YAAA,OAAO,IAAI,CAAC;AACb,SAAA;KACF;AAED;;;;AAIG;IACO,kBAAkB,GAAA;AAC1B,QAAA,IAAI,IAAI,CAAC,uBAAuB,KAAK,KAAK,EAAE;;;AAG1C,YAAA,OAAO,CAAC,IAAI,CAAC,8EAA8E,CAAC,CAAC;AAC9F,SAAA;KACF;AAED;;;;;;;;AAQG;AACO,IAAA,WAAW,CAAC,GAAW,EAAA;AAC/B,QAAA,IAAI,SAAc,CAAC;QACnB,IAAI;;AAEF,YAAA,IAAI,mBAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;gBACjC,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC3C,aAAA;AAAM,iBAAA;AACL,gBAAA,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;AAC1B,aAAA;YACD,OAAO,SAAS,CAAC,QAAQ,CAAC;AAC3B,SAAA;AAAC,QAAA,OAAO,CAAC,EAAE;;;AAGV,YAAA,OAAO,CAAC,IAAI,CAAC,gCAAgC,GAAG,CAAA,CAAE,CAAC,CAAC;AACpD,YAAA,OAAO,GAAG,CAAC;AACZ,SAAA;KACF;;AAhJD;;;;AAIG;AACoB,0BAAqB,CAAA,qBAAA,GAAG,aAAa,CAAC;AAE7D;;AAEG;AACW,0BAAA,CAAA,QAAQ,GAAwB,IAAI,0BAA0B,EAAE;;;;"}

package/js/x-modules/tagging/store/actions/track.action.js

@@ -0,0 +1,43 @@
+import { DefaultSessionService } from '@empathyco/x-utils';
+import { XPlugin } from '../../../../plugins/x-plugin.js';
+
+/**
+ * Default implementation for the {@link TaggingActions.track}.
+ *
+ * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions,
+ * provided by Vuex.
+ * @param taggingInfo - The information of the event to track.
+ *
+ * @public
+ */
+const track = ({ state }, taggingInfo) => {
+    const { consent } = state;
+    const taggingInfos = Array.isArray(taggingInfo) ? taggingInfo : [taggingInfo];
+    const sessionId = getSessionId(consent);
+    // TODO EX-5061 - Remove this validation when the adapter ignores undefined values.
+    const session = sessionId && { session: sessionId };
+    taggingInfos.forEach(({ url, params }) => {
+        XPlugin.adapter.tagging({
+            url,
+            params: {
+                ...params,
+                ...session
+            }
+        });
+    });
+};
+/**
+ * Returns the session id if the consent is true.
+ *
+ * @param consent - User consent to retrieve the session id.
+ *
+ * @returns The user session id or undefined.
+ *
+ * @internal
+ */
+function getSessionId(consent) {
+    return consent ? DefaultSessionService.instance.getSessionId() : undefined;
+}
+
+export { track };
+//# sourceMappingURL=track.action.js.map

package/js/x-modules/tagging/store/actions/track.action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"track.action.js","sources":["../../../../../../src/x-modules/tagging/store/actions/track.action.ts"],"sourcesContent":["import { TaggingRequest } from '@empathyco/x-types';\nimport { DefaultSessionService } from '@empathyco/x-utils';\nimport { XPlugin } from '../../../../plugins/x-plugin';\nimport { TaggingXStoreModule } from '../types';\n\n/**\n * Default implementation for the {@link TaggingActions.track}.\n *\n * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions,\n * provided by Vuex.\n * @param taggingInfo - The information of the event to track.\n *\n * @public\n */\nexport const track: TaggingXStoreModule['actions']['track'] = ({ state }, taggingInfo) => {\n  const { consent } = state;\n  const taggingInfos = Array.isArray(taggingInfo) ? taggingInfo : [taggingInfo];\n  const sessionId = getSessionId(consent);\n  // TODO EX-5061 - Remove this validation when the adapter ignores undefined values.\n  const session = sessionId && { session: sessionId };\n\n  taggingInfos.forEach(({ url, params }: TaggingRequest) => {\n    XPlugin.adapter.tagging({\n      url,\n      params: {\n        ...params,\n        ...session\n      }\n    });\n  });\n};\n\n/**\n * Returns the session id if the consent is true.\n *\n * @param consent - User consent to retrieve the session id.\n *\n * @returns The user session id or undefined.\n *\n * @internal\n */\nfunction getSessionId(consent: boolean | null): string | undefined {\n  return consent ? DefaultSessionService.instance.getSessionId() : undefined;\n}\n"],"names":[],"mappings":";;;AAKA;;;;;;;;AAQG;AACU,MAAA,KAAK,GAA4C,CAAC,EAAE,KAAK,EAAE,EAAE,WAAW,KAAI;AACvF,IAAA,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;AAC1B,IAAA,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,WAAW,GAAG,CAAC,WAAW,CAAC,CAAC;AAC9E,IAAA,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;;IAExC,MAAM,OAAO,GAAG,SAAS,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;IAEpD,YAAY,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAkB,KAAI;AACvD,QAAA,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC;YACtB,GAAG;AACH,YAAA,MAAM,EAAE;AACN,gBAAA,GAAG,MAAM;AACT,gBAAA,GAAG,OAAO;AACX,aAAA;AACF,SAAA,CAAC,CAAC;AACL,KAAC,CAAC,CAAC;AACL,EAAE;AAEF;;;;;;;;AAQG;AACH,SAAS,YAAY,CAAC,OAAuB,EAAA;AAC3C,IAAA,OAAO,OAAO,GAAG,qBAAqB,CAAC,QAAQ,CAAC,YAAY,EAAE,GAAG,SAAS,CAAC;AAC7E;;;;"}

package/js/x-modules/tagging/store/emitters.js

@@ -1,6 +1,3 @@
-import '../../../store/x.module.js';
-import '../../../store/utils/fetch-and-save-action.utils.js';
-import '../../../store/utils/status-store.utils.js';
 import { createStoreEmitters } from '../../../store/utils/store-emitters.utils.js';
 import { taggingXStoreModule } from './module.js';
 
@@ -9,8 +6,13 @@ import { taggingXStoreModule } from './module.js';
  *
  * @internal
  */
-var taggingEmitters = createStoreEmitters(taggingXStoreModule, {
-    ConsentChanged: function (state) { return state.consent; }
+const taggingEmitters = createStoreEmitters(taggingXStoreModule, {
+    ConsentChanged: state => state.consent,
+    SearchTaggingReceived: state => state.queryTaggingInfo,
+    ResultURLTrackingEnabled: {
+        selector: state => state.config.clickedResultStorageKey,
+        filter: newValue => newValue === 'url'
+    }
 });
 
 export { taggingEmitters };

package/js/x-modules/tagging/store/emitters.js.map

@@ -1 +1 @@
-{"version":3,"file":"emitters.js","sources":["../../../../../src/x-modules/tagging/store/emitters.ts"],"sourcesContent":["import { createStoreEmitters } from '../../../store';\nimport { taggingXStoreModule } from './module';\n\n/**\n * {@link StoreEmitters} For the tagging module.\n *\n * @internal\n */\nexport const taggingEmitters = createStoreEmitters(taggingXStoreModule, {\n  ConsentChanged: state => state.consent!\n});\n"],"names":[],"mappings":";;;;;;AAGA;;;;;IAKa,eAAe,GAAG,mBAAmB,CAAC,mBAAmB,EAAE;IACtE,cAAc,EAAE,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,OAAQ,GAAA;CACxC;;;;"}
+{"version":3,"file":"emitters.js","sources":["../../../../../src/x-modules/tagging/store/emitters.ts"],"sourcesContent":["import { createStoreEmitters } from '../../../store/utils/store-emitters.utils';\nimport { taggingXStoreModule } from './module';\n\n/**\n * {@link StoreEmitters} For the tagging module.\n *\n * @internal\n */\nexport const taggingEmitters = createStoreEmitters(taggingXStoreModule, {\n  ConsentChanged: state => state.consent!,\n  SearchTaggingReceived: state => state.queryTaggingInfo!,\n  ResultURLTrackingEnabled: {\n    selector: state => state.config.clickedResultStorageKey!,\n    filter: newValue => newValue === 'url'\n  }\n});\n"],"names":[],"mappings":";;;AAGA;;;;AAIG;AACU,MAAA,eAAe,GAAG,mBAAmB,CAAC,mBAAmB,EAAE;AACtE,IAAA,cAAc,EAAE,KAAK,IAAI,KAAK,CAAC,OAAQ;AACvC,IAAA,qBAAqB,EAAE,KAAK,IAAI,KAAK,CAAC,gBAAiB;AACvD,IAAA,wBAAwB,EAAE;QACxB,QAAQ,EAAE,KAAK,IAAI,KAAK,CAAC,MAAM,CAAC,uBAAwB;AACxD,QAAA,MAAM,EAAE,QAAQ,IAAI,QAAQ,KAAK,KAAK;AACvC,KAAA;AACF,CAAA;;;;"}

package/js/x-modules/tagging/store/module.js

@@ -1,29 +1,36 @@
+import { track } from './actions/track.action.js';
+
 /**
  * {@link XStoreModule} For the tagging module.
  *
  * @internal
  */
-var taggingXStoreModule = {
-    state: function () { return ({
+const taggingXStoreModule = {
+    state: () => ({
         config: {
             sessionTTLMs: 30 * 60 * 1000,
-            queryTaggingDebounceMs: 200
+            queryTaggingDebounceMs: 2000,
+            clickedResultStorageKey: null,
+            clickedResultStorageTTLMs: null
         },
-        consent: null
-    }); },
+        consent: null,
+        queryTaggingInfo: null
+    }),
     getters: {},
     mutations: {
-        setSessionDuration: function (state, sessionTTLMs) {
-            state.config.sessionTTLMs = sessionTTLMs;
+        setConsent(state, consent) {
+            state.consent = consent;
         },
-        setQueryTaggingDebounce: function (state, queryTaggingDebounceMs) {
-            state.config.queryTaggingDebounceMs = queryTaggingDebounceMs;
+        setQueryTaggingInfo(state, queryTaggingInfo) {
+            state.queryTaggingInfo = queryTaggingInfo;
         },
-        setConsent: function (state, consent) {
-            state.consent = consent;
+        setTaggingConfig(state, taggingConfig) {
+            Object.assign(state.config, taggingConfig);
         }
     },
-    actions: {}
+    actions: {
+        track
+    }
 };
 
 export { taggingXStoreModule };

package/js/x-modules/tagging/store/module.js.map

@@ -1 +1 @@
-{"version":3,"file":"module.js","sources":["../../../../../src/x-modules/tagging/store/module.ts"],"sourcesContent":["import { TaggingXStoreModule } from './types';\n\n/**\n * {@link XStoreModule} For the tagging module.\n *\n * @internal\n */\nexport const taggingXStoreModule: TaggingXStoreModule = {\n  state: () => ({\n    config: {\n      sessionTTLMs: 30 * 60 * 1000,\n      queryTaggingDebounceMs: 200\n    },\n    consent: null\n  }),\n  getters: {},\n  mutations: {\n    setSessionDuration(state, sessionTTLMs) {\n      state.config.sessionTTLMs = sessionTTLMs;\n    },\n    setQueryTaggingDebounce(state, queryTaggingDebounceMs) {\n      state.config.queryTaggingDebounceMs = queryTaggingDebounceMs;\n    },\n    setConsent(state, consent) {\n      state.consent = consent;\n    }\n  },\n  actions: {}\n};\n"],"names":[],"mappings":"AAEA;;;;;IAKa,mBAAmB,GAAwB;IACtD,KAAK,EAAE,cAAM,QAAC;QACZ,MAAM,EAAE;YACN,YAAY,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI;YAC5B,sBAAsB,EAAE,GAAG;SAC5B;QACD,OAAO,EAAE,IAAI;KACd,IAAC;IACF,OAAO,EAAE,EAAE;IACX,SAAS,EAAE;QACT,kBAAkB,YAAC,KAAK,EAAE,YAAY;YACpC,KAAK,CAAC,MAAM,CAAC,YAAY,GAAG,YAAY,CAAC;SAC1C;QACD,uBAAuB,YAAC,KAAK,EAAE,sBAAsB;YACnD,KAAK,CAAC,MAAM,CAAC,sBAAsB,GAAG,sBAAsB,CAAC;SAC9D;QACD,UAAU,YAAC,KAAK,EAAE,OAAO;YACvB,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;SACzB;KACF;IACD,OAAO,EAAE,EAAE;;;;;"}
+{"version":3,"file":"module.js","sources":["../../../../../src/x-modules/tagging/store/module.ts"],"sourcesContent":["import { TaggingRequest } from '@empathyco/x-types';\nimport { track } from './actions/track.action';\nimport { TaggingXStoreModule } from './types';\n\n/**\n * {@link XStoreModule} For the tagging module.\n *\n * @internal\n */\nexport const taggingXStoreModule: TaggingXStoreModule = {\n  state: () => ({\n    config: {\n      sessionTTLMs: 30 * 60 * 1000,\n      queryTaggingDebounceMs: 2000,\n      clickedResultStorageKey: null,\n      clickedResultStorageTTLMs: null\n    },\n    consent: null,\n    queryTaggingInfo: null\n  }),\n  getters: {},\n  mutations: {\n    setConsent(state, consent) {\n      state.consent = consent;\n    },\n    setQueryTaggingInfo(state, queryTaggingInfo: TaggingRequest) {\n      state.queryTaggingInfo = queryTaggingInfo;\n    },\n    setTaggingConfig(state, taggingConfig) {\n      Object.assign(state.config, taggingConfig);\n    }\n  },\n  actions: {\n    track\n  }\n};\n"],"names":[],"mappings":";;AAIA;;;;AAIG;AACU,MAAA,mBAAmB,GAAwB;AACtD,IAAA,KAAK,EAAE,OAAO;AACZ,QAAA,MAAM,EAAE;AACN,YAAA,YAAY,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI;AAC5B,YAAA,sBAAsB,EAAE,IAAI;AAC5B,YAAA,uBAAuB,EAAE,IAAI;AAC7B,YAAA,yBAAyB,EAAE,IAAI;AAChC,SAAA;AACD,QAAA,OAAO,EAAE,IAAI;AACb,QAAA,gBAAgB,EAAE,IAAI;KACvB,CAAC;AACF,IAAA,OAAO,EAAE,EAAE;AACX,IAAA,SAAS,EAAE;QACT,UAAU,CAAC,KAAK,EAAE,OAAO,EAAA;AACvB,YAAA,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;SACzB;QACD,mBAAmB,CAAC,KAAK,EAAE,gBAAgC,EAAA;AACzD,YAAA,KAAK,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;SAC3C;QACD,gBAAgB,CAAC,KAAK,EAAE,aAAa,EAAA;YACnC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;SAC5C;AACF,KAAA;AACD,IAAA,OAAO,EAAE;QACP,KAAK;AACN,KAAA;;;;;"}

package/js/x-modules/tagging/wiring.js

@@ -1,68 +1,176 @@
-import { wireServiceWithoutPayload } from '../../wiring/wires.factory.js';
+import { DefaultSessionService } from '@empathyco/x-utils';
+import { namespacedWireCommit, namespacedWireDispatch } from '../../wiring/namespaced-wires.factory.js';
+import { namespacedDebounce } from '../../wiring/namespaced-wires.operators.js';
+import { wireServiceWithoutPayload, wireService } from '../../wiring/wires.factory.js';
+import { filter, mapWire } from '../../wiring/wires.operators.js';
 import { createWiring } from '../../wiring/wiring.utils.js';
-import { namespacedWireCommit } from '../../wiring/namespaced-wires.factory.js';
-import { filter } from '../../wiring/wires.operators.js';
-import { DefaultSessionService } from './service/session.service.js';
+import { DefaultPDPAddToCartService } from './service/pdp-add-to-cart.service.js';
 
 /**
  * `tagging` {@link XModuleName | XModule name}.
  *
  * @internal
  */
-var moduleName = 'tagging';
+const moduleName = 'tagging';
+/**
+ * Debounce function for the module.
+ */
+const moduleDebounce = namespacedDebounce(moduleName);
 /**
  * WireCommit for {@link TaggingXModule}.
  *
  * @internal
  */
-var wireCommit = namespacedWireCommit(moduleName);
+const wireCommit = namespacedWireCommit(moduleName);
+/**
+ * WireDispatch for {@link TaggingXModule}.
+ *
+ * @internal
+ */
+const wireDispatch = namespacedWireDispatch(moduleName);
 /**
  * Wires without payload factory for {@link DefaultSessionService}.
  */
-var wireSessionServiceWithoutPayload = wireServiceWithoutPayload(DefaultSessionService.instance);
+const wireSessionServiceWithoutPayload = wireServiceWithoutPayload(DefaultSessionService.instance);
+/**
+ * Wires factory for {@link DefaultPDPAddToCartService}.
+ */
+const wirePDPAddToCartService = wireService(DefaultPDPAddToCartService.instance);
+/**
+ * Stores the given result on the local storage.
+ *
+ * @public
+ */
+const storeClickedResultWire = wirePDPAddToCartService('storeResultClicked');
+/**
+ * Moves the result information from the local storage to session storage.
+ *
+ * @public
+ */
+const moveClickedResultToSessionWire = mapWire(wirePDPAddToCartService('moveToSessionStorage'), (payload) => {
+    return payload === 'url' ? undefined : payload;
+});
+/**
+ * Triggers the add to cart tracking.
+ *
+ * @public
+ */
+const trackAddToCartFromSessionStorage = wirePDPAddToCartService('trackAddToCart');
 /**
  * Clears the session id.
  *
  * @public
  */
-var clearSessionWire = filter(wireSessionServiceWithoutPayload('clearSessionId'), function (consent) { return !consent; });
+const clearSessionWire = filter(wireSessionServiceWithoutPayload('clearSessionId'), ({ eventPayload: consent }) => !consent);
 /**
  * Sets the tagging state `consent`.
  *
  * @public
  */
-var setConsent = wireCommit('setConsent');
+const setConsent = wireCommit('setConsent');
+/**
+ * Sets the tagging config state.
+ *
+ * @public
+ */
+const setTaggingConfig = wireCommit('setTaggingConfig');
 /**
- * Sets the tagging state config `queryTaggingDebounceMs`.
+ * Tracks the tagging of the query.
  *
  * @public
  */
-var setQueryTaggingDebounce = wireCommit('setQueryTaggingDebounce');
+const trackQueryWire = wireDispatch('track');
 /**
- * Sets the tagging state `sessionTTLMs`.
+ * Sets the tagging state of the query tagging info using a debounce which ends if the user
+ * accepts a query.
  *
  * @public
  */
-var setSessionDuration = wireCommit('setSessionDuration');
+const setQueryTaggingInfo = moduleDebounce(wireCommit('setQueryTaggingInfo'), ({ state }) => state.config.queryTaggingDebounceMs, {
+    cancelOn: 'UserClearedQuery',
+    forceOn: [
+        'UserClickedAResult',
+        'UserClickedAPromoted',
+        'UserClickedABanner',
+        'UserClickedARedirection',
+        'UserReachedResultsListEnd'
+    ]
+});
+/**
+ * Tracks the tagging of the result.
+ *
+ * @public
+ */
+const trackResultClickedWire = createTrackWire('click');
+/**
+ * Tracks the tagging of the banner.
+ *
+ * @public
+ */
+const trackBannerClickedWire = createTrackWire('click');
+/**
+ * Performs a track of a result added to the cart.
+ *
+ * @public
+ */
+const trackAddToCartWire = createTrackWire('add2cart');
+/**
+ * Factory helper to create a wire for the track of a taggable element.
+ *
+ * @param property - Key of the tagging object to track.
+ * @returns A new wire for the given property of the taggable element.
+ *
+ * @public
+ */
+function createTrackWire(property) {
+    return filter(wireDispatch('track', ({ eventPayload: { tagging }, metadata: { location } }) => {
+        const taggingInfo = tagging[property];
+        taggingInfo.params.location = location;
+        return taggingInfo;
+    }), ({ eventPayload: { tagging } }) => !!tagging?.[property]);
+}
 /**
  * Wiring configuration for the {@link TaggingXModule | tagging module}.
  *
  * @internal
  */
-var taggingWiring = createWiring({
+const taggingWiring = createWiring({
     ConsentProvided: {
-        setConsent: setConsent
+        setConsent
     },
     ConsentChanged: {
-        clearSessionWire: clearSessionWire
+        clearSessionWire
+    },
+    PDPIsLoaded: {
+        moveClickedResultToSessionWire
+    },
+    ResultURLTrackingEnabled: {
+        moveClickedResultToSessionWire
+    },
+    SearchTaggingChanged: {
+        setQueryTaggingInfo
+    },
+    SearchTaggingReceived: {
+        trackQueryWire
+    },
+    TaggingConfigProvided: {
+        setTaggingConfig
+    },
+    UserClickedAResult: {
+        trackResultClickedWire,
+        storeClickedResultWire
+    },
+    UserClickedResultAddToCart: {
+        trackAddToCartWire,
+        trackResultClickedWire
     },
-    SessionDurationProvided: {
-        setSessionDuration: setSessionDuration
+    UserClickedPDPAddToCart: {
+        trackAddToCartFromSessionStorage
     },
-    QueryTaggingDebounceProvided: {
-        setQueryTaggingDebounce: setQueryTaggingDebounce
+    UserClickedABanner: {
+        trackBannerClickedWire
     }
 });
 
-export { setConsent, setQueryTaggingDebounce, setSessionDuration, taggingWiring };
+export { createTrackWire, setConsent, setQueryTaggingInfo, setTaggingConfig, taggingWiring, trackAddToCartWire, trackBannerClickedWire, trackQueryWire, trackResultClickedWire };
 //# sourceMappingURL=wiring.js.map

package/js/x-modules/tagging/wiring.js.map

@@ -1 +1 @@
-{"version":3,"file":"wiring.js","sources":["../../../../src/x-modules/tagging/wiring.ts"],"sourcesContent":["import { namespacedWireCommit } from '../../wiring/namespaced-wires.factory';\nimport { wireServiceWithoutPayload } from '../../wiring/wires.factory';\nimport { filter } from '../../wiring/wires.operators';\nimport { createWiring } from '../../wiring/wiring.utils';\nimport { DefaultSessionService } from './service/session.service';\n\n/**\n * `tagging` {@link XModuleName | XModule name}.\n *\n * @internal\n */\nconst moduleName = 'tagging';\n\n/**\n * WireCommit for {@link TaggingXModule}.\n *\n * @internal\n */\nconst wireCommit = namespacedWireCommit(moduleName);\n\n/**\n * Wires without payload factory for {@link DefaultSessionService}.\n */\nconst wireSessionServiceWithoutPayload = wireServiceWithoutPayload(DefaultSessionService.instance);\n\n/**\n * Clears the session id.\n *\n * @public\n */\nconst clearSessionWire = filter(\n  wireSessionServiceWithoutPayload('clearSessionId'),\n  consent => !consent\n);\n\n/**\n * Sets the tagging state `consent`.\n *\n * @public\n */\nexport const setConsent = wireCommit('setConsent');\n\n/**\n * Sets the tagging state config `queryTaggingDebounceMs`.\n *\n * @public\n */\nexport const setQueryTaggingDebounce = wireCommit('setQueryTaggingDebounce');\n\n/**\n * Sets the tagging state `sessionTTLMs`.\n *\n * @public\n */\nexport const setSessionDuration = wireCommit('setSessionDuration');\n\n/**\n * Wiring configuration for the {@link TaggingXModule | tagging module}.\n *\n * @internal\n */\nexport const taggingWiring = createWiring({\n  ConsentProvided: {\n    setConsent\n  },\n  ConsentChanged: {\n    clearSessionWire\n  },\n  SessionDurationProvided: {\n    setSessionDuration\n  },\n  QueryTaggingDebounceProvided: {\n    setQueryTaggingDebounce\n  }\n});\n"],"names":[],"mappings":";;;;;;AAMA;;;;;AAKA,IAAM,UAAU,GAAG,SAAS,CAAC;AAE7B;;;;;AAKA,IAAM,UAAU,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC;AAEpD;;;AAGA,IAAM,gCAAgC,GAAG,yBAAyB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;AAEnG;;;;;AAKA,IAAM,gBAAgB,GAAG,MAAM,CAC7B,gCAAgC,CAAC,gBAAgB,CAAC,EAClD,UAAA,OAAO,IAAI,OAAA,CAAC,OAAO,GAAA,CACpB,CAAC;AAEF;;;;;IAKa,UAAU,GAAG,UAAU,CAAC,YAAY,EAAE;AAEnD;;;;;IAKa,uBAAuB,GAAG,UAAU,CAAC,yBAAyB,EAAE;AAE7E;;;;;IAKa,kBAAkB,GAAG,UAAU,CAAC,oBAAoB,EAAE;AAEnE;;;;;IAKa,aAAa,GAAG,YAAY,CAAC;IACxC,eAAe,EAAE;QACf,UAAU,YAAA;KACX;IACD,cAAc,EAAE;QACd,gBAAgB,kBAAA;KACjB;IACD,uBAAuB,EAAE;QACvB,kBAAkB,oBAAA;KACnB;IACD,4BAA4B,EAAE;QAC5B,uBAAuB,yBAAA;KACxB;CACF;;;;"}
+{"version":3,"file":"wiring.js","sources":["../../../../src/x-modules/tagging/wiring.ts"],"sourcesContent":["import { Taggable, Tagging, TaggingRequest } from '@empathyco/x-types';\nimport { DefaultSessionService } from '@empathyco/x-utils';\nimport {\n  namespacedWireCommit,\n  namespacedWireDispatch\n} from '../../wiring/namespaced-wires.factory';\nimport { namespacedDebounce } from '../../wiring/namespaced-wires.operators';\nimport { wireService, wireServiceWithoutPayload } from '../../wiring/wires.factory';\nimport { filter, mapWire } from '../../wiring/wires.operators';\nimport { Wire } from '../../wiring/wiring.types';\nimport { createWiring } from '../../wiring/wiring.utils';\nimport { DefaultPDPAddToCartService } from './service/pdp-add-to-cart.service';\n\n/**\n * `tagging` {@link XModuleName | XModule name}.\n *\n * @internal\n */\nconst moduleName = 'tagging';\n\n/**\n * Debounce function for the module.\n */\nconst moduleDebounce = namespacedDebounce(moduleName);\n\n/**\n * WireCommit for {@link TaggingXModule}.\n *\n * @internal\n */\nconst wireCommit = namespacedWireCommit(moduleName);\n\n/**\n * WireDispatch for {@link TaggingXModule}.\n *\n * @internal\n */\nconst wireDispatch = namespacedWireDispatch(moduleName);\n\n/**\n * Wires without payload factory for {@link DefaultSessionService}.\n */\nconst wireSessionServiceWithoutPayload = wireServiceWithoutPayload(DefaultSessionService.instance);\n\n/**\n * Wires factory for {@link DefaultPDPAddToCartService}.\n */\nconst wirePDPAddToCartService = wireService(DefaultPDPAddToCartService.instance);\n\n/**\n * Stores the given result on the local storage.\n *\n * @public\n */\nconst storeClickedResultWire = wirePDPAddToCartService('storeResultClicked');\n\n/**\n * Moves the result information from the local storage to session storage.\n *\n * @public\n */\nconst moveClickedResultToSessionWire = mapWire(\n  wirePDPAddToCartService('moveToSessionStorage'),\n  (payload: string) => {\n    return payload === 'url' ? undefined : payload;\n  }\n);\n\n/**\n * Triggers the add to cart tracking.\n *\n * @public\n */\nconst trackAddToCartFromSessionStorage = wirePDPAddToCartService('trackAddToCart');\n\n/**\n * Clears the session id.\n *\n * @public\n */\nconst clearSessionWire = filter(\n  wireSessionServiceWithoutPayload('clearSessionId'),\n  ({ eventPayload: consent }) => !consent\n);\n\n/**\n * Sets the tagging state `consent`.\n *\n * @public\n */\nexport const setConsent = wireCommit('setConsent');\n\n/**\n * Sets the tagging config state.\n *\n * @public\n */\nexport const setTaggingConfig = wireCommit('setTaggingConfig');\n\n/**\n * Tracks the tagging of the query.\n *\n * @public\n */\nexport const trackQueryWire = wireDispatch('track');\n\n/**\n * Sets the tagging state of the query tagging info using a debounce which ends if the user\n * accepts a query.\n *\n * @public\n */\nexport const setQueryTaggingInfo = moduleDebounce(\n  wireCommit('setQueryTaggingInfo'),\n  ({ state }) => state.config.queryTaggingDebounceMs,\n  {\n    cancelOn: 'UserClearedQuery',\n    forceOn: [\n      'UserClickedAResult',\n      'UserClickedAPromoted',\n      'UserClickedABanner',\n      'UserClickedARedirection',\n      'UserReachedResultsListEnd'\n    ]\n  }\n);\n\n/**\n * Tracks the tagging of the result.\n *\n * @public\n */\nexport const trackResultClickedWire = createTrackWire('click');\n\n/**\n * Tracks the tagging of the banner.\n *\n * @public\n */\nexport const trackBannerClickedWire = createTrackWire('click');\n\n/**\n * Performs a track of a result added to the cart.\n *\n * @public\n */\nexport const trackAddToCartWire = createTrackWire('add2cart');\n\n/**\n * Factory helper to create a wire for the track of a taggable element.\n *\n * @param property - Key of the tagging object to track.\n * @returns A new wire for the given property of the taggable element.\n *\n * @public\n */\nexport function createTrackWire(property: keyof Tagging): Wire<Taggable> {\n  return filter(\n    wireDispatch('track', ({ eventPayload: { tagging }, metadata: { location } }) => {\n      const taggingInfo: TaggingRequest = tagging[property];\n      taggingInfo.params.location = location as string;\n      return taggingInfo;\n    }),\n    ({ eventPayload: { tagging } }) => !!tagging?.[property]\n  );\n}\n\n/**\n * Wiring configuration for the {@link TaggingXModule | tagging module}.\n *\n * @internal\n */\nexport const taggingWiring = createWiring({\n  ConsentProvided: {\n    setConsent\n  },\n  ConsentChanged: {\n    clearSessionWire\n  },\n  PDPIsLoaded: {\n    moveClickedResultToSessionWire\n  },\n  ResultURLTrackingEnabled: {\n    moveClickedResultToSessionWire\n  },\n  SearchTaggingChanged: {\n    setQueryTaggingInfo\n  },\n  SearchTaggingReceived: {\n    trackQueryWire\n  },\n  TaggingConfigProvided: {\n    setTaggingConfig\n  },\n  UserClickedAResult: {\n    trackResultClickedWire,\n    storeClickedResultWire\n  },\n  UserClickedResultAddToCart: {\n    trackAddToCartWire,\n    trackResultClickedWire\n  },\n  UserClickedPDPAddToCart: {\n    trackAddToCartFromSessionStorage\n  },\n  UserClickedABanner: {\n    trackBannerClickedWire\n  }\n});\n"],"names":[],"mappings":";;;;;;;;AAaA;;;;AAIG;AACH,MAAM,UAAU,GAAG,SAAS,CAAC;AAE7B;;AAEG;AACH,MAAM,cAAc,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;AAEtD;;;;AAIG;AACH,MAAM,UAAU,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC;AAEpD;;;;AAIG;AACH,MAAM,YAAY,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;AAExD;;AAEG;AACH,MAAM,gCAAgC,GAAG,yBAAyB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;AAEnG;;AAEG;AACH,MAAM,uBAAuB,GAAG,WAAW,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC;AAEjF;;;;AAIG;AACH,MAAM,sBAAsB,GAAG,uBAAuB,CAAC,oBAAoB,CAAC,CAAC;AAE7E;;;;AAIG;AACH,MAAM,8BAA8B,GAAG,OAAO,CAC5C,uBAAuB,CAAC,sBAAsB,CAAC,EAC/C,CAAC,OAAe,KAAI;IAClB,OAAO,OAAO,KAAK,KAAK,GAAG,SAAS,GAAG,OAAO,CAAC;AACjD,CAAC,CACF,CAAC;AAEF;;;;AAIG;AACH,MAAM,gCAAgC,GAAG,uBAAuB,CAAC,gBAAgB,CAAC,CAAC;AAEnF;;;;AAIG;AACH,MAAM,gBAAgB,GAAG,MAAM,CAC7B,gCAAgC,CAAC,gBAAgB,CAAC,EAClD,CAAC,EAAE,YAAY,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,CACxC,CAAC;AAEF;;;;AAIG;MACU,UAAU,GAAG,UAAU,CAAC,YAAY,EAAE;AAEnD;;;;AAIG;MACU,gBAAgB,GAAG,UAAU,CAAC,kBAAkB,EAAE;AAE/D;;;;AAIG;MACU,cAAc,GAAG,YAAY,CAAC,OAAO,EAAE;AAEpD;;;;;AAKG;MACU,mBAAmB,GAAG,cAAc,CAC/C,UAAU,CAAC,qBAAqB,CAAC,EACjC,CAAC,EAAE,KAAK,EAAE,KAAK,KAAK,CAAC,MAAM,CAAC,sBAAsB,EAClD;AACE,IAAA,QAAQ,EAAE,kBAAkB;AAC5B,IAAA,OAAO,EAAE;QACP,oBAAoB;QACpB,sBAAsB;QACtB,oBAAoB;QACpB,yBAAyB;QACzB,2BAA2B;AAC5B,KAAA;AACF,CAAA,EACD;AAEF;;;;AAIG;MACU,sBAAsB,GAAG,eAAe,CAAC,OAAO,EAAE;AAE/D;;;;AAIG;MACU,sBAAsB,GAAG,eAAe,CAAC,OAAO,EAAE;AAE/D;;;;AAIG;MACU,kBAAkB,GAAG,eAAe,CAAC,UAAU,EAAE;AAE9D;;;;;;;AAOG;AACG,SAAU,eAAe,CAAC,QAAuB,EAAA;IACrD,OAAO,MAAM,CACX,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,EAAE,KAAI;AAC9E,QAAA,MAAM,WAAW,GAAmB,OAAO,CAAC,QAAQ,CAAC,CAAC;AACtD,QAAA,WAAW,CAAC,MAAM,CAAC,QAAQ,GAAG,QAAkB,CAAC;AACjD,QAAA,OAAO,WAAW,CAAC;KACpB,CAAC,EACF,CAAC,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC,OAAO,GAAG,QAAQ,CAAC,CACzD,CAAC;AACJ,CAAC;AAED;;;;AAIG;AACI,MAAM,aAAa,GAAG,YAAY,CAAC;AACxC,IAAA,eAAe,EAAE;QACf,UAAU;AACX,KAAA;AACD,IAAA,cAAc,EAAE;QACd,gBAAgB;AACjB,KAAA;AACD,IAAA,WAAW,EAAE;QACX,8BAA8B;AAC/B,KAAA;AACD,IAAA,wBAAwB,EAAE;QACxB,8BAA8B;AAC/B,KAAA;AACD,IAAA,oBAAoB,EAAE;QACpB,mBAAmB;AACpB,KAAA;AACD,IAAA,qBAAqB,EAAE;QACrB,cAAc;AACf,KAAA;AACD,IAAA,qBAAqB,EAAE;QACrB,gBAAgB;AACjB,KAAA;AACD,IAAA,kBAAkB,EAAE;QAClB,sBAAsB;QACtB,sBAAsB;AACvB,KAAA;AACD,IAAA,0BAA0B,EAAE;QAC1B,kBAAkB;QAClB,sBAAsB;AACvB,KAAA;AACD,IAAA,uBAAuB,EAAE;QACvB,gCAAgC;AACjC,KAAA;AACD,IAAA,kBAAkB,EAAE;QAClB,sBAAsB;AACvB,KAAA;AACF,CAAA;;;;"}