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

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

@@ -1,89 +1,6 @@
-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';
+import _sfc_main from './tagging.vue.js';
 
-/* eslint-disable max-len */
-/**
- * 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
- */
-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 };
+
+export { _sfc_main as default };
 //# sourceMappingURL=tagging.vue2.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"tagging.vue2.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  /* eslint-disable max-len */\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  @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} 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":";;;;;;;AAQE;AACA;;;;;;AAMG;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;;;;"}
+{"version":3,"file":"tagging.vue2.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}

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

@@ -176,7 +176,7 @@ const trackNoResultsQueryWithSemanticsWire = filter(wireDispatch('track', ({ eve
  *
  * @public
  */
-const trackNoResultsQueryWithSemanticsWireDebounced = moduleDebounce(trackNoResultsQueryWithSemanticsWire, ({ state }) => state.config.queryTaggingDebounceMs);
+const trackNoResultsQueryWithSemanticsWireDebounced = moduleDebounce(trackNoResultsQueryWithSemanticsWire, ({ state }) => state.config.queryTaggingDebounceMs, { cancelOn: 'QueryPreviewUnmounted' });
 /**
  * Factory helper to create a wire for the track of the display click.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"wiring.js","sources":["../../../../src/x-modules/tagging/wiring.ts"],"sourcesContent":["import { SemanticQuery, 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 { DisplayWireMetadata, Wire } from '../../wiring/wiring.types';\nimport { createWiring } from '../../wiring/wiring.utils';\nimport { createOrigin } from '../../utils/index';\nimport { FeatureLocation } from '../../types/index';\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 state `noResultsTaggingEnabled`.\n *\n * @public\n */\nexport const setNoResultsTaggingEnabledWire = wireCommit('setNoResultsTaggingEnabled');\n\n/**\n * Sets the tagging config state.\n *\n * @public\n */\nexport const setTaggingConfig = wireCommit('mergeConfig');\n\n/**\n * Tracks the tagging of the query.\n *\n * @public\n */\nexport const trackQueryWire = filter(\n  wireDispatch('track'),\n  ({ eventPayload, store }) =>\n    (eventPayload as TaggingRequest).params.totalHits > 0 ||\n    !store.state.x.tagging.noResultsTaggingEnabled\n);\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 * Sets the tagging state of the query tagging info using.\n *\n * @public\n */\nexport const setQueryTaggingFromQueryPreview = createSetQueryTaggingFromQueryPreview();\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 * Performs a track of a display result being clicked.\n *\n * @public\n */\nexport const trackDisplayClickedWire = createTrackDisplayWire('displayClick');\n\n/**\n * Performs a track of a display element appearing.\n *\n * @public\n */\nexport const trackElementDisplayedWire = createTrackDisplayWire('display');\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 }, metadata: { ignoreInModules } }) =>\n      !!tagging?.[property] && !ignoreInModules?.includes(moduleName)\n  );\n}\n\n/**\n * Performs a track of a query with no results that used semantics as fallback.\n * The totalHits will be changed to -1 if semantic queries are found in order to differentiate\n * it from scenarios where the user encounters a no-results page without any semantic queries.\n *\n * @public\n */\nexport const trackNoResultsQueryWithSemanticsWire = filter(\n  wireDispatch('track', ({ eventPayload, state }) => {\n    const { queryTaggingInfo } = state;\n    const totalHits = (eventPayload as SemanticQuery[]).length > 0 ? -1 : 0;\n    return {\n      params: { ...queryTaggingInfo?.params, totalHits },\n      url: queryTaggingInfo?.url ?? ''\n    };\n  }),\n  ({ store }) => Number(store.state.x.tagging.queryTaggingInfo?.params.totalHits)! === 0\n);\n\n/**.\n * Debounced version of {@link trackNoResultsQueryWithSemanticsWire}\n *\n * @public\n */\nexport const trackNoResultsQueryWithSemanticsWireDebounced = moduleDebounce(\n  trackNoResultsQueryWithSemanticsWire,\n  ({ state }) => state.config.queryTaggingDebounceMs\n);\n\n/**\n * Factory helper to create a wire for the track of the display click.\n *\n * @param property - Key of the tagging object to track.\n * @returns A new wire for the display click of the taggable element.\n *\n * @public\n */\nexport function createTrackDisplayWire(property: keyof Tagging): Wire<Taggable> {\n  return filter(\n    wireDispatch('track', ({ eventPayload: { tagging }, metadata }) => {\n      const taggingInfo: TaggingRequest = tagging[property];\n      const location = metadata.location as FeatureLocation;\n\n      taggingInfo.params.location = location;\n      taggingInfo.params.displayFamily = createOrigin({\n        feature: metadata.feature,\n        location\n      })!;\n      taggingInfo.params.q = (metadata as DisplayWireMetadata).displayOriginalQuery;\n\n      return taggingInfo;\n    }),\n    ({ eventPayload: { tagging } }) => !!tagging?.[property]\n  );\n}\n\n/**\n * Factory helper to create a wire to set the queryTagging.\n *\n * @returns A new wire for the query of a result of a queryPreview.\n *\n * @public\n */\nexport function createSetQueryTaggingFromQueryPreview(): Wire<Taggable> {\n  return filter(\n    wireCommit(\n      'setQueryTaggingInfo',\n      ({ metadata: { queryTagging } }) => queryTagging as TaggingRequest\n    ),\n    ({ metadata: { queryTagging } }) => !!queryTagging\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  TrackableElementDisplayed: {\n    trackElementDisplayedWire\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  UserClickedADisplayResult: {\n    trackDisplayClickedWire,\n    setQueryTaggingFromQueryPreview\n  },\n  SemanticQueriesResponseChanged: {\n    trackNoResultsQueryWithSemanticsWireDebounced\n  },\n  ModuleRegistered: {\n    setNoResultsTaggingEnabledWire\n  }\n});\n"],"names":[],"mappings":";;;;;;;;;;AAeA;;;;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,8BAA8B,GAAG,UAAU,CAAC,4BAA4B,EAAE;AAEvF;;;;AAIG;MACU,gBAAgB,GAAG,UAAU,CAAC,aAAa,EAAE;AAE1D;;;;AAIG;AACU,MAAA,cAAc,GAAG,MAAM,CAClC,YAAY,CAAC,OAAO,CAAC,EACrB,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,KACrB,YAA+B,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC;IACrD,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,uBAAuB,EAChD;AAEF;;;;;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;AACU,MAAA,+BAA+B,GAAG,qCAAqC,GAAG;AAEvF;;;;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;;;;AAIG;MACU,uBAAuB,GAAG,sBAAsB,CAAC,cAAc,EAAE;AAE9E;;;;AAIG;MACU,yBAAyB,GAAG,sBAAsB,CAAC,SAAS,EAAE;AAE3E;;;;;;;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;AACrB,KAAC,CAAC,EACF,CAAC,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,eAAe,EAAE,EAAE,KAC3D,CAAC,CAAC,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,UAAU,CAAC,CAClE,CAAC;AACJ,CAAC;AAED;;;;;;AAMG;AACU,MAAA,oCAAoC,GAAG,MAAM,CACxD,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,KAAI;AAChD,IAAA,MAAM,EAAE,gBAAgB,EAAE,GAAG,KAAK,CAAC;AACnC,IAAA,MAAM,SAAS,GAAI,YAAgC,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IACxE,OAAO;QACL,MAAM,EAAE,EAAE,GAAG,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE;AAClD,QAAA,GAAG,EAAE,gBAAgB,EAAE,GAAG,IAAI,EAAE;KACjC,CAAC;AACJ,CAAC,CAAC,EACF,CAAC,EAAE,KAAK,EAAE,KAAK,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,EAAE,MAAM,CAAC,SAAS,CAAE,KAAK,CAAC,EACtF;AAEF;;;;AAIG;MACU,6CAA6C,GAAG,cAAc,CACzE,oCAAoC,EACpC,CAAC,EAAE,KAAK,EAAE,KAAK,KAAK,CAAC,MAAM,CAAC,sBAAsB,EAClD;AAEF;;;;;;;AAOG;AACG,SAAU,sBAAsB,CAAC,QAAuB,EAAA;AAC5D,IAAA,OAAO,MAAM,CACX,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,KAAI;AAChE,QAAA,MAAM,WAAW,GAAmB,OAAO,CAAC,QAAQ,CAAC,CAAC;AACtD,QAAA,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAA2B,CAAC;AAEtD,QAAA,WAAW,CAAC,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvC,QAAA,WAAW,CAAC,MAAM,CAAC,aAAa,GAAG,YAAY,CAAC;YAC9C,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,QAAQ;AACT,SAAA,CAAE,CAAC;QACJ,WAAW,CAAC,MAAM,CAAC,CAAC,GAAI,QAAgC,CAAC,oBAAoB,CAAC;AAE9E,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;;;;;;AAMG;SACa,qCAAqC,GAAA;AACnD,IAAA,OAAO,MAAM,CACX,UAAU,CACR,qBAAqB,EACrB,CAAC,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,EAAE,KAAK,YAA8B,CACnE,EACD,CAAC,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,EAAE,KAAK,CAAC,CAAC,YAAY,CACnD,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,yBAAyB,EAAE;QACzB,yBAAyB;AAC1B,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;AACD,IAAA,yBAAyB,EAAE;QACzB,uBAAuB;QACvB,+BAA+B;AAChC,KAAA;AACD,IAAA,8BAA8B,EAAE;QAC9B,6CAA6C;AAC9C,KAAA;AACD,IAAA,gBAAgB,EAAE;QAChB,8BAA8B;AAC/B,KAAA;AACF,CAAA;;;;"}
+{"version":3,"file":"wiring.js","sources":["../../../../src/x-modules/tagging/wiring.ts"],"sourcesContent":["import { SemanticQuery, 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 { DisplayWireMetadata, Wire } from '../../wiring/wiring.types';\nimport { createWiring } from '../../wiring/wiring.utils';\nimport { createOrigin } from '../../utils/index';\nimport { FeatureLocation } from '../../types/index';\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 state `noResultsTaggingEnabled`.\n *\n * @public\n */\nexport const setNoResultsTaggingEnabledWire = wireCommit('setNoResultsTaggingEnabled');\n\n/**\n * Sets the tagging config state.\n *\n * @public\n */\nexport const setTaggingConfig = wireCommit('mergeConfig');\n\n/**\n * Tracks the tagging of the query.\n *\n * @public\n */\nexport const trackQueryWire = filter(\n  wireDispatch('track'),\n  ({ eventPayload, store }) =>\n    (eventPayload as TaggingRequest).params.totalHits > 0 ||\n    !store.state.x.tagging.noResultsTaggingEnabled\n);\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 * Sets the tagging state of the query tagging info using.\n *\n * @public\n */\nexport const setQueryTaggingFromQueryPreview = createSetQueryTaggingFromQueryPreview();\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 * Performs a track of a display result being clicked.\n *\n * @public\n */\nexport const trackDisplayClickedWire = createTrackDisplayWire('displayClick');\n\n/**\n * Performs a track of a display element appearing.\n *\n * @public\n */\nexport const trackElementDisplayedWire = createTrackDisplayWire('display');\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 }, metadata: { ignoreInModules } }) =>\n      !!tagging?.[property] && !ignoreInModules?.includes(moduleName)\n  );\n}\n\n/**\n * Performs a track of a query with no results that used semantics as fallback.\n * The totalHits will be changed to -1 if semantic queries are found in order to differentiate\n * it from scenarios where the user encounters a no-results page without any semantic queries.\n *\n * @public\n */\nexport const trackNoResultsQueryWithSemanticsWire = filter(\n  wireDispatch('track', ({ eventPayload, state }) => {\n    const { queryTaggingInfo } = state;\n    const totalHits = (eventPayload as SemanticQuery[]).length > 0 ? -1 : 0;\n    return {\n      params: { ...queryTaggingInfo?.params, totalHits },\n      url: queryTaggingInfo?.url ?? ''\n    };\n  }),\n  ({ store }) => Number(store.state.x.tagging.queryTaggingInfo?.params.totalHits)! === 0\n);\n\n/**.\n * Debounced version of {@link trackNoResultsQueryWithSemanticsWire}\n *\n * @public\n */\nexport const trackNoResultsQueryWithSemanticsWireDebounced = moduleDebounce(\n  trackNoResultsQueryWithSemanticsWire,\n  ({ state }) => state.config.queryTaggingDebounceMs,\n  { cancelOn: 'QueryPreviewUnmounted' }\n);\n\n/**\n * Factory helper to create a wire for the track of the display click.\n *\n * @param property - Key of the tagging object to track.\n * @returns A new wire for the display click of the taggable element.\n *\n * @public\n */\nexport function createTrackDisplayWire(property: keyof Tagging): Wire<Taggable> {\n  return filter(\n    wireDispatch('track', ({ eventPayload: { tagging }, metadata }) => {\n      const taggingInfo: TaggingRequest = tagging[property];\n      const location = metadata.location as FeatureLocation;\n\n      taggingInfo.params.location = location;\n      taggingInfo.params.displayFamily = createOrigin({\n        feature: metadata.feature,\n        location\n      })!;\n      taggingInfo.params.q = (metadata as DisplayWireMetadata).displayOriginalQuery;\n\n      return taggingInfo;\n    }),\n    ({ eventPayload: { tagging } }) => !!tagging?.[property]\n  );\n}\n\n/**\n * Factory helper to create a wire to set the queryTagging.\n *\n * @returns A new wire for the query of a result of a queryPreview.\n *\n * @public\n */\nexport function createSetQueryTaggingFromQueryPreview(): Wire<Taggable> {\n  return filter(\n    wireCommit(\n      'setQueryTaggingInfo',\n      ({ metadata: { queryTagging } }) => queryTagging as TaggingRequest\n    ),\n    ({ metadata: { queryTagging } }) => !!queryTagging\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  TrackableElementDisplayed: {\n    trackElementDisplayedWire\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  UserClickedADisplayResult: {\n    trackDisplayClickedWire,\n    setQueryTaggingFromQueryPreview\n  },\n  SemanticQueriesResponseChanged: {\n    trackNoResultsQueryWithSemanticsWireDebounced\n  },\n  ModuleRegistered: {\n    setNoResultsTaggingEnabledWire\n  }\n});\n"],"names":[],"mappings":";;;;;;;;;;AAeA;;;;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,8BAA8B,GAAG,UAAU,CAAC,4BAA4B,EAAE;AAEvF;;;;AAIG;MACU,gBAAgB,GAAG,UAAU,CAAC,aAAa,EAAE;AAE1D;;;;AAIG;AACU,MAAA,cAAc,GAAG,MAAM,CAClC,YAAY,CAAC,OAAO,CAAC,EACrB,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,KACrB,YAA+B,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC;IACrD,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,uBAAuB,EAChD;AAEF;;;;;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;AACU,MAAA,+BAA+B,GAAG,qCAAqC,GAAG;AAEvF;;;;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;;;;AAIG;MACU,uBAAuB,GAAG,sBAAsB,CAAC,cAAc,EAAE;AAE9E;;;;AAIG;MACU,yBAAyB,GAAG,sBAAsB,CAAC,SAAS,EAAE;AAE3E;;;;;;;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;AACrB,KAAC,CAAC,EACF,CAAC,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,eAAe,EAAE,EAAE,KAC3D,CAAC,CAAC,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,UAAU,CAAC,CAClE,CAAC;AACJ,CAAC;AAED;;;;;;AAMG;AACU,MAAA,oCAAoC,GAAG,MAAM,CACxD,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,KAAI;AAChD,IAAA,MAAM,EAAE,gBAAgB,EAAE,GAAG,KAAK,CAAC;AACnC,IAAA,MAAM,SAAS,GAAI,YAAgC,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IACxE,OAAO;QACL,MAAM,EAAE,EAAE,GAAG,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE;AAClD,QAAA,GAAG,EAAE,gBAAgB,EAAE,GAAG,IAAI,EAAE;KACjC,CAAC;AACJ,CAAC,CAAC,EACF,CAAC,EAAE,KAAK,EAAE,KAAK,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,EAAE,MAAM,CAAC,SAAS,CAAE,KAAK,CAAC,EACtF;AAEF;;;;AAIG;AACU,MAAA,6CAA6C,GAAG,cAAc,CACzE,oCAAoC,EACpC,CAAC,EAAE,KAAK,EAAE,KAAK,KAAK,CAAC,MAAM,CAAC,sBAAsB,EAClD,EAAE,QAAQ,EAAE,uBAAuB,EAAE,EACrC;AAEF;;;;;;;AAOG;AACG,SAAU,sBAAsB,CAAC,QAAuB,EAAA;AAC5D,IAAA,OAAO,MAAM,CACX,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,KAAI;AAChE,QAAA,MAAM,WAAW,GAAmB,OAAO,CAAC,QAAQ,CAAC,CAAC;AACtD,QAAA,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAA2B,CAAC;AAEtD,QAAA,WAAW,CAAC,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;AACvC,QAAA,WAAW,CAAC,MAAM,CAAC,aAAa,GAAG,YAAY,CAAC;YAC9C,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,QAAQ;AACT,SAAA,CAAE,CAAC;QACJ,WAAW,CAAC,MAAM,CAAC,CAAC,GAAI,QAAgC,CAAC,oBAAoB,CAAC;AAE9E,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;;;;;;AAMG;SACa,qCAAqC,GAAA;AACnD,IAAA,OAAO,MAAM,CACX,UAAU,CACR,qBAAqB,EACrB,CAAC,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,EAAE,KAAK,YAA8B,CACnE,EACD,CAAC,EAAE,QAAQ,EAAE,EAAE,YAAY,EAAE,EAAE,KAAK,CAAC,CAAC,YAAY,CACnD,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,yBAAyB,EAAE;QACzB,yBAAyB;AAC1B,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;AACD,IAAA,yBAAyB,EAAE;QACzB,uBAAuB;QACvB,+BAA+B;AAChC,KAAA;AACD,IAAA,8BAA8B,EAAE;QAC9B,6CAA6C;AAC9C,KAAA;AACD,IAAA,gBAAgB,EAAE;QAChB,8BAA8B;AAC/B,KAAA;AACF,CAAA;;;;"}

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

@@ -1,3 +1,4 @@
+import { XPlugin } from '../../plugins/x-plugin.js';
 import { taggingEmitters } from './store/emitters.js';
 import { taggingXStoreModule } from './store/module.js';
 import { taggingWiring } from './wiring.js';
@@ -13,7 +14,8 @@ const taggingXModule = {
     storeModule: taggingXStoreModule,
     storeEmitters: taggingEmitters,
     wiring: taggingWiring
-};
+};
+XPlugin.registerXModule(taggingXModule);
 
 export { taggingXModule };
 //# sourceMappingURL=x-module.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"x-module.js","sources":["../../../../src/x-modules/tagging/x-module.ts"],"sourcesContent":["import { XModule } from '../x-modules.types';\nimport { taggingEmitters } from './store/emitters';\nimport { taggingXStoreModule } from './store/module';\nimport { TaggingXStoreModule } from './store/types';\nimport { taggingWiring } from './wiring';\n\n/**\n * Tagging {@link XModule} alias.\n *\n * @public\n */\nexport type TaggingXModule = XModule<TaggingXStoreModule>;\n\n/**\n * Tagging {@link XModule} implementation. This module is auto-registered as soon as you\n * import any component from the `empathize` entry point.\n *\n * @public\n */\nexport const taggingXModule: TaggingXModule = {\n  name: 'tagging',\n  storeModule: taggingXStoreModule,\n  storeEmitters: taggingEmitters,\n  wiring: taggingWiring\n};\n"],"names":[],"mappings":";;;;AAaA;;;;;AAKG;AACU,MAAA,cAAc,GAAmB;AAC5C,IAAA,IAAI,EAAE,SAAS;AACf,IAAA,WAAW,EAAE,mBAAmB;AAChC,IAAA,aAAa,EAAE,eAAe;AAC9B,IAAA,MAAM,EAAE,aAAa;;;;;"}
+{"version":3,"file":"x-module.js","sources":["../../../../src/x-modules/tagging/x-module.ts"],"sourcesContent":["import { XModule } from '../x-modules.types';\nimport { XPlugin } from '../../plugins/x-plugin';\nimport { taggingEmitters } from './store/emitters';\nimport { taggingXStoreModule } from './store/module';\nimport { TaggingXStoreModule } from './store/types';\nimport { taggingWiring } from './wiring';\n\n/**\n * Tagging {@link XModule} alias.\n *\n * @public\n */\nexport type TaggingXModule = XModule<TaggingXStoreModule>;\n\n/**\n * Tagging {@link XModule} implementation. This module is auto-registered as soon as you\n * import any component from the `empathize` entry point.\n *\n * @public\n */\nexport const taggingXModule: TaggingXModule = {\n  name: 'tagging',\n  storeModule: taggingXStoreModule,\n  storeEmitters: taggingEmitters,\n  wiring: taggingWiring\n};\n\nXPlugin.registerXModule(taggingXModule);\n"],"names":[],"mappings":";;;;;AAcA;;;;;AAKG;AACU,MAAA,cAAc,GAAmB;AAC5C,IAAA,IAAI,EAAE,SAAS;AACf,IAAA,WAAW,EAAE,mBAAmB;AAChC,IAAA,aAAa,EAAE,eAAe;AAC9B,IAAA,MAAM,EAAE,aAAa;EACrB;AAEF,OAAO,CAAC,eAAe,CAAC,cAAc,CAAC;;;;"}

package/js/x-modules/url/components/url-handler.vue.js

@@ -1,50 +1,16 @@
-import script from './url-handler.vue2.js';
-import __vue_normalize__ from 'vue-runtime-helpers/dist/normalize-component.mjs';
+import _sfc_main from './url-handler.vue2.js';
+import { resolveComponent, openBlock, createBlock } 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_GlobalEvents = resolveComponent("GlobalEvents");
+  return openBlock(), createBlock(_component_GlobalEvents, {
+    onPageshow: _ctx.onPageShow,
+    onPopstate: _ctx.emitEvents,
+    target: "window"
+  }, null, 8, ["onPageshow", "onPopstate"]);
+}
+var urlHandler = /* @__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("GlobalEvents", {
-    attrs: { target: "window" },
-    on: { pageshow: _vm.onPageShow, popstate: _vm.emitEvents },
-  })
-};
-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 { urlHandler as default };
 //# sourceMappingURL=url-handler.vue.js.map

package/js/x-modules/url/components/url-handler.vue.js.map

@@ -1 +1 @@
-{"version":3,"file":"url-handler.vue.js","sources":["../../../../../src/x-modules/url/components/url-handler.vue"],"sourcesContent":["<template>\n  <GlobalEvents @pageshow=\"onPageShow\" @popstate=\"emitEvents\" target=\"window\" />\n</template>\n\n<script lang=\"ts\">\n  import { Dictionary, objectFilter } from '@empathyco/x-utils';\n  import Vue from 'vue';\n  import GlobalEvents from 'vue-global-events';\n  import { Component, Inject } from 'vue-property-decorator';\n  import { State } from '../../../components';\n  import { XOn } from '../../../components/decorators/bus.decorators';\n  import { xComponentMixin } from '../../../components/x-component.mixin';\n  import { FeatureLocation } from '../../../types/origin';\n  import { UrlParams } from '../../../types/url-params';\n  import { isArrayEmpty } from '../../../utils/array';\n  import { WireMetadata } from '../../../wiring/wiring.types';\n  import { SnippetConfig } from '../../../x-installer/api/api.types';\n  import { initialUrlState } from '../store/initial-state';\n  import { UrlParamValue } from '../store/types';\n  import { urlXModule } from '../x-module';\n\n  interface ParsedUrlParams {\n    all: UrlParams;\n    extra: Dictionary<unknown>;\n  }\n\n  /**\n   * This component manages the browser URL parameters to preserve them through reloads and browser\n   * history navigation. It allow to configure the default url parameter names using its attributes.\n   * This component doesn't render elements to the DOM.\n   *\n   * @public\n   */\n  @Component({\n    components: {\n      GlobalEvents\n    },\n    mixins: [xComponentMixin(urlXModule)]\n  })\n  export default class UrlHandler extends Vue {\n    /**\n     * The {@link SnippetConfig} provided by an ancestor.\n     *\n     * @internal\n     */\n    @Inject({ default: undefined })\n    protected snippetConfig?: SnippetConfig;\n\n    /**\n     * Flag to know if the params were already loaded from the URL.\n     *\n     * @internal\n     */\n    protected urlLoaded = false;\n\n    /**\n     * The page URL. It is used to compare against the current URL to check navigation state.\n     *\n     * @internal\n     */\n    protected url?: URL;\n\n    /**\n     * Flag to know if the page has been persisted by the browser's back-forward cache.\n     *\n     * @internal\n     */\n    protected isPagePersisted = false;\n\n    /**\n     * Computed to know which params we must get from URL. It gets the params names from the initial\n     * state, to get all default params names, and also from the `$attrs` to get the extra params\n     * names to take into account.\n     *\n     * @returns An array with the name of the params.\n     *\n     * @internal\n     */\n    protected get managedParamsNames(): string[] {\n      return Object.keys({ ...initialUrlState, ...this.$attrs });\n    }\n\n    @State('url', 'initialExtraParams')\n    public initialExtraParams!: Dictionary<unknown>;\n\n    /**\n     * Returns the mapping of the param keys used in the URL is configured through $attrs. This way\n     * we can support any param and extra param, no matters its name.\n     *\n     * @param paramName - The param name to get the Url key.\n     * @returns The key used in the URL for the `paramName` passed.\n     *\n     * @internal\n     */\n    protected getUrlKey(paramName: string): string {\n      return this.$attrs[paramName] ?? paramName;\n    }\n\n    /**\n     * To emit the Url events just when the URL is load, and before the components mounted events\n     * and state changes, we do it in the created of this component.\n     */\n    created(): void {\n      this.emitEvents();\n    }\n\n    /**\n     * Updates the browser URL with the new {@link UrlParams} using the history `pushState` method.\n     *\n     * @param newUrlParams - The new params to update browser URL.\n     */\n    @XOn('PushableUrlStateUpdated')\n    updateUrlWithPush(newUrlParams: UrlParams): void {\n      this.updateUrl(newUrlParams, window.history.pushState.bind(window.history));\n    }\n\n    /**\n     * Updates the browser URL with the new {@link UrlParams} using the history `replaceState`\n     * method.\n     *\n     * @param newUrlParams - The new params to update browser URL.\n     */\n    @XOn('ReplaceableUrlStateUpdated')\n    updateUrlWithReplace(newUrlParams: UrlParams): void {\n      this.updateUrl(newUrlParams, window.history.replaceState.bind(window.history));\n    }\n\n    /**\n     * Handler of the\n     * [pageshow](https://developer.mozilla.org/en-US/docs/Web/API/Window/pageshow_event)\n     * event.\n     *\n     * @remarks The pageshow event is listened to check if the browser has performed a navigation\n     * using the back-forward cache. This information is available in the\n     * PageTransitionEvent.persisted property.\n     *\n     * @param event - The page transition event.\n     * @internal\n     */\n    protected onPageShow(event: PageTransitionEvent): void {\n      this.isPagePersisted = event.persisted;\n      if (event.persisted) {\n        // The internal url is reset due to the back-forward cache storing the previous value which\n        // is no longer valid.\n        this.url = undefined;\n      }\n    }\n\n    /**\n     * Emits the {@link UrlXEvents.ParamsLoadedFromUrl} XEvent,\n     * the {@link UrlXEvents.ExtraParamsLoadedFromUrl} XEvent and, if there is query, also emits\n     * the {@link XEventsTypes.UserOpenXProgrammatically}.\n     *\n     * @internal\n     */\n    protected emitEvents(): void {\n      const { all, extra } = this.parseUrlParams();\n      const metadata = this.createWireMetadata();\n      this.$x.emit('ParamsLoadedFromUrl', all, metadata);\n      this.$x.emit('ExtraParamsLoadedFromUrl', extra, metadata);\n      // TODO: Move this logic from here.\n      if (all.query) {\n        this.$x.emit('UserOpenXProgrammatically', undefined, metadata);\n      }\n      this.urlLoaded = true;\n    }\n\n    /**\n     * Creates the wire metadata to include in every emitted {@link XEvent}.\n     *\n     * @returns The {@link WireMetadata}.\n     * @internal\n     */\n    protected createWireMetadata(): Pick<WireMetadata, 'feature' | 'location'> {\n      return {\n        feature: 'url',\n        location: this.detectLocation()\n      };\n    }\n\n    /**\n     * Detects the {@link FeatureLocation} used to build the\n     * {@link QueryOriginInit} data.\n     *\n     * @returns The {@link FeatureLocation}.\n     * @internal\n     */\n    protected detectLocation(): FeatureLocation {\n      const currentUrl = new URL(window.location.href);\n      const previousUrl = this.url;\n      this.url = currentUrl;\n\n      const isInternalNavigation =\n        previousUrl?.search !== currentUrl.search && previousUrl?.pathname === currentUrl.pathname;\n      if (isInternalNavigation) {\n        return 'url_history';\n      }\n\n      if (this.isNavigatingFromPdp()) {\n        return 'url_history_pdp';\n      }\n\n      return 'external';\n    }\n\n    /**\n     * Check if the navigation is from a product page.\n     *\n     * @remarks Due to Safari 14 not supporting the new and standard PerformanceNavigationTiming\n     * API, we are falling back to the deprecated one, PerformanceNavigation. We also fallback to\n     * this API whenever we get a navigationType equal to reload, because Safari has a bug that the\n     * navigationType is permanently set to reload after you have reload the page and it never\n     * resets. As some browsers have a back-forward cache implemented, we also take into account if\n     * the page is persisted.\n     *\n     * @returns True if the navigation is from a product page, false otherwise.\n     * @internal\n     */\n    protected isNavigatingFromPdp(): boolean {\n      const isPagePersisted = this.isPagePersisted;\n      const navigationEntries = window.performance.getEntriesByType('navigation');\n      const navigationType = (navigationEntries[0] as PerformanceNavigationTiming)?.type;\n      const useFallbackStrategy =\n        window.performance.navigation &&\n        (isArrayEmpty(navigationEntries) || navigationType === 'reload');\n\n      // Reset internal isPagePersisted property value\n      this.isPagePersisted = false;\n\n      if (useFallbackStrategy) {\n        const {\n          type: fallbackNavigationType,\n          TYPE_BACK_FORWARD,\n          TYPE_NAVIGATE\n        } = window.performance.navigation;\n        const isNavigatingInSpa =\n          !!this.snippetConfig?.isSpa && fallbackNavigationType === TYPE_NAVIGATE;\n        return fallbackNavigationType === TYPE_BACK_FORWARD || isNavigatingInSpa || isPagePersisted;\n      } else {\n        const isNavigatingInSpa = !!this.snippetConfig?.isSpa && navigationType === 'navigate';\n        return navigationType === 'back_forward' || isNavigatingInSpa || isPagePersisted;\n      }\n    }\n\n    /**\n     * Gets the {@link UrlParams} from the URL, including only the params defined by `paramsNames`.\n     *\n     * @returns ParsedUrlParams obtained from URL.\n     * @internal\n     */\n    protected parseUrlParams(): ParsedUrlParams {\n      const urlSearchParams = new URL(window.location.href).searchParams;\n      return this.managedParamsNames.reduce<ParsedUrlParams>(\n        (params, name) => {\n          const urlKey = this.getUrlKey(name);\n          if (urlSearchParams.has(urlKey)) {\n            if (name in initialUrlState) {\n              const urlValue = urlSearchParams.getAll(urlKey);\n              params.all[name] = this.parseUrlParam(name, urlValue);\n            } else {\n              params.all[name] = params.extra[name] = urlSearchParams.get(urlKey);\n            }\n          }\n          return params;\n        },\n        { all: { ...initialUrlState }, extra: { ...this.initialExtraParams } }\n      );\n    }\n\n    /**\n     * Updates the browser URL with the passed `newUrlParams` and using the browser history method\n     * passed as `historyMethod`. It only updates the browser history if the new URL is different\n     * from the current.\n     *\n     * @param newUrlParams - The new params to add to the browser URL.\n     * @param historyMethod - The browser history method used to add the new URL.\n     *\n     * @internal\n     */\n    protected updateUrl(\n      newUrlParams: UrlParams,\n      historyMethod: History['pushState'] | History['replaceState']\n    ): void {\n      if (this.urlLoaded) {\n        const url = new URL(window.location.href);\n        this.deleteUrlParameters(url);\n        this.setUrlParameters(url, newUrlParams);\n\n        url.href = url.href.replace(/\\+/g, '%20');\n\n        if (url.href !== window.location.href) {\n          historyMethod({ ...window.history.state }, document.title, url.href);\n        }\n        this.url = url;\n      }\n    }\n\n    /**\n     * Deletes all the parameters in the passed URL.\n     *\n     * @param url - The URL to remove parameters from.\n     * @internal\n     */\n    protected deleteUrlParameters(url: URL): void {\n      this.managedParamsNames.forEach(paramName =>\n        url.searchParams.delete(this.getUrlKey(paramName))\n      );\n    }\n\n    /**\n     * Set all the provided parameters to the url with the mapped key.\n     *\n     * @param url - The current URL.\n     * @param urlParams - The list of parameters to add.\n     * @remarks The params are filtered because there maybe received extra params which will not be\n     * managed by URL. This is defined by the `managedParamsNames` computed. Also, the parameters\n     * are sorted Alphabetically to produce always the same URL with the same parameters.This is\n     * important for SEO purposes.\n     *\n     * @internal\n     */\n    protected setUrlParameters(url: URL, urlParams: UrlParams): void {\n      // Only when there is a query the rest of the parameters are valid.\n      if (!urlParams.query) {\n        return;\n      }\n      const filteredParams = objectFilter(urlParams, paramName =>\n        this.managedParamsNames.includes(paramName as string)\n      );\n      const sortedParameters = this.sortParams(filteredParams);\n      sortedParameters.forEach(([paramName, paramValue]) => {\n        const urlParamKey = this.getUrlKey(paramName);\n        if (Array.isArray(paramValue)) {\n          paramValue.forEach(value => {\n            url.searchParams.append(urlParamKey, String(value));\n          });\n        } else {\n          url.searchParams.set(urlParamKey, String(paramValue));\n        }\n      });\n    }\n\n    /**\n     * Sorts the params in a tuple array [key,value] to generate always the same URL with the params\n     * in the same order.\n     *\n     * @param urlParams - The {@link UrlParams} to sort.\n     * @returns An array of tuples with the key-value of each paramter, sorted by key.\n     * @internal\n     */\n    protected sortParams(urlParams: UrlParams): Array<[string, unknown]> {\n      return Object.entries(urlParams).sort(([param1], [param2]) => {\n        return param1 < param2 ? -1 : 1;\n      });\n    }\n\n    /**\n     * Returns the URL param value parsed depending on its type in the initial store state. As we\n     * can not know what type can have an extra param, all extra params are parsed as strings. We\n     * know if it is an extra param because it is not in the initial state.\n     *\n     * @param name - The name of the param in {@link UrlParams}.\n     * @param value - The `URLSearchParams` value as an arry of strings.\n     * @returns The parsed value.\n     *\n     * @internal\n     */\n    protected parseUrlParam(name: string, value: string[]): UrlParamValue {\n      switch (typeof initialUrlState[name]) {\n        case 'number':\n          return Number(value[0]);\n        case 'boolean':\n          return value[0].toLowerCase() === 'true';\n        case 'string':\n          return value[0];\n        default:\n          // array\n          return value;\n      }\n    }\n  }\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nThis component emits the following events:\n\n- [`ParamsLoadedFromUrl`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`ExtraParamsLoadedFromUrl`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserOpenXProgrammatically`](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 browser URL parameters to preserve them through reloads and browser\nhistory navigation. It allow to configure the default url parameter names using its attributes. This\ncomponent doesn't render elements to the DOM.\n\n_Try to make some requests and take a look to the url!_\n\n```vue\n<template>\n  <UrlHandler />\n</template>\n\n<script>\n  import { UrlHandler } from '@empathyco/x-components/url-handler';\n\n  export default {\n    name: 'UrlHandlerDemo',\n    components: {\n      UrlHandler\n    }\n  };\n</script>\n```\n\n### Play with props\n\nIn this example, the `UrlHandler` component changes the following query parameter names:\n\n- `query` to be `q`.\n- `page` to be `p`.\n- `filter` to be `f`\n- `sort` to be `s`\n\n_Try to make some requests and take a look to the url!_\n\n```vue\n<template>\n  <UrlHandler query=\"q\" page=\"p\" filter=\"f\" sort=\"s\" />\n</template>\n\n<script>\n  import { UrlHandler } from '@empathyco/x-components/url-handler';\n\n  export default {\n    name: 'UrlHandlerDemo',\n    components: {\n      UrlHandler\n    }\n  };\n</script>\n```\n\n### Play with events\n\nThe `UrlHandler` will emit the `ParamsLoadedFromUrl` when the page is loaded.\n\nThe `UrlHandler` will emit the `ExtraParamsLoadedFromUrl` when the page is loaded with an extra\nparam configured and with a value in URL.\n\nThe `UrlHandler` will emit the `UserOpenXProgrammatically` when the page is loaded with a query in\nthe URL.\n</docs>\n"],"names":[],"mappings":";;;;AAEA,MAAc,cAAA,GAAA,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"url-handler.vue.js","sources":["../../../../../src/x-modules/url/components/url-handler.vue"],"sourcesContent":["<template>\n  <GlobalEvents @pageshow=\"onPageShow\" @popstate=\"emitEvents\" target=\"window\" />\n</template>\n\n<script lang=\"ts\">\n  import { Dictionary, objectFilter } from '@empathyco/x-utils';\n  import { computed, defineComponent, inject, onMounted, ref } from 'vue';\n  import { GlobalEvents } from 'vue-global-events';\n  import { FeatureLocation } from '../../../types/origin';\n  import { UrlParams } from '../../../types/url-params';\n  import { isArrayEmpty } from '../../../utils/array';\n  import { WireMetadata } from '../../../wiring/wiring.types';\n  import { SnippetConfig } from '../../../x-installer/api/api.types';\n  import { initialUrlState } from '../store/initial-state';\n  import { UrlParamValue } from '../store/types';\n  import { urlXModule } from '../x-module';\n  import { use$x } from '../../../composables/use-$x';\n  import { useState } from '../../../composables/use-state';\n\n  interface ParsedUrlParams {\n    all: UrlParams;\n    extra: Dictionary<unknown>;\n  }\n\n  /**\n   * This component manages the browser URL parameters to preserve them through reloads and browser\n   * history navigation. It allow to configure the default url parameter names using its attributes.\n   * This component doesn't render elements to the DOM.\n   *\n   * @public\n   */\n  export default defineComponent({\n    name: 'UrlHandler',\n    components: {\n      GlobalEvents\n    },\n    xModule: urlXModule.name,\n    setup: function (props, { attrs }) {\n      const $x = use$x();\n\n      const initialExtraParams = useState('url', ['initialExtraParams']).initialExtraParams;\n\n      /**\n       * The {@link SnippetConfig} provided by an ancestor.\n       *\n       * @internal\n       */\n      const snippetConfig = inject<SnippetConfig | undefined>('snippetConfig');\n\n      /**\n       * Flag to know if the params were already loaded from the URL.\n       *\n       * @internal\n       */\n      const urlLoaded = ref(false);\n\n      /**\n       * The page URL. It is used to compare against the current URL to check navigation state.\n       *\n       * @internal\n       */\n      const url = ref<URL | undefined>(undefined);\n\n      /**\n       * Flag to know if the page has been persisted by the browser's back-forward cache.\n       *\n       * @internal\n       */\n      const isPagePersisted = ref(false);\n\n      /**\n       * Computed to know which params we must get from URL. It gets the params names from the initial\n       * state, to get all default params names, and also from the `$attrs` to get the extra params\n       * names to take into account.\n       *\n       * @returns An array with the name of the params.\n       *\n       * @internal\n       */\n      const managedParamsNames = computed(() => {\n        return Object.keys({ ...initialUrlState, ...attrs });\n      });\n\n      /**\n       * Returns the mapping of the param keys used in the URL is configured through $attrs. This way\n       * we can support any param and extra param, no matters its name.\n       *\n       * @param paramName - The param name to get the Url key.\n       * @returns The key used in the URL for the `paramName` passed.\n       *\n       * @internal\n       */\n      const getUrlKey = (paramName: string): string => {\n        const paramValue = attrs[paramName];\n        return typeof paramValue === 'string' ? paramValue : paramName;\n      };\n\n      /**\n       * Deletes all the parameters in the passed URL.\n       *\n       * @param url - The URL to remove parameters from.\n       * @internal\n       */\n      const deleteUrlParameters = (url: URL): void => {\n        managedParamsNames.value.forEach(paramName =>\n          url.searchParams.delete(getUrlKey(paramName))\n        );\n      };\n\n      /**\n       * Sorts the params in a tuple array [key,value] to generate always the same URL with the params\n       * in the same order.\n       *\n       * @param urlParams - The {@link UrlParams} to sort.\n       * @returns An array of tuples with the key-value of each paramter, sorted by key.\n       * @internal\n       */\n      const sortParams = (urlParams: UrlParams): Array<[string, unknown]> => {\n        return Object.entries(urlParams).sort(([param1], [param2]) => {\n          return param1 < param2 ? -1 : 1;\n        });\n      };\n\n      /**\n       * Set all the provided parameters to the url with the mapped key.\n       *\n       * @param url - The current URL.\n       * @param urlParams - The list of parameters to add.\n       * @remarks The params are filtered because there maybe received extra params which will not be\n       * managed by URL. This is defined by the `managedParamsNames` computed. Also, the parameters\n       * are sorted Alphabetically to produce always the same URL with the same parameters.This is\n       * important for SEO purposes.\n       *\n       * @internal\n       */\n      const setUrlParameters = (url: URL, urlParams: UrlParams): void => {\n        // Only when there is a query the rest of the parameters are valid.\n        if (!urlParams.query) {\n          return;\n        }\n        const filteredParams = objectFilter(urlParams, paramName =>\n          managedParamsNames.value.includes(paramName as string)\n        );\n        const sortedParameters = sortParams(filteredParams);\n        sortedParameters.forEach(([paramName, paramValue]) => {\n          const urlParamKey = getUrlKey(paramName);\n          if (Array.isArray(paramValue)) {\n            paramValue.forEach(value => {\n              url.searchParams.append(urlParamKey, String(value));\n            });\n          } else {\n            url.searchParams.set(urlParamKey, String(paramValue));\n          }\n        });\n      };\n\n      /**\n       * Updates the browser URL with the passed `newUrlParams` and using the browser history method\n       * passed as `historyMethod`. It only updates the browser history if the new URL is different\n       * from the current.\n       *\n       * @param newUrlParams - The new params to add to the browser URL.\n       * @param historyMethod - The browser history method used to add the new URL.\n       *\n       * @internal\n       */\n      const updateUrl = (\n        newUrlParams: UrlParams,\n        historyMethod: History['pushState'] | History['replaceState']\n      ): void => {\n        if (urlLoaded.value) {\n          const newUrl = new URL(window.location.href);\n          deleteUrlParameters(newUrl);\n          setUrlParameters(newUrl, newUrlParams);\n\n          newUrl.href = newUrl.href.replace(/\\+/g, '%20');\n\n          if (newUrl.href !== window.location.href) {\n            historyMethod({ ...window.history.state }, document.title, newUrl.href);\n          }\n          url.value = newUrl;\n        }\n      };\n\n      /**\n       * Updates the browser URL with the new {@link UrlParams} using the history `pushState` method.\n       *\n       * @param newUrlParams - The new params to update browser URL.\n       */\n      $x.on('PushableUrlStateUpdated', false).subscribe((newUrlParams: UrlParams) => {\n        updateUrl(newUrlParams, window.history.pushState.bind(window.history));\n      });\n\n      /**\n       * Updates the browser URL with the new {@link UrlParams} using the history `replaceState`\n       * method.\n       *\n       * @param newUrlParams - The new params to update browser URL.\n       */\n      $x.on('ReplaceableUrlStateUpdated', false).subscribe((newUrlParams: UrlParams) => {\n        updateUrl(newUrlParams, window.history.replaceState.bind(window.history));\n      });\n\n      /**\n       * Handler of the\n       * [pageshow](https://developer.mozilla.org/en-US/docs/Web/API/Window/pageshow_event)\n       * event.\n       *\n       * @remarks The pageshow event is listened to check if the browser has performed a navigation\n       * using the back-forward cache. This information is available in the\n       * PageTransitionEvent.persisted property.\n       *\n       * @param event - The page transition event.\n       * @internal\n       */\n      const onPageShow = (event: PageTransitionEvent) => {\n        isPagePersisted.value = event.persisted;\n        if (event.persisted) {\n          // The internal url is reset due to the back-forward cache storing the previous value which\n          // is no longer valid.\n          url.value = undefined;\n        }\n      };\n\n      /**\n       * Returns the URL param value parsed depending on its type in the initial store state. As we\n       * can not know what type can have an extra param, all extra params are parsed as strings. We\n       * know if it is an extra param because it is not in the initial state.\n       *\n       * @param name - The name of the param in {@link UrlParams}.\n       * @param value - The `URLSearchParams` value as an arry of strings.\n       * @returns The parsed value.\n       *\n       * @internal\n       */\n      const parseUrlParam = (name: string, value: string[]): UrlParamValue => {\n        switch (typeof initialUrlState[name]) {\n          case 'number':\n            return Number(value[0]);\n          case 'boolean':\n            return value[0].toLowerCase() === 'true';\n          case 'string':\n            return value[0];\n          default:\n            // array\n            return value;\n        }\n      };\n\n      /**\n       * Gets the {@link UrlParams} from the URL, including only the params defined by `paramsNames`.\n       *\n       * @returns ParsedUrlParams obtained from URL.\n       * @internal\n       */\n      const parseUrlParams = (): ParsedUrlParams => {\n        const urlSearchParams = new URL(window.location.href).searchParams;\n        return managedParamsNames.value.reduce<ParsedUrlParams>(\n          (params, name) => {\n            const urlKey = getUrlKey(name);\n            if (urlSearchParams.has(urlKey)) {\n              if (name in initialUrlState) {\n                const urlValue = urlSearchParams.getAll(urlKey);\n                params.all[name] = parseUrlParam(name, urlValue);\n              } else {\n                params.all[name] = params.extra[name] = urlSearchParams.get(urlKey);\n              }\n            }\n            return params;\n          },\n          { all: { ...initialUrlState }, extra: { ...initialExtraParams.value } }\n        );\n      };\n\n      /**\n       * Check if the navigation is from a product page.\n       *\n       * @remarks Due to Safari 14 not supporting the new and standard PerformanceNavigationTiming\n       * API, we are falling back to the deprecated one, PerformanceNavigation. We also fallback to\n       * this API whenever we get a navigationType equal to reload, because Safari has a bug that the\n       * navigationType is permanently set to reload after you have reload the page and it never\n       * resets. As some browsers have a back-forward cache implemented, we also take into account if\n       * the page is persisted.\n       *\n       * @returns True if the navigation is from a product page, false otherwise.\n       * @internal\n       */\n      const isNavigatingFromPdp = (): boolean => {\n        const isPagePersistedValue = isPagePersisted.value;\n        const navigationEntries = window.performance.getEntriesByType('navigation');\n        const navigationType = (navigationEntries[0] as PerformanceNavigationTiming)?.type;\n        const useFallbackStrategy =\n          !navigationEntries.length &&\n          (isArrayEmpty(navigationEntries) || navigationType === 'reload');\n\n        // Reset internal isPagePersisted property value\n        isPagePersisted.value = false;\n\n        if (useFallbackStrategy) {\n          const isNavigatingInSpa = !!snippetConfig?.isSpa && navigationType === 'navigate';\n          return navigationType === 'back_forward' || isNavigatingInSpa || isPagePersistedValue;\n        } else {\n          const isNavigatingInSpa = !!snippetConfig?.isSpa && navigationType === 'navigate';\n          return navigationType === 'back_forward' || isNavigatingInSpa || isPagePersistedValue;\n        }\n      };\n\n      /**\n       * Detects the {@link FeatureLocation} used to build the\n       * {@link QueryOriginInit} data.\n       *\n       * @returns The {@link FeatureLocation}.\n       * @internal\n       */\n      const detectLocation = (): FeatureLocation => {\n        const currentUrl = new URL(window.location.href);\n        const previousUrl = url.value;\n        url.value = currentUrl;\n\n        const isInternalNavigation =\n          previousUrl?.search !== currentUrl.search &&\n          previousUrl?.pathname === currentUrl.pathname;\n        if (isInternalNavigation) {\n          return 'url_history';\n        }\n\n        if (isNavigatingFromPdp()) {\n          return 'url_history_pdp';\n        }\n\n        return 'external';\n      };\n\n      /**\n       * Creates the wire metadata to include in every emitted {@link XEvent}.\n       *\n       * @returns The {@link WireMetadata}.\n       * @internal\n       */\n      const createWireMetadata = (): Pick<WireMetadata, 'feature' | 'location'> => {\n        return {\n          feature: 'url',\n          location: detectLocation()\n        };\n      };\n\n      /**\n       * Emits the {@link UrlXEvents.ParamsLoadedFromUrl} XEvent,\n       * the {@link UrlXEvents.ExtraParamsLoadedFromUrl} XEvent and, if there is query, also emits\n       * the {@link XEventsTypes.UserOpenXProgrammatically}.\n       *\n       * @internal\n       */\n      const emitEvents = () => {\n        const { all, extra } = parseUrlParams();\n        const metadata = createWireMetadata();\n        $x.emit('ParamsLoadedFromUrl', all, metadata);\n        $x.emit('ExtraParamsLoadedFromUrl', extra, metadata);\n        if (all.query) {\n          $x.emit('UserOpenXProgrammatically', undefined, metadata);\n        }\n        urlLoaded.value = true;\n      };\n\n      /**\n       * To emit the Url events just when the URL is load, and before the components mounted events\n       * and state changes, we do it in the created of this component.\n       */\n      onMounted(() => {\n        emitEvents();\n      });\n\n      return {\n        onPageShow,\n        emitEvents\n      };\n    }\n  });\n</script>\n\n<docs lang=\"mdx\">\n## Events\n\nThis component emits the following events:\n\n- [`ParamsLoadedFromUrl`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`ExtraParamsLoadedFromUrl`](https://github.com/empathyco/x/blob/main/packages/x-components/src/wiring/events.types.ts)\n- [`UserOpenXProgrammatically`](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 browser URL parameters to preserve them through reloads and browser\nhistory navigation. It allow to configure the default url parameter names using its attributes. This\ncomponent doesn't render elements to the DOM.\n\n_Try to make some requests and take a look to the url!_\n\n```vue\n<template>\n  <UrlHandler />\n</template>\n\n<script>\n  import { UrlHandler } from '@empathyco/x-components/url-handler';\n\n  export default {\n    name: 'UrlHandlerDemo',\n    components: {\n      UrlHandler\n    }\n  };\n</script>\n```\n\n### Play with props\n\nIn this example, the `UrlHandler` component changes the following query parameter names:\n\n- `query` to be `q`.\n- `page` to be `p`.\n- `filter` to be `f`\n- `sort` to be `s`\n\n_Try to make some requests and take a look to the url!_\n\n```vue\n<template>\n  <UrlHandler query=\"q\" page=\"p\" filter=\"f\" sort=\"s\" />\n</template>\n\n<script>\n  import { UrlHandler } from '@empathyco/x-components/url-handler';\n\n  export default {\n    name: 'UrlHandlerDemo',\n    components: {\n      UrlHandler\n    }\n  };\n</script>\n```\n\n### Play with events\n\nThe `UrlHandler` will emit the `ParamsLoadedFromUrl` when the page is loaded.\n\nThe `UrlHandler` will emit the `ExtraParamsLoadedFromUrl` when the page is loaded with an extra\nparam configured and with a value in URL.\n\nThe `UrlHandler` will emit the `UserOpenXProgrammatically` when the page is loaded with a query in\nthe URL.\n</docs>\n"],"names":["_resolveComponent","_openBlock","_createBlock"],"mappings":";;;;;kCACEA,gBAA8E,CAAA,cAAA,CAAA,CAAA;AAAxC,EAAA,OAAAC,SAAA,EAAoB,EAAAC,WAAA,CAAA,uBAAA,EAAA;AAAA,IAAE,YAAO,IAAQ,CAAA,UAAA;AAAA,IAAA,UAAA,EAAA,IAAA,CAAA,UAAA;;;;;;;;"}