@empathyco/x-components 6.0.0-alpha.17 → 6.0.0-alpha.171

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  { 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;;;;"}
+{"version":3,"file":"wiring.js","sources":["../../../../src/x-modules/tagging/wiring.ts"],"sourcesContent":["import type {\n  AiSuggestionSearch,\n  RelatedPrompt,\n  Result,\n  SemanticQuery,\n  Taggable,\n  Tagging,\n  TaggingRequest,\n} from '@empathyco/x-types'\nimport type { FeatureLocation } from '../../types/index'\nimport type { DisplayWireMetadata, Wire } from '../../wiring/wiring.types'\nimport { DefaultSessionService } from '@empathyco/x-utils'\nimport { createOrigin } from '../../utils/index'\nimport { namespacedWireCommit, namespacedWireDispatch } from '../../wiring/namespaced-wires.factory'\nimport { namespacedDebounce } from '../../wiring/namespaced-wires.operators'\nimport { wireService, wireServiceWithoutPayload } from '../../wiring/wires.factory'\nimport { filter, filterTruthyPayload, mapWire } from '../../wiring/wires.operators'\nimport { createWiring } from '../../wiring/wiring.utils'\nimport { DefaultExternalTaggingService } from './service/external-tagging.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 DefaultExternalTaggingService}.\n */\nconst wireExternalTaggingService = wireService(DefaultExternalTaggingService.instance)\n\n/**\n * Stores the given result on the local storage.\n *\n * @public\n */\nconst storeClickedResultWire = wireExternalTaggingService('storeResultClicked')\n\n/**\n * Stores the result added to cart on the local storage.\n *\n * @public\n */\nconst storeAddToCartWire = wireExternalTaggingService('storeAddToCart')\n\n/**\n * Moves the result information from the local storage to session storage.\n *\n * @public\n */\nconst moveClickedResultToSessionWire = mapWire(\n  wireExternalTaggingService('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 = wireExternalTaggingService('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 as number) > 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 * Tracks the click on a promoted result.\n *\n * @public\n */\nexport const trackPromotedClickedWire = 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 result being clicked.\n *\n * @public\n */\nexport const trackToolingDisplayClickedWire = createTrackToolingDisplayWire()\n\n/**\n * Performs a track of a display result being clicked.\n *\n * @public\n */\nexport const trackToolingAdd2CartWire = createTrackToolingAdd2CartWire()\n\n/**\n * Performs a track of a clicked related prompt.\n *\n * @public\n */\nexport const trackRelatedPromptToolingDisplayClickWire =\n  createTrackRelatedPromptToolingDisplayClickWire()\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      // eslint-disable-next-line ts/no-unsafe-member-access\n      !!tagging?.[property] && !ignoreInModules?.includes(moduleName),\n  )\n}\n\n/**\n * Performs a track of a query with no results that used related prompts or semantic queries as fallback.\n * The totalHits will be changed to -1 if related prompts or semantic queries are found in order to differentiate\n * it from scenarios where the user encounters a no-results page without any related prompts or semantic queries.\n *\n * @public\n */\nexport const trackNoResultsQueryWithFallbackWire = filter(\n  wireDispatch('track', ({ eventPayload, state }) => {\n    const { queryTaggingInfo } = state\n    const totalHits = (eventPayload as RelatedPrompt[] | 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 trackNoResultsQueryWithFallbackWire}\n *\n * @public\n */\nexport const trackNoResultsQueryWithFallbackWireDebounced = moduleDebounce(\n  trackNoResultsQueryWithFallbackWire,\n  ({ state }) => state.config.queryTaggingDebounceMs,\n  { cancelOn: ['QueryPreviewUnmounted', 'RelatedPromptsUnmounted'] },\n)\n\n/**\n * Performs a track of a query with no results that used semantic queries 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 * @deprecated - Use {@link trackNoResultsQueryWithFallbackWire} instead.\n */\nexport const trackNoResultsQueryWithSemanticsWire = trackNoResultsQueryWithFallbackWire\n\n/**\n * Debounced version of {@link trackNoResultsQueryWithFallbackWire}\n *\n * @public\n * @deprecated - Use {@link trackNoResultsQueryWithFallbackWireDebounced} instead.\n */\nexport const trackNoResultsQueryWithSemanticsWireDebounced =\n  trackNoResultsQueryWithFallbackWireDebounced\n\n/**\n * Performs a track of clicking the AI overview expand button when the playload (expanded) is false.\n *\n * @public\n */\nexport const trackAiOverviewButtonClickedWire = filterTruthyPayload(\n  wireDispatch('track', ({ metadata: { toolingDisplayClick, suggestionText } }) => {\n    const taggingInfo = {\n      ...(toolingDisplayClick as TaggingRequest),\n      params: {\n        ...(toolingDisplayClick as TaggingRequest).params,\n        productId: 'EXPAND',\n        title: suggestionText as string,\n        url: 'none',\n      },\n    }\n\n    return taggingInfo\n  }),\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    // eslint-disable-next-line ts/no-unsafe-member-access\n    ({ eventPayload: { tagging } }) => !!tagging?.[property]?.url,\n  )\n}\n\n/**\n * Update the tooling tagging params with the result information.\n *\n * @param taggingRequest - The tooling tagging request to be updated.\n * @param result - The clicked result.\n * @returns The tagging request updated.\n *\n * @internal\n */\nfunction updateToolingTaggingWithResult(\n  taggingRequest: TaggingRequest,\n  result: Result,\n): TaggingRequest {\n  taggingRequest.params.productId = result.id\n  taggingRequest.params.title = result.name!\n  taggingRequest.params.url = result.url!\n\n  return taggingRequest\n}\n\n/**\n * Factory helper to create a wire for the track of the tooling display click.\n *\n * @returns A new wire for the tooling display click of the taggable element.\n *\n * @public\n */\nexport function createTrackToolingDisplayWire(): Wire<Taggable> {\n  return filter(\n    wireDispatch('track', ({ eventPayload, metadata }) => {\n      const taggingInfo: TaggingRequest = metadata.toolingTagging as TaggingRequest\n      const resultInfo = eventPayload as Result\n\n      updateToolingTaggingWithResult(taggingInfo, resultInfo)\n\n      return taggingInfo\n    }),\n    ({ metadata }) => !!metadata?.toolingTagging,\n  )\n}\n\n/**\n * Factory helper to create a wire for the track of the tooling display add to cart.\n *\n * @returns A new wire for the tooling display add to cart of the taggable element.\n *\n * @public\n */\nexport function createTrackToolingAdd2CartWire(): Wire<Taggable> {\n  return filter(\n    wireDispatch('track', ({ eventPayload, metadata }) => {\n      const taggingInfo: TaggingRequest = metadata.toolingAdd2CartTagging as TaggingRequest\n      const resultInfo = eventPayload as Result\n\n      updateToolingTaggingWithResult(taggingInfo, resultInfo)\n\n      return taggingInfo\n    }),\n    ({ metadata }) => !!metadata?.toolingAdd2CartTagging,\n  )\n}\n\n/**\n * Factory helper to create a wire for the track of the tooling display click in a related prompt.\n *\n * @returns A new wire for the tooling display click of the taggable element.\n *\n * @public\n */\nexport function createTrackRelatedPromptToolingDisplayClickWire() {\n  return filter(\n    wireDispatch('track', ({ metadata }) => {\n      const relatedPrompt = metadata.relatedPrompt as RelatedPrompt\n      const taggingInfo = relatedPrompt.tagging!.toolingDisplayClickTagging as TaggingRequest\n\n      taggingInfo.params.productId = 'EXPAND'\n      taggingInfo.params.title = relatedPrompt.suggestionText\n      taggingInfo.params.url = 'none'\n\n      return taggingInfo\n    }),\n    ({ metadata }) => {\n      const relatedPrompt = metadata.relatedPrompt as RelatedPrompt | undefined\n      const isUnselected = metadata?.selectedPrompt === -1\n      const taggingInfo = relatedPrompt?.tagging?.toolingDisplayClickTagging\n      return isUnselected && !!taggingInfo\n    },\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 * Tracks query tagging of the AI suggestions-search.\n * @public\n */\nexport const trackAiSuggestionsSearchWire = wireDispatch('track', ({ eventPayload }) =>\n  (eventPayload as AiSuggestionSearch[]).map(({ tagging }) => tagging.query),\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    storeAddToCartWire,\n  },\n  UserClickedPDPAddToCart: {\n    trackAddToCartFromSessionStorage,\n  },\n  UserClickedABanner: {\n    trackBannerClickedWire,\n  },\n  UserClickedAPromoted: {\n    trackPromotedClickedWire,\n  },\n  UserClickedADisplayResult: {\n    trackDisplayClickedWire,\n    setQueryTaggingFromQueryPreview,\n  },\n  SemanticQueriesResponseChanged: {\n    trackNoResultsQueryWithFallbackWireDebounced,\n  },\n  RelatedPromptsResponseChanged: {\n    trackNoResultsQueryWithFallbackWireDebounced,\n  },\n  ModuleRegistered: {\n    setNoResultsTaggingEnabledWire,\n  },\n  UserClickedARelatedPromptResult: {\n    trackToolingDisplayClickedWire,\n  },\n  UserClickedARelatedPromptAdd2Cart: {\n    trackToolingAdd2CartWire,\n  },\n  UserSelectedARelatedPrompt: {\n    trackRelatedPromptToolingDisplayClickWire,\n  },\n  AiSuggestionsSearchChanged: {\n    trackAiSuggestionsSearchWire,\n  },\n  UserClickedAiOverviewExpandButton: {\n    trackAiOverviewButtonClickedWire,\n  },\n  UserClickedAnAiOverviewResult: {\n    trackToolingDisplayClickedWire,\n  },\n  UserClickedAnAiOverviewAdd2Cart: {\n    trackToolingAdd2CartWire,\n  },\n})\n"],"names":[],"mappings":";;;;;;;;;;AAoBA;;;;AAIG;AACH,MAAM,UAAU,GAAG,SAAS,CAAA;AAE5B;;AAEG;AACH,MAAM,cAAc,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAA;AAErD;;;;AAIG;AACH,MAAM,UAAU,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAA;AAEnD;;;;AAIG;AACH,MAAM,YAAY,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAA;AAEvD;;AAEG;AACH,MAAM,gCAAgC,GAAG,yBAAyB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAA;AAElG;;AAEG;AACH,MAAM,0BAA0B,GAAG,WAAW,CAAC,6BAA6B,CAAC,QAAQ,CAAC,CAAA;AAEtF;;;;AAIG;AACH,MAAM,sBAAsB,GAAG,0BAA0B,CAAC,oBAAoB,CAAC,CAAA;AAE/E;;;;AAIG;AACH,MAAM,kBAAkB,GAAG,0BAA0B,CAAC,gBAAgB,CAAC,CAAA;AAEvE;;;;AAIG;AACH,MAAM,8BAA8B,GAAG,OAAO,CAC5C,0BAA0B,CAAC,sBAAsB,CAAC,EAClD,CAAC,OAAe,KAAI;IAClB,OAAO,OAAO,KAAK,KAAK,GAAG,SAAS,GAAG,OAAO,CAAA;AAChD,CAAC,CACF,CAAA;AAED;;;;AAIG;AACH,MAAM,gCAAgC,GAAG,0BAA0B,CAAC,gBAAgB,CAAC,CAAA;AAErF;;;;AAIG;AACH,MAAM,gBAAgB,GAAG,MAAM,CAC7B,gCAAgC,CAAC,gBAAgB,CAAC,EAClD,CAAC,EAAE,YAAY,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,CACxC,CAAA;AAED;;;;AAIG;MACU,UAAU,GAAG,UAAU,CAAC,YAAY,EAAC;AAElD;;;;AAIG;MACU,8BAA8B,GAAG,UAAU,CAAC,4BAA4B,EAAC;AAEtF;;;;AAIG;MACU,gBAAgB,GAAG,UAAU,CAAC,aAAa,EAAC;AAEzD;;;;AAIG;AACU,MAAA,cAAc,GAAG,MAAM,CAClC,YAAY,CAAC,OAAO,CAAC,EACrB,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,KACpB,YAA+B,CAAC,MAAM,CAAC,SAAoB,GAAG,CAAC;IACjE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,uBAAuB,EACjD;AAED;;;;;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,EACF;AAED;;;;AAIG;AACU,MAAA,+BAA+B,GAAG,qCAAqC,GAAE;AAEtF;;;;AAIG;MACU,sBAAsB,GAAG,eAAe,CAAC,OAAO,EAAC;AAE9D;;;;AAIG;MACU,sBAAsB,GAAG,eAAe,CAAC,OAAO,EAAC;AAE9D;;;;AAIG;MACU,wBAAwB,GAAG,eAAe,CAAC,OAAO,EAAC;AAEhE;;;;AAIG;MACU,kBAAkB,GAAG,eAAe,CAAC,UAAU,EAAC;AAE7D;;;;AAIG;MACU,uBAAuB,GAAG,sBAAsB,CAAC,cAAc,EAAC;AAE7E;;;;AAIG;AACU,MAAA,8BAA8B,GAAG,6BAA6B,GAAE;AAE7E;;;;AAIG;AACU,MAAA,wBAAwB,GAAG,8BAA8B,GAAE;AAExE;;;;AAIG;AACU,MAAA,yCAAyC,GACpD,+CAA+C,GAAE;AAEnD;;;;AAIG;MACU,yBAAyB,GAAG,sBAAsB,CAAC,SAAS,EAAC;AAE1E;;;;;;;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,CAAA;AACrD,QAAA,WAAW,CAAC,MAAM,CAAC,QAAQ,GAAG,QAAkB,CAAA;AAChD,QAAA,OAAO,WAAW,CAAA;AACpB,KAAC,CAAC,EACF,CAAC,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,eAAe,EAAE,EAAE;;AAE3D,IAAA,CAAC,CAAC,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,CAAC,UAAU,CAAC,CAClE,CAAA;AACH,CAAC;AAED;;;;;;AAMG;AACU,MAAA,mCAAmC,GAAG,MAAM,CACvD,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,KAAI;AAChD,IAAA,MAAM,EAAE,gBAAgB,EAAE,GAAG,KAAK,CAAA;AAClC,IAAA,MAAM,SAAS,GAAI,YAAkD,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;IACzF,OAAO;QACL,MAAM,EAAE,EAAE,GAAG,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE;AAClD,QAAA,GAAG,EAAE,gBAAgB,EAAE,GAAG,IAAI,EAAE;KACjC,CAAA;AACH,CAAC,CAAC,EACF,CAAC,EAAE,KAAK,EAAE,KAAK,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,EAAE,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EACtF;AAED;;;;AAIG;AACI,MAAM,4CAA4C,GAAG,cAAc,CACxE,mCAAmC,EACnC,CAAC,EAAE,KAAK,EAAE,KAAK,KAAK,CAAC,MAAM,CAAC,sBAAsB,EAClD,EAAE,QAAQ,EAAE,CAAC,uBAAuB,EAAE,yBAAyB,CAAC,EAAE,EACnE;AAED;;;;;;;AAOG;AACI,MAAM,oCAAoC,GAAG,oCAAmC;AAEvF;;;;;AAKG;AACI,MAAM,6CAA6C,GACxD,6CAA4C;AAE9C;;;;AAIG;MACU,gCAAgC,GAAG,mBAAmB,CACjE,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,mBAAmB,EAAE,cAAc,EAAE,EAAE,KAAI;AAC9E,IAAA,MAAM,WAAW,GAAG;AAClB,QAAA,GAAI,mBAAsC;AAC1C,QAAA,MAAM,EAAE;YACN,GAAI,mBAAsC,CAAC,MAAM;AACjD,YAAA,SAAS,EAAE,QAAQ;AACnB,YAAA,KAAK,EAAE,cAAwB;AAC/B,YAAA,GAAG,EAAE,MAAM;AACZ,SAAA;KACF,CAAA;AAED,IAAA,OAAO,WAAW,CAAA;AACpB,CAAC,CAAC,EACH;AAED;;;;;;;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,CAAA;AACrD,QAAA,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAA2B,CAAA;AAErD,QAAA,WAAW,CAAC,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAA;AACtC,QAAA,WAAW,CAAC,MAAM,CAAC,aAAa,GAAG,YAAY,CAAC;YAC9C,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,QAAQ;AACT,SAAA,CAAE,CAAA;QACH,WAAW,CAAC,MAAM,CAAC,CAAC,GAAI,QAAgC,CAAC,oBAAoB,CAAA;AAE7E,QAAA,OAAO,WAAW,CAAA;AACpB,KAAC,CAAC;;IAEF,CAAC,EAAE,YAAY,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC,OAAO,GAAG,QAAQ,CAAC,EAAE,GAAG,CAC9D,CAAA;AACH,CAAC;AAED;;;;;;;;AAQG;AACH,SAAS,8BAA8B,CACrC,cAA8B,EAC9B,MAAc,EAAA;IAEd,cAAc,CAAC,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,EAAE,CAAA;IAC3C,cAAc,CAAC,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,IAAK,CAAA;IAC1C,cAAc,CAAC,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,GAAI,CAAA;AAEvC,IAAA,OAAO,cAAc,CAAA;AACvB,CAAC;AAED;;;;;;AAMG;SACa,6BAA6B,GAAA;AAC3C,IAAA,OAAO,MAAM,CACX,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,KAAI;AACnD,QAAA,MAAM,WAAW,GAAmB,QAAQ,CAAC,cAAgC,CAAA;QAC7E,MAAM,UAAU,GAAG,YAAsB,CAAA;AAEzC,QAAA,8BAA8B,CAAC,WAAW,EAAE,UAAU,CAAC,CAAA;AAEvD,QAAA,OAAO,WAAW,CAAA;AACpB,KAAC,CAAC,EACF,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,QAAQ,EAAE,cAAc,CAC7C,CAAA;AACH,CAAC;AAED;;;;;;AAMG;SACa,8BAA8B,GAAA;AAC5C,IAAA,OAAO,MAAM,CACX,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,KAAI;AACnD,QAAA,MAAM,WAAW,GAAmB,QAAQ,CAAC,sBAAwC,CAAA;QACrF,MAAM,UAAU,GAAG,YAAsB,CAAA;AAEzC,QAAA,8BAA8B,CAAC,WAAW,EAAE,UAAU,CAAC,CAAA;AAEvD,QAAA,OAAO,WAAW,CAAA;AACpB,KAAC,CAAC,EACF,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,QAAQ,EAAE,sBAAsB,CACrD,CAAA;AACH,CAAC;AAED;;;;;;AAMG;SACa,+CAA+C,GAAA;IAC7D,OAAO,MAAM,CACX,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,QAAQ,EAAE,KAAI;AACrC,QAAA,MAAM,aAAa,GAAG,QAAQ,CAAC,aAA8B,CAAA;AAC7D,QAAA,MAAM,WAAW,GAAG,aAAa,CAAC,OAAQ,CAAC,0BAA4C,CAAA;AAEvF,QAAA,WAAW,CAAC,MAAM,CAAC,SAAS,GAAG,QAAQ,CAAA;QACvC,WAAW,CAAC,MAAM,CAAC,KAAK,GAAG,aAAa,CAAC,cAAc,CAAA;AACvD,QAAA,WAAW,CAAC,MAAM,CAAC,GAAG,GAAG,MAAM,CAAA;AAE/B,QAAA,OAAO,WAAW,CAAA;AACpB,KAAC,CAAC,EACF,CAAC,EAAE,QAAQ,EAAE,KAAI;AACf,QAAA,MAAM,aAAa,GAAG,QAAQ,CAAC,aAA0C,CAAA;QACzE,MAAM,YAAY,GAAG,QAAQ,EAAE,cAAc,KAAK,CAAC,CAAC,CAAA;AACpD,QAAA,MAAM,WAAW,GAAG,aAAa,EAAE,OAAO,EAAE,0BAA0B,CAAA;AACtE,QAAA,OAAO,YAAY,IAAI,CAAC,CAAC,WAAW,CAAA;AACtC,KAAC,CACF,CAAA;AACH,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,CAAA;AACH,CAAC;AAED;;;AAGG;AACI,MAAM,4BAA4B,GAAG,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,KAChF,YAAqC,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,KAAK,CAAC,EAC3E;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;QACtB,kBAAkB;AACnB,KAAA;AACD,IAAA,uBAAuB,EAAE;QACvB,gCAAgC;AACjC,KAAA;AACD,IAAA,kBAAkB,EAAE;QAClB,sBAAsB;AACvB,KAAA;AACD,IAAA,oBAAoB,EAAE;QACpB,wBAAwB;AACzB,KAAA;AACD,IAAA,yBAAyB,EAAE;QACzB,uBAAuB;QACvB,+BAA+B;AAChC,KAAA;AACD,IAAA,8BAA8B,EAAE;QAC9B,4CAA4C;AAC7C,KAAA;AACD,IAAA,6BAA6B,EAAE;QAC7B,4CAA4C;AAC7C,KAAA;AACD,IAAA,gBAAgB,EAAE;QAChB,8BAA8B;AAC/B,KAAA;AACD,IAAA,+BAA+B,EAAE;QAC/B,8BAA8B;AAC/B,KAAA;AACD,IAAA,iCAAiC,EAAE;QACjC,wBAAwB;AACzB,KAAA;AACD,IAAA,0BAA0B,EAAE;QAC1B,yCAAyC;AAC1C,KAAA;AACD,IAAA,0BAA0B,EAAE;QAC1B,4BAA4B;AAC7B,KAAA;AACD,IAAA,iCAAiC,EAAE;QACjC,gCAAgC;AACjC,KAAA;AACD,IAAA,6BAA6B,EAAE;QAC7B,8BAA8B;AAC/B,KAAA;AACD,IAAA,+BAA+B,EAAE;QAC/B,wBAAwB;AACzB,KAAA;AACF,CAAA;;;;"}

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

@@ -3,18 +3,18 @@ import { taggingEmitters } from './store/emitters.js';
 import { taggingXStoreModule } from './store/module.js';
 import { taggingWiring } from './wiring.js';
 
-/**
- * Tagging {@link XModule} implementation. This module is auto-registered as soon as you
- * import any component from the `empathize` entry point.
- *
- * @public
- */
-const taggingXModule = {
-    name: 'tagging',
-    storeModule: taggingXStoreModule,
-    storeEmitters: taggingEmitters,
-    wiring: taggingWiring
-};
+/**
+ * Tagging {@link XModule} implementation. This module is auto-registered as soon as you
+ * import any component from the `empathize` entry point.
+ *
+ * @public
+ */
+const taggingXModule = {
+    name: 'tagging',
+    storeModule: taggingXStoreModule,
+    storeEmitters: taggingEmitters,
+    wiring: taggingWiring,
+};
 XPlugin.registerXModule(taggingXModule);
 
 export { taggingXModule };

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 { 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;;;;"}
+{"version":3,"file":"x-module.js","sources":["../../../../src/x-modules/tagging/x-module.ts"],"sourcesContent":["import type { XModule } from '../x-modules.types'\nimport type { TaggingXStoreModule } from './store/types'\nimport { XPlugin } from '../../plugins/x-plugin'\nimport { taggingEmitters } from './store/emitters'\nimport { taggingXStoreModule } from './store/module'\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;EACtB;AAED,OAAO,CAAC,eAAe,CAAC,cAAc,CAAC;;;;"}

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

@@ -5,9 +5,9 @@ import _export_sfc from '../../../_virtual/_plugin-vue_export-helper.js';
 function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
   const _component_GlobalEvents = resolveComponent("GlobalEvents");
   return openBlock(), createBlock(_component_GlobalEvents, {
+    target: "window",
     onPageshow: _ctx.onPageShow,
-    onPopstate: _ctx.emitEvents,
-    target: "window"
+    onPopstate: _ctx.emitEvents
   }, null, 8, ["onPageshow", "onPopstate"]);
 }
 var urlHandler = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);

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 { 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;;;;;;;;"}
+{"version":3,"file":"url-handler.vue.js","sources":["../../../../../src/x-modules/url/components/url-handler.vue"],"sourcesContent":["<template>\n  <GlobalEvents target=\"window\" @pageshow=\"onPageShow\" @popstate=\"emitEvents\" />\n</template>\n\n<script lang=\"ts\">\nimport type { Dictionary } from '@empathyco/x-utils'\nimport type { FeatureLocation } from '../../../types/origin'\nimport type { UrlParams } from '../../../types/url-params'\nimport type { WireMetadata } from '../../../wiring/wiring.types'\nimport type { SnippetConfig } from '../../../x-installer/api/api.types'\nimport type { UrlParamValue } from '../store/types'\nimport { objectFilter } from '@empathyco/x-utils'\nimport { computed, defineComponent, inject, onMounted, ref } from 'vue'\nimport { GlobalEvents } from 'vue-global-events'\nimport { use$x } from '../../../composables/use-$x'\nimport { useState } from '../../../composables/use-state'\nimport { isArrayEmpty } from '../../../utils/array'\nimport { initialUrlState } from '../store/initial-state'\nimport { urlXModule } from '../x-module'\n\ninterface 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 */\nexport default defineComponent({\n  name: 'UrlHandler',\n  components: {\n    GlobalEvents,\n  },\n  xModule: urlXModule.name,\n  inheritAttrs: false,\n  setup(_, { attrs }) {\n    const $x = use$x()\n\n    const { initialExtraParams } = useState('url')\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(() => Object.keys({ ...initialUrlState, ...attrs }))\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) => {\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) => {\n      managedParamsNames.value.forEach(paramName => url.searchParams.delete(getUrlKey(paramName)))\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        // Normalize '+' characters into '%20' for spaces in url params.\n        newUrl.search = newUrl.search.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 && 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>\nimport { UrlHandler } from '@empathyco/x-components/url-handler'\n\nexport 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>\nimport { UrlHandler } from '@empathyco/x-components/url-handler'\n\nexport 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":["_createBlock"],"mappings":";;;;;;sBACEA,WAA8E,CAAA,uBAAA,EAAA;AAAA,IAAhE,MAAO,EAAA,QAAA;AAAA,IAAU,UAAU,EAAA,IAAA,CAAA,UAAA;AAAA,IAAa,UAAU,EAAA,IAAA,CAAA,UAAA;AAAA,GAAA,EAAA,IAAA,EAAA,CAAA,EAAA,CAAA,YAAA,EAAA,YAAA,CAAA,CAAA,CAAA;;;;;;"}