npm - @empathyco/x-components - Versions diffs - 3.0.0-alpha.76 → 3.0.0-alpha.79 - Mend

@empathyco/x-components 3.0.0-alpha.76 → 3.0.0-alpha.79

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (193) hide show

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

	@@ -1 +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 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 { objectFilter } from '../../../utils/object';\n import { Dictionary } from '../../../utils/types';\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 manage the browser URL parameters to perserve 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('PushableUrlStateChanged')\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('ReplaceableUrlStateChanged')\n updateUrlWithReplace(newUrlParams: UrlParams): void {\n this.updateUrl(newUrlParams, window.history.replaceState.bind(window.history));\n }\n\n /\n Handler of the\n * {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/pageshow_event \| pageshow }\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 \| XEvents}.\n \n @returns The {@link WireMetadata \| metadata}.\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 \| location} used to build the\n * {@link QueryOriginInit \| events metadata origin}.\n \n @returns The {@link FeatureLocation \| location}.\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 if (url.href.replace(/\\+/g, '%20') !== 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 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`](./../../api/x-components.urlxevents.paramsloadedfromurl.md)\n- [`ExtraParamsLoadedFromUrl`](./../../api/x-components.urlxevents.extraparamsloadedfromurl.md)\n- [`UserOpenXProgrammatically`](./../../api/x-components.xeventstypes.useropenxprogrammatically.md)\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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
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 manage the browser URL parameters to perserve 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('PushableUrlStateChanged')\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('ReplaceableUrlStateChanged')\n updateUrlWithReplace(newUrlParams: UrlParams): void {\n this.updateUrl(newUrlParams, window.history.replaceState.bind(window.history));\n }\n\n /\n Handler of the\n * {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/pageshow_event \| pageshow }\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 \| XEvents}.\n \n @returns The {@link WireMetadata \| metadata}.\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 \| location} used to build the\n * {@link QueryOriginInit \| events metadata origin}.\n \n @returns The {@link FeatureLocation \| location}.\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 if (url.href.replace(/\\+/g, '%20') !== 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 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`](./../../api/x-components.urlxevents.paramsloadedfromurl.md)\n- [`ExtraParamsLoadedFromUrl`](./../../api/x-components.urlxevents.extraparamsloadedfromurl.md)\n- [`UserOpenXProgrammatically`](./../../api/x-components.xeventstypes.useropenxprogrammatically.md)\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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/js/x-modules/url/components/url-handler.vue_rollup-plugin-vue_script.vue.js CHANGED Viewed

@@ -1,4 +1,5 @@
 import { __decorate } from 'tslib';
+import { objectFilter } from '@empathyco/x-utils';
 import Vue from 'vue';
 import GlobalEvents from 'vue-global-events';
 import { Inject, Component } from 'vue-property-decorator';
@@ -117,7 +118,6 @@ import { isArrayEmpty } from '../../../utils/array.js';
 import { State } from '../../../components/decorators/store.decorators.js';
 import '../../../components/items-list-injection.mixin.js';
 import { xComponentMixin } from '../../../components/x-component.mixin.js';
-import { objectFilter } from '../../../utils/object.js';
 import { initialUrlState } from '../store/initial-state.js';
 import { urlXModule } from '../x-module.js';

package/js/x-modules/url/components/url-handler.vue_rollup-plugin-vue_script.vue.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"url-handler.vue_rollup-plugin-vue_script.vue.js","sources":["../../../../../src/x-modules/url/components/url-handler.vue?rollup-plugin-vue=script.ts"],"sourcesContent":["\n\n\n\n\nimport Vue from 'vue';\nimport GlobalEvents from 'vue-global-events';\nimport { Component, Inject } from 'vue-property-decorator';\nimport { State } from '../../../components';\nimport { XOn } from '../../../components/decorators/bus.decorators';\nimport { xComponentMixin } from '../../../components/x-component.mixin';\nimport { FeatureLocation } from '../../../types/origin';\nimport { UrlParams } from '../../../types/url-params';\nimport { isArrayEmpty } from '../../../utils/array';\nimport { objectFilter } from '../../../utils/object';\nimport { Dictionary } from '../../../utils/types';\nimport { WireMetadata } from '../../../wiring/wiring.types';\nimport { SnippetConfig } from '../../../x-installer/api/api.types';\nimport { initialUrlState } from '../store/initial-state';\nimport { UrlParamValue } from '../store/types';\nimport { urlXModule } from '../x-module';\n\ninterface ParsedUrlParams {\n all: UrlParams;\n extra: Dictionary<unknown>;\n}\n\n/*\n This component manage the browser URL parameters to perserve 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})\nexport 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('PushableUrlStateChanged')\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('ReplaceableUrlStateChanged')\n updateUrlWithReplace(newUrlParams: UrlParams): void {\n this.updateUrl(newUrlParams, window.history.replaceState.bind(window.history));\n }\n\n /\n Handler of the\n * {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/pageshow_event \| pageshow }\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 \| XEvents}.\n \n @returns The {@link WireMetadata \| metadata}.\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 \| location} used to build the\n * {@link QueryOriginInit \| events metadata origin}.\n \n @returns The {@link FeatureLocation \| location}.\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 if (url.href.replace(/\\+/g, '%20') !== 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 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"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA;;;;;;;AAaA,IAAqB,UAAU,GAA/B,MAAqB,UAAW,SAAQ,GAAG;IAA3C;;;;;;;QAcY,cAAS,GAAG,KAAK,CAAC;;;;;;QAclB,oBAAe,GAAG,KAAK,CAAC;KAkTnC;;;;;;;;;;IAvSC,IAAc,kBAAkB;QAC9B,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,eAAe,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;KAC5D;;;;;;;;;;IAcS,SAAS,CAAC,SAAiB;QACnC,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC;KAC5C;;;;;IAMD,OAAO;QACL,IAAI,CAAC,UAAU,EAAE,CAAC;KACnB;;;;;;IAQD,iBAAiB,CAAC,YAAuB;QACvC,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;KAC7E;;;;;;;IASD,oBAAoB,CAAC,YAAuB;QAC1C,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;KAChF;;;;;;;;;;;;;IAcS,UAAU,CAAC,KAA0B;QAC7C,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,SAAS,CAAC;QACvC,IAAI,KAAK,CAAC,SAAS,EAAE;;;YAGnB,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC;SACtB;KACF;;;;;;;;IASS,UAAU;QAClB,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC3C,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,qBAAqB,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;QACnD,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,0BAA0B,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;;QAE1D,IAAI,GAAG,CAAC,KAAK,EAAE;YACb,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,2BAA2B,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;SAChE;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;KACvB;;;;;;;IAQS,kBAAkB;QAC1B,OAAO;YACL,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,IAAI,CAAC,cAAc,EAAE;SAChC,CAAC;KACH;;;;;;;;IASS,cAAc;QACtB,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACjD,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC;QAC7B,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC;QAEtB,MAAM,oBAAoB,GACxB,WAAW,EAAE,MAAM,KAAK,UAAU,CAAC,MAAM,IAAI,WAAW,EAAE,QAAQ,KAAK,UAAU,CAAC,QAAQ,CAAC;QAC7F,IAAI,oBAAoB,EAAE;YACxB,OAAO,aAAa,CAAC;SACtB;QAED,IAAI,IAAI,CAAC,mBAAmB,EAAE,EAAE;YAC9B,OAAO,iBAAiB,CAAC;SAC1B;QAED,OAAO,UAAU,CAAC;KACnB;;;;;;;;;;;;;;IAeS,mBAAmB;QAC3B,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAC7C,MAAM,iBAAiB,GAAG,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QAC5E,MAAM,cAAc,GAAI,iBAAiB,CAAC,CAAC,CAAiC,EAAE,IAAI,CAAC;QACnF,MAAM,mBAAmB,GACvB,MAAM,CAAC,WAAW,CAAC,UAAU;aAC5B,YAAY,CAAC,iBAAiB,CAAC,IAAI,cAAc,KAAK,QAAQ,CAAC,CAAC;;QAGnE,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAE7B,IAAI,mBAAmB,EAAE;YACvB,MAAM,EACJ,IAAI,EAAE,sBAAsB,EAC5B,iBAAiB,EACjB,aAAa,EACd,GAAG,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC;YAClC,MAAM,iBAAiB,GACrB,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,IAAI,sBAAsB,KAAK,aAAa,CAAC;YAC1E,OAAO,sBAAsB,KAAK,iBAAiB,IAAI,iBAAiB,IAAI,eAAe,CAAC;SAC7F;aAAM;YACL,MAAM,iBAAiB,GAAG,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,IAAI,cAAc,KAAK,UAAU,CAAC;YACvF,OAAO,cAAc,KAAK,cAAc,IAAI,iBAAiB,IAAI,eAAe,CAAC;SAClF;KACF;;;;;;;IAQS,cAAc;QACtB,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC;QACnE,OAAO,IAAI,CAAC,kBAAkB,CAAC,MAAM,CACnC,CAAC,MAAM,EAAE,IAAI;YACX,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACpC,IAAI,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;gBAC/B,IAAI,IAAI,IAAI,eAAe,EAAE;oBAC3B,MAAM,QAAQ,GAAG,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;oBAChD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;iBACvD;qBAAM;oBACL,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;iBACrE;aACF;YACD,OAAO,MAAM,CAAC;SACf,EACD,EAAE,GAAG,EAAE,EAAE,GAAG,eAAe,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,EAAE,EAAE,CACvE,CAAC;KACH;;;;;;;;;;;IAYS,SAAS,CACjB,YAAuB,EACvB,aAA6D;QAE7D,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC1C,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;YAC9B,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;YACzC,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC3D,aAAa,CAAC,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;aACtE;YACD,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;SAChB;KACF;;;;;;;IAQS,mBAAmB,CAAC,GAAQ;QACpC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,SAAS,IACvC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CACnD,CAAC;KACH;;;;;;;;;;;;;IAcS,gBAAgB,CAAC,GAAQ,EAAE,SAAoB;QACvD,MAAM,cAAc,GAAG,YAAY,CAAC,SAAS,EAAE,SAAS,IACtD,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,SAAmB,CAAC,CACtD,CAAC;QACF,MAAM,gBAAgB,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;QACzD,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,UAAU,CAAC;YAC/C,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;YAC9C,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;gBAC7B,UAAU,CAAC,OAAO,CAAC,KAAK;oBACtB,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;iBACrD,CAAC,CAAC;aACJ;iBAAM;gBACL,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;aACvD;SACF,CAAC,CAAC;KACJ;;;;;;;;;IAUS,UAAU,CAAC,SAAoB;QACvC,OAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC;YACvD,OAAO,MAAM,GAAG,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;SACjC,CAAC,CAAC;KACJ;;;;;;;;;;;;IAaS,aAAa,CAAC,IAAY,EAAE,KAAe;QACnD,QAAQ,OAAO,eAAe,CAAC,IAAI,CAAC;YAClC,KAAK,QAAQ;gBACX,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1B,KAAK,SAAS;gBACZ,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC;YAC3C,KAAK,QAAQ;gBACX,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;YAClB;;gBAEE,OAAO,KAAK,CAAC;SAChB;KACF;CACF,CAAA;AAvUC;IADC,MAAM,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;iDACS;AAqCxC;IADC,KAAK,CAAC,KAAK,EAAE,oBAAoB,CAAC;sDACa;AA6BhD;IADC,GAAG,CAAC,yBAAyB,CAAC;mDAG9B;AASD;IADC,GAAG,CAAC,4BAA4B,CAAC;sDAGjC;AAtFkB,UAAU;IAN9B,SAAS,CAAC;QACT,UAAU,EAAE;YACV,YAAY;SACb;QACD,MAAM,EAAE,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;KACtC,CAAC;GACmB,UAAU,CA8U9B;aA9UoB,UAAU;;;;"}
1	+ {"version":3,"file":"url-handler.vue_rollup-plugin-vue_script.vue.js","sources":["../../../../../src/x-modules/url/components/url-handler.vue?rollup-plugin-vue=script.ts"],"sourcesContent":["\n\n\n\n\nimport { Dictionary, objectFilter } from '@empathyco/x-utils';\nimport Vue from 'vue';\nimport GlobalEvents from 'vue-global-events';\nimport { Component, Inject } from 'vue-property-decorator';\nimport { State } from '../../../components';\nimport { XOn } from '../../../components/decorators/bus.decorators';\nimport { xComponentMixin } from '../../../components/x-component.mixin';\nimport { FeatureLocation } from '../../../types/origin';\nimport { UrlParams } from '../../../types/url-params';\nimport { isArrayEmpty } from '../../../utils/array';\nimport { WireMetadata } from '../../../wiring/wiring.types';\nimport { SnippetConfig } from '../../../x-installer/api/api.types';\nimport { initialUrlState } from '../store/initial-state';\nimport { UrlParamValue } from '../store/types';\nimport { urlXModule } from '../x-module';\n\ninterface ParsedUrlParams {\n all: UrlParams;\n extra: Dictionary<unknown>;\n}\n\n/*\n This component manage the browser URL parameters to perserve 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})\nexport 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('PushableUrlStateChanged')\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('ReplaceableUrlStateChanged')\n updateUrlWithReplace(newUrlParams: UrlParams): void {\n this.updateUrl(newUrlParams, window.history.replaceState.bind(window.history));\n }\n\n /\n Handler of the\n * {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/pageshow_event \| pageshow }\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 \| XEvents}.\n \n @returns The {@link WireMetadata \| metadata}.\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 \| location} used to build the\n * {@link QueryOriginInit \| events metadata origin}.\n \n @returns The {@link FeatureLocation \| location}.\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 if (url.href.replace(/\\+/g, '%20') !== 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 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"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA;;;;;;;AAaA,IAAqB,UAAU,GAA/B,MAAqB,UAAW,SAAQ,GAAG;IAA3C;;;;;;;QAcY,cAAS,GAAG,KAAK,CAAC;;;;;;QAclB,oBAAe,GAAG,KAAK,CAAC;KAkTnC;;;;;;;;;;IAvSC,IAAc,kBAAkB;QAC9B,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,eAAe,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;KAC5D;;;;;;;;;;IAcS,SAAS,CAAC,SAAiB;QACnC,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC;KAC5C;;;;;IAMD,OAAO;QACL,IAAI,CAAC,UAAU,EAAE,CAAC;KACnB;;;;;;IAQD,iBAAiB,CAAC,YAAuB;QACvC,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;KAC7E;;;;;;;IASD,oBAAoB,CAAC,YAAuB;QAC1C,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;KAChF;;;;;;;;;;;;;IAcS,UAAU,CAAC,KAA0B;QAC7C,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,SAAS,CAAC;QACvC,IAAI,KAAK,CAAC,SAAS,EAAE;;;YAGnB,IAAI,CAAC,GAAG,GAAG,SAAS,CAAC;SACtB;KACF;;;;;;;;IASS,UAAU;QAClB,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC3C,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,qBAAqB,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;QACnD,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,0BAA0B,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;;QAE1D,IAAI,GAAG,CAAC,KAAK,EAAE;YACb,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,2BAA2B,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;SAChE;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;KACvB;;;;;;;IAQS,kBAAkB;QAC1B,OAAO;YACL,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,IAAI,CAAC,cAAc,EAAE;SAChC,CAAC;KACH;;;;;;;;IASS,cAAc;QACtB,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACjD,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC;QAC7B,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC;QAEtB,MAAM,oBAAoB,GACxB,WAAW,EAAE,MAAM,KAAK,UAAU,CAAC,MAAM,IAAI,WAAW,EAAE,QAAQ,KAAK,UAAU,CAAC,QAAQ,CAAC;QAC7F,IAAI,oBAAoB,EAAE;YACxB,OAAO,aAAa,CAAC;SACtB;QAED,IAAI,IAAI,CAAC,mBAAmB,EAAE,EAAE;YAC9B,OAAO,iBAAiB,CAAC;SAC1B;QAED,OAAO,UAAU,CAAC;KACnB;;;;;;;;;;;;;;IAeS,mBAAmB;QAC3B,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAC7C,MAAM,iBAAiB,GAAG,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QAC5E,MAAM,cAAc,GAAI,iBAAiB,CAAC,CAAC,CAAiC,EAAE,IAAI,CAAC;QACnF,MAAM,mBAAmB,GACvB,MAAM,CAAC,WAAW,CAAC,UAAU;aAC5B,YAAY,CAAC,iBAAiB,CAAC,IAAI,cAAc,KAAK,QAAQ,CAAC,CAAC;;QAGnE,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAE7B,IAAI,mBAAmB,EAAE;YACvB,MAAM,EACJ,IAAI,EAAE,sBAAsB,EAC5B,iBAAiB,EACjB,aAAa,EACd,GAAG,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC;YAClC,MAAM,iBAAiB,GACrB,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,IAAI,sBAAsB,KAAK,aAAa,CAAC;YAC1E,OAAO,sBAAsB,KAAK,iBAAiB,IAAI,iBAAiB,IAAI,eAAe,CAAC;SAC7F;aAAM;YACL,MAAM,iBAAiB,GAAG,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,KAAK,IAAI,cAAc,KAAK,UAAU,CAAC;YACvF,OAAO,cAAc,KAAK,cAAc,IAAI,iBAAiB,IAAI,eAAe,CAAC;SAClF;KACF;;;;;;;IAQS,cAAc;QACtB,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC;QACnE,OAAO,IAAI,CAAC,kBAAkB,CAAC,MAAM,CACnC,CAAC,MAAM,EAAE,IAAI;YACX,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACpC,IAAI,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;gBAC/B,IAAI,IAAI,IAAI,eAAe,EAAE;oBAC3B,MAAM,QAAQ,GAAG,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;oBAChD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;iBACvD;qBAAM;oBACL,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;iBACrE;aACF;YACD,OAAO,MAAM,CAAC;SACf,EACD,EAAE,GAAG,EAAE,EAAE,GAAG,eAAe,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,EAAE,EAAE,CACvE,CAAC;KACH;;;;;;;;;;;IAYS,SAAS,CACjB,YAAuB,EACvB,aAA6D;QAE7D,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC1C,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;YAC9B,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;YACzC,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC3D,aAAa,CAAC,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;aACtE;YACD,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;SAChB;KACF;;;;;;;IAQS,mBAAmB,CAAC,GAAQ;QACpC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,SAAS,IACvC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CACnD,CAAC;KACH;;;;;;;;;;;;;IAcS,gBAAgB,CAAC,GAAQ,EAAE,SAAoB;QACvD,MAAM,cAAc,GAAG,YAAY,CAAC,SAAS,EAAE,SAAS,IACtD,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,SAAmB,CAAC,CACtD,CAAC;QACF,MAAM,gBAAgB,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;QACzD,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,UAAU,CAAC;YAC/C,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;YAC9C,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;gBAC7B,UAAU,CAAC,OAAO,CAAC,KAAK;oBACtB,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;iBACrD,CAAC,CAAC;aACJ;iBAAM;gBACL,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;aACvD;SACF,CAAC,CAAC;KACJ;;;;;;;;;IAUS,UAAU,CAAC,SAAoB;QACvC,OAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC;YACvD,OAAO,MAAM,GAAG,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;SACjC,CAAC,CAAC;KACJ;;;;;;;;;;;;IAaS,aAAa,CAAC,IAAY,EAAE,KAAe;QACnD,QAAQ,OAAO,eAAe,CAAC,IAAI,CAAC;YAClC,KAAK,QAAQ;gBACX,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1B,KAAK,SAAS;gBACZ,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC;YAC3C,KAAK,QAAQ;gBACX,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;YAClB;;gBAEE,OAAO,KAAK,CAAC;SAChB;KACF;CACF,CAAA;AAvUC;IADC,MAAM,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;iDACS;AAqCxC;IADC,KAAK,CAAC,KAAK,EAAE,oBAAoB,CAAC;sDACa;AA6BhD;IADC,GAAG,CAAC,yBAAyB,CAAC;mDAG9B;AASD;IADC,GAAG,CAAC,4BAA4B,CAAC;sDAGjC;AAtFkB,UAAU;IAN9B,SAAS,CAAC;QACT,UAAU,EAAE;YACV,YAAY;SACb;QACD,MAAM,EAAE,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;KACtC,CAAC;GACmB,UAAU,CA8U9B;aA9UoB,UAAU;;;;"}

package/js/x-modules/url/store/getters/url-params.getter.js CHANGED Viewed

@@ -1,4 +1,4 @@
-import { objectFilter } from '../../../../utils/object.js';
+import { objectFilter } from '@empathyco/x-utils';
 import { initialUrlState } from '../initial-state.js';
 /**

package/js/x-modules/url/store/getters/url-params.getter.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"url-params.getter.js","sources":["../../../../../../src/x-modules/url/store/getters/url-params.getter.ts"],"sourcesContent":["import { objectFilter } from '~~../../../../~~utils~~/object~~';\nimport { initialUrlState } from '../initial-state';\nimport { UrlParamValue, UrlXStoreModule } from '../types';\n\n/*\n Default implementation for the {@link UrlGetters.urlParams} getter.\n \n @param state - Current {@link https://vuex.vuejs.org/guide/state.html \| state} of the url module.\n \n @returns The url params.\n \n @public\n /\nexport const urlParams: UrlXStoreModule['getters']['urlParams'] = ({\n initialExtraParams,\n ...params\n}) =>\n objectFilter(params, (paramKey, paramValue) => {\n return paramKey in initialUrlState\n ? isNotDefaultValue(paramKey, paramValue, initialUrlState)\n : isNotEmptyParam(paramValue) && isNotDefaultValue(paramKey, paramValue, initialExtraParams);\n });\n\n/\n Checks if a parameter is not empty to avoid adding it to the URL.\n \n @param value - The value of the key parameter.\n \n @returns True if is not empty, False otherwise.\n /\nfunction isNotEmptyParam(value: UrlParamValue \| unknown): boolean {\n return Array.isArray(value) ? value.length > 0 : value != null && value !== '';\n}\n\n/\n Checks if a parameter is not the default state value to avoid adding it to the URL.\n \n @param key - The key parameter.\n * @param value - The value of the key parameter.\n * @param defaultValues - The default values to compare.\n \n @returns True if is not the default state value, False otherwise.\n */\nfunction isNotDefaultValue<Key extends string \| number, Value extends UrlParamValue \| unknown>(\n key: Key,\n value: Value,\n defaultValues: Record<Key, Value>\n): boolean {\n return Array.isArray(value) ? value.length > 0 : defaultValues[key] !== value;\n}\n"],"names":[],"mappings":";;;AAIA;;;;;;;;;MASa,SAAS,GAA4C,CAAC,EACjE,kBAAkB,EAClB,GAAG,MAAM,EACV,KACC,YAAY,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,UAAU;IACxC,OAAO,QAAQ,IAAI,eAAe;UAC9B,iBAAiB,CAAC,QAAQ,EAAE,UAAU,EAAE,eAAe,CAAC;UACxD,eAAe,CAAC,UAAU,CAAC,IAAI,iBAAiB,CAAC,QAAQ,EAAE,UAAU,EAAE,kBAAkB,CAAC,CAAC;AACjG,CAAC,EAAE;AAEL;;;;;;;AAOA,SAAS,eAAe,CAAC,KAA8B;IACrD,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;AACjF,CAAC;AAED;;;;;;;;;AASA,SAAS,iBAAiB,CACxB,GAAQ,EACR,KAAY,EACZ,aAAiC;IAEjC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC;AAChF;;;;"}
1	+ {"version":3,"file":"url-params.getter.js","sources":["../../../../../../src/x-modules/url/store/getters/url-params.getter.ts"],"sourcesContent":["import { objectFilter } from '@empathyco/x-utils';\nimport { initialUrlState } from '../initial-state';\nimport { UrlParamValue, UrlXStoreModule } from '../types';\n\n/*\n Default implementation for the {@link UrlGetters.urlParams} getter.\n \n @param state - Current {@link https://vuex.vuejs.org/guide/state.html \| state} of the url module.\n \n @returns The url params.\n \n @public\n /\nexport const urlParams: UrlXStoreModule['getters']['urlParams'] = ({\n initialExtraParams,\n ...params\n}) =>\n objectFilter(params, (paramKey, paramValue) => {\n return paramKey in initialUrlState\n ? isNotDefaultValue(paramKey, paramValue, initialUrlState)\n : isNotEmptyParam(paramValue) && isNotDefaultValue(paramKey, paramValue, initialExtraParams);\n });\n\n/\n Checks if a parameter is not empty to avoid adding it to the URL.\n \n @param value - The value of the key parameter.\n \n @returns True if is not empty, False otherwise.\n /\nfunction isNotEmptyParam(value: UrlParamValue \| unknown): boolean {\n return Array.isArray(value) ? value.length > 0 : value != null && value !== '';\n}\n\n/\n Checks if a parameter is not the default state value to avoid adding it to the URL.\n \n @param key - The key parameter.\n * @param value - The value of the key parameter.\n * @param defaultValues - The default values to compare.\n \n @returns True if is not the default state value, False otherwise.\n */\nfunction isNotDefaultValue<Key extends string \| number, Value extends UrlParamValue \| unknown>(\n key: Key,\n value: Value,\n defaultValues: Record<Key, Value>\n): boolean {\n return Array.isArray(value) ? value.length > 0 : defaultValues[key] !== value;\n}\n"],"names":[],"mappings":";;;AAIA;;;;;;;;;MASa,SAAS,GAA4C,CAAC,EACjE,kBAAkB,EAClB,GAAG,MAAM,EACV,KACC,YAAY,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,UAAU;IACxC,OAAO,QAAQ,IAAI,eAAe;UAC9B,iBAAiB,CAAC,QAAQ,EAAE,UAAU,EAAE,eAAe,CAAC;UACxD,eAAe,CAAC,UAAU,CAAC,IAAI,iBAAiB,CAAC,QAAQ,EAAE,UAAU,EAAE,kBAAkB,CAAC,CAAC;AACjG,CAAC,EAAE;AAEL;;;;;;;AAOA,SAAS,eAAe,CAAC,KAA8B;IACrD,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;AACjF,CAAC;AAED;;;;;;;;;AASA,SAAS,iBAAiB,CACxB,GAAQ,EACR,KAAY,EACZ,aAAiC;IAEjC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC;AAChF;;;;"}

package/js/x-modules/url/store/mutations/set-params.mutation.js CHANGED Viewed

@@ -1,5 +1,5 @@
+import { forEach } from '@empathyco/x-utils';
 import Vue from 'vue';
-import { forEach } from '../../../../utils/object.js';
 /**
  * Default implementation for the {@link UrlMutations.setParams} mutation.

package/js/x-modules/url/store/mutations/set-params.mutation.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"set-params.mutation.js","sources":["../../../../../../src/x-modules/url/store/mutations/set-params.mutation.ts"],"sourcesContent":["import ~~Vue~~ from '~~vue~~';\nimport { ~~forEach }~~ from '~~../../../../utils/object~~';\nimport { UrlXStoreModule } from '../types';\n\n/*\n Default implementation for the {@link UrlMutations.setParams} mutation.\n \n @param state - Current {@link https://vuex.vuejs.org/guide/state.html \| state} of the history\n * queries module.\n * @param params - The mutation payload with the extra params to set in the state.\n * @remarks The change is done using `Vue.set` because we are adding new fields to the state. So\n * this is necessary to make them reactive.\n * @public\n */\nexport const setParams: UrlXStoreModule['mutations']['setParams'] = (state, params) => {\n forEach(params, (key, value) => {\n Vue.set(state, key, value);\n });\n};\n"],"names":[],"mappings":";;;AAIA;;;;;;;;;;MAUa,SAAS,GAA8C,CAAC,KAAK,EAAE,MAAM;IAChF,OAAO,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,KAAK;QACzB,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;KAC5B,CAAC,CAAC;AACL;;;;"}
1	+ {"version":3,"file":"set-params.mutation.js","sources":["../../../../../../src/x-modules/url/store/mutations/set-params.mutation.ts"],"sourcesContent":["import { forEach } from '@empathyco/x-utils';\nimport Vue from 'vue';\nimport { UrlXStoreModule } from '../types';\n\n/*\n Default implementation for the {@link UrlMutations.setParams} mutation.\n \n @param state - Current {@link https://vuex.vuejs.org/guide/state.html \| state} of the history\n * queries module.\n * @param params - The mutation payload with the extra params to set in the state.\n * @remarks The change is done using `Vue.set` because we are adding new fields to the state. So\n * this is necessary to make them reactive.\n * @public\n */\nexport const setParams: UrlXStoreModule['mutations']['setParams'] = (state, params) => {\n forEach(params, (key, value) => {\n Vue.set(state, key, value);\n });\n};\n"],"names":[],"mappings":";;;AAIA;;;;;;;;;;MAUa,SAAS,GAA8C,CAAC,KAAK,EAAE,MAAM;IAChF,OAAO,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,KAAK;QACzB,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;KAC5B,CAAC,CAAC;AACL;;;;"}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@empathyco/x-components",
-  "version": "3.0.0-alpha.76",
+  "version": "3.0.0-alpha.79",
   "description": "Empathy X Components",
   "author": "Empathy Systems Corporation S.L.",
   "license": "Apache-2.0",
@@ -59,12 +59,12 @@
     "cypress:open:component": "cypress open-ct"
   },
   "dependencies": {
-    "@empathyco/x-adapter": "^7.0.0-alpha.17",
-    "@empathyco/x-deep-merge": "^1.3.0-alpha.5",
+    "@empathyco/x-adapter": "^7.0.0-alpha.19",
+    "@empathyco/x-deep-merge": "^1.3.0-alpha.7",
     "@empathyco/x-logger": "^1.2.0-alpha.3",
     "@empathyco/x-storage-service": "^2.0.0-alpha.2",
     "@empathyco/x-types": "^10.0.0-alpha.20",
-    "@empathyco/x-utils": "^0.1.0-alpha.4",
+    "@empathyco/x-utils": "^0.1.0-alpha.6",
     "@types/resize-observer-browser": "~0.1.5",
     "nanoid": "~3.1.31",
     "reflect-metadata": "~0.1.13",
@@ -78,23 +78,20 @@
     "vuex": "^3.0.0"
   },
   "devDependencies": {
-    "@cucumber/cucumber": "~7.0.0-rc.0",
-    "@cypress/browserify-preprocessor": "~3.0.1",
-    "@cypress/vue": "~2.2.3",
-    "@cypress/webpack-dev-server": "~1.4.0",
-    "@cypress/webpack-preprocessor": "~5.1.1",
+    "@cypress/vue": "~2.2.4",
+    "@cypress/webpack-dev-server": "~1.8.4",
     "@microsoft/api-documenter": "~7.15.3",
-    "@microsoft/api-extractor": "~7.19.4",
+    "@microsoft/api-extractor": "~7.20.0",
     "@rollup/plugin-commonjs": "~21.0.1",
     "@testing-library/jest-dom": "~5.11.1",
     "@types/autoprefixer": "~9.6.1",
     "@types/jest": "~27.0.3",
     "@types/node": "~16.4.12",
     "@types/testing-library__jest-dom": "~5.9.1",
-    "@vue/cli-plugin-e2e-cypress": "~4.5.16",
-    "@vue/cli-plugin-typescript": "~4.5.16",
-    "@vue/cli-plugin-vuex": "~4.5.16",
-    "@vue/cli-service": "~4.5.16",
+    "@vue/cli-plugin-e2e-cypress": "~5.0.4",
+    "@vue/cli-plugin-typescript": "~5.0.4",
+    "@vue/cli-plugin-vuex": "~5.0.4",
+    "@vue/cli-service": "~5.0.4",
     "@vue/test-utils": "~1.0.3",
     "@vue/vue2-jest": "~27.0.0-alpha.3",
     "autoprefixer": "~9.7.4",
@@ -104,6 +101,7 @@
     "glob": "~7.1.6",
     "jest": "~27.3.1",
     "jest-scss-transform": "~1.0.1",
+    "postcss": "~8.4.12",
     "postcss-dir-pseudo-class": "~5.0.0",
     "postcss-logical": "~4.0.2",
     "rimraf": "~3.0.2",
@@ -128,5 +126,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "8efe7a9f47c1aad2fdfe6fc796a46ad0e2dc987d"
+  "gitHead": "2c69dfbdef710f47d32db3ef9831559adeac971f"
 }

package/report/tsdoc-metadata.json CHANGED Viewed

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.19.4"
+      "packageVersion": "7.20.0"
     }
   ]
 }

package/report/x-adapter.api.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.19.4",
+    "toolVersion": "7.19.5",
     "schemaVersion": 1004,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {