@empathyco/x-components 7.3.1 → 7.4.1

package/js/x-modules/browse/store/actions/set-url-params.action.js

@@ -0,0 +1,20 @@
+/**
+ * Default implementation for the {@link BrowseActions.setUrlParams}.
+ *
+ * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions,
+ * provided by Vuex.
+ * @param urlParams - List of params from the url.
+ * @public
+ */
+const setUrlParams = ({ commit, state }, { browseValue, browseField, page, sort }) => {
+    const currentCategory = state.selectedCategory;
+    commit('setSelectedCategory', { browseValue, browseField });
+    commit('setPage', !currentCategory ||
+        (currentCategory.browseValue === browseValue && currentCategory.browseField === browseField)
+        ? page
+        : 1);
+    commit('setSort', sort);
+};
+
+export { setUrlParams };
+//# sourceMappingURL=set-url-params.action.js.map

package/js/x-modules/browse/store/actions/set-url-params.action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"set-url-params.action.js","sources":["../../../../../../src/x-modules/browse/store/actions/set-url-params.action.ts"],"sourcesContent":["import type { BrowseXStoreModule } from '../types'\n\n/**\n * Default implementation for the {@link BrowseActions.setUrlParams}.\n *\n * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions,\n * provided by Vuex.\n * @param urlParams - List of params from the url.\n * @public\n */\nexport const setUrlParams: BrowseXStoreModule['actions']['setUrlParams'] = (\n  { commit, state },\n  { browseValue, browseField, page, sort },\n) => {\n  const currentCategory = state.selectedCategory\n\n  commit('setSelectedCategory', { browseValue, browseField })\n  commit(\n    'setPage',\n    !currentCategory ||\n      (currentCategory.browseValue === browseValue && currentCategory.browseField === browseField)\n      ? page\n      : 1,\n  )\n  commit('setSort', sort)\n}\n"],"names":[],"mappings":"AAEA;;;;;;;AAOG;MACU,YAAY,GAAkD,CACzE,EAAE,MAAM,EAAE,KAAK,EAAE,EACjB,EAAE,WAAW,EAAE,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE,KACtC;AACF,IAAA,MAAM,eAAe,GAAG,KAAK,CAAC,gBAAgB;IAE9C,MAAM,CAAC,qBAAqB,EAAE,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC;AAC3D,IAAA,MAAM,CACJ,SAAS,EACT,CAAC,eAAe;SACb,eAAe,CAAC,WAAW,KAAK,WAAW,IAAI,eAAe,CAAC,WAAW,KAAK,WAAW;AAC3F,UAAE;UACA,CAAC,CACN;AACD,IAAA,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC;AACzB;;;;"}

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

@@ -0,0 +1,48 @@
+import '@empathyco/x-utils';
+import { createStoreEmitters } from '../../../store/utils/store-emitters.utils.js';
+import { isStringEmpty } from '../../../utils/string.js';
+import { browseXStoreModule } from './module.js';
+
+/**
+ * {@link StoreEmitters} For the browse module.
+ *
+ * @internal
+ */
+const browseEmitters = createStoreEmitters(browseXStoreModule, {
+    FacetsChanged: {
+        selector: state => state.facets,
+        filter(newValue, oldValue) {
+            return newValue.length !== 0 || oldValue.length !== 0;
+        },
+    },
+    PageChanged: state => state.page,
+    ResultsChanged: state => state.results,
+    BrowseRequestChanged: (_, getters) => getters.request,
+    BrowseRequestUpdated: (_, getters) => getters.request,
+    BrowseResponseChanged: {
+        selector: (state, getters) => {
+            return {
+                request: getters.request,
+                status: state.status,
+                banners: state.banners,
+                facets: state.facets,
+                promoteds: state.promoteds,
+                browseTagging: state.browseTagging,
+                displayBrowseTagging: state.displayBrowseTagging,
+                results: state.results,
+                totalResults: state.totalResults,
+            };
+        },
+        filter: (newValue, oldValue) => {
+            return (newValue.status !== oldValue.status && oldValue.status === 'loading' && !!newValue.request);
+        },
+    },
+    BrowseTaggingChanged: {
+        selector: state => state.browseTagging,
+        filter: ({ url }) => !isStringEmpty(url),
+    },
+    SortChanged: state => state.sort,
+});
+
+export { browseEmitters };
+//# sourceMappingURL=emitters.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"emitters.js","sources":["../../../../../src/x-modules/browse/store/emitters.ts"],"sourcesContent":["import { createStoreEmitters } from '../../../store'\nimport { isStringEmpty } from '../../../utils/string'\nimport { browseXStoreModule } from './module'\n\n/**\n * {@link StoreEmitters} For the browse module.\n *\n * @internal\n */\nexport const browseEmitters = createStoreEmitters(browseXStoreModule, {\n  FacetsChanged: {\n    selector: state => state.facets,\n    filter(newValue, oldValue): boolean {\n      return newValue.length !== 0 || oldValue.length !== 0\n    },\n  },\n  PageChanged: state => state.page,\n  ResultsChanged: state => state.results,\n  BrowseRequestChanged: (_, getters) => getters.request,\n  BrowseRequestUpdated: (_, getters) => getters.request,\n  BrowseResponseChanged: {\n    selector: (state, getters) => {\n      return {\n        request: getters.request!,\n        status: state.status,\n        banners: state.banners,\n        facets: state.facets,\n        promoteds: state.promoteds,\n        browseTagging: state.browseTagging,\n        displayBrowseTagging: state.displayBrowseTagging,\n        results: state.results,\n        totalResults: state.totalResults,\n      }\n    },\n    filter: (newValue, oldValue) => {\n      return (\n        newValue.status !== oldValue.status && oldValue.status === 'loading' && !!newValue.request\n      )\n    },\n  },\n  BrowseTaggingChanged: {\n    selector: state => state.browseTagging,\n    filter: ({ url }) => !isStringEmpty(url),\n  },\n  SortChanged: state => state.sort,\n})\n"],"names":[],"mappings":";;;;;AAIA;;;;AAIG;AACI,MAAM,cAAc,GAAG,mBAAmB,CAAC,kBAAkB,EAAE;AACpE,IAAA,aAAa,EAAE;AACb,QAAA,QAAQ,EAAE,KAAK,IAAI,KAAK,CAAC,MAAM;QAC/B,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAA;YACvB,OAAO,QAAQ,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;QACvD,CAAC;AACF,KAAA;AACD,IAAA,WAAW,EAAE,KAAK,IAAI,KAAK,CAAC,IAAI;AAChC,IAAA,cAAc,EAAE,KAAK,IAAI,KAAK,CAAC,OAAO;IACtC,oBAAoB,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO;IACrD,oBAAoB,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,OAAO;AACrD,IAAA,qBAAqB,EAAE;AACrB,QAAA,QAAQ,EAAE,CAAC,KAAK,EAAE,OAAO,KAAI;YAC3B,OAAO;gBACL,OAAO,EAAE,OAAO,CAAC,OAAQ;gBACzB,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,MAAM,EAAE,KAAK,CAAC,MAAM;gBACpB,SAAS,EAAE,KAAK,CAAC,SAAS;gBAC1B,aAAa,EAAE,KAAK,CAAC,aAAa;gBAClC,oBAAoB,EAAE,KAAK,CAAC,oBAAoB;gBAChD,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,YAAY,EAAE,KAAK,CAAC,YAAY;aACjC;QACH,CAAC;AACD,QAAA,MAAM,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAI;YAC7B,QACE,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO;QAE9F,CAAC;AACF,KAAA;AACD,IAAA,oBAAoB,EAAE;AACpB,QAAA,QAAQ,EAAE,KAAK,IAAI,KAAK,CAAC,aAAa;AACtC,QAAA,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC;AACzC,KAAA;AACD,IAAA,WAAW,EAAE,KAAK,IAAI,KAAK,CAAC,IAAI;AACjC,CAAA;;;;"}

package/js/x-modules/browse/store/getters/request.getter.js

@@ -0,0 +1,27 @@
+/**
+ * Default implementation for the {@link BrowseGetters.request} getter.
+ *
+ * @param state - Current {@link https://vuex.vuejs.org/guide/state.html | state} of the browse
+ * module.
+ * @param getters - Current {@link https://vuex.vuejs.org/guide/getters.html | getters} of the
+ * browse module.
+ * @returns The browse request to fetch data from the API.
+ * @public
+ */
+const request = ({ page, params, selectedFilters: filters, sort, selectedCategory, }) => {
+    const browseValue = selectedCategory?.browseValue?.trim();
+    const browseField = selectedCategory?.browseField?.trim();
+    return browseValue && browseField
+        ? {
+            browseField,
+            browseValue,
+            sort,
+            page,
+            filters,
+            extraParams: params,
+        }
+        : null;
+};
+
+export { request };
+//# sourceMappingURL=request.getter.js.map

package/js/x-modules/browse/store/getters/request.getter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.getter.js","sources":["../../../../../../src/x-modules/browse/store/getters/request.getter.ts"],"sourcesContent":["import type { BrowseXStoreModule } from '../types'\n\n/**\n * Default implementation for the {@link BrowseGetters.request} getter.\n *\n * @param state - Current {@link https://vuex.vuejs.org/guide/state.html | state} of the browse\n * module.\n * @param getters - Current {@link https://vuex.vuejs.org/guide/getters.html | getters} of the\n * browse module.\n * @returns The browse request to fetch data from the API.\n * @public\n */\nexport const request: BrowseXStoreModule['getters']['request'] = ({\n  page,\n  params,\n  selectedFilters: filters,\n  sort,\n  selectedCategory,\n}) => {\n  const browseValue = selectedCategory?.browseValue?.trim()\n  const browseField = selectedCategory?.browseField?.trim()\n\n  return browseValue && browseField\n    ? {\n        browseField,\n        browseValue,\n        sort,\n        page,\n        filters,\n        extraParams: params,\n      }\n    : null\n}\n"],"names":[],"mappings":"AAEA;;;;;;;;;AASG;AACI,MAAM,OAAO,GAA6C,CAAC,EAChE,IAAI,EACJ,MAAM,EACN,eAAe,EAAE,OAAO,EACxB,IAAI,EACJ,gBAAgB,GACjB,KAAI;IACH,MAAM,WAAW,GAAG,gBAAgB,EAAE,WAAW,EAAE,IAAI,EAAE;IACzD,MAAM,WAAW,GAAG,gBAAgB,EAAE,WAAW,EAAE,IAAI,EAAE;IAEzD,OAAO,WAAW,IAAI;AACpB,UAAE;YACE,WAAW;YACX,WAAW;YACX,IAAI;YACJ,IAAI;YACJ,OAAO;AACP,YAAA,WAAW,EAAE,MAAM;AACpB;UACD,IAAI;AACV;;;;"}

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

@@ -0,0 +1,163 @@
+import { isFacetFilter } from '@empathyco/x-types';
+import { DefaultResultsEnrichmentService } from '../../../services/results-enrichment.service.js';
+import { mergeConfig, setConfig } from '../../../store/utils/config-store.utils.js';
+import '@empathyco/x-utils';
+import { setStatus } from '../../../store/utils/status-store.utils.js';
+import { groupItemsBy } from '../../../utils/array.js';
+import { UNKNOWN_FACET_KEY } from '../../facets/store/constants.js';
+import { fetchAndSaveBrowseResponse, cancelFetchAndSaveBrowseResponse } from './actions/fetch-and-save-browse-response.action.js';
+import { fetchAndSaveResultsEnrichment } from './actions/fetch-and-save-results-enrichment.action.js';
+import { fetchBrowseResponse } from './actions/fetch-browse-response.action.js';
+import { increasePageAppendingResults } from './actions/increase-page-apending-results.action.js';
+import { resetRequestOnRefinement } from './actions/reset-request-on-refinement.action.js';
+import { saveBrowseResponse } from './actions/save-browse-response.action.js';
+import { saveOrigin } from './actions/save-origin.action.js';
+import { setUrlParams } from './actions/set-url-params.action.js';
+import { request } from './getters/request.getter.js';
+
+/**
+ * {@link XStoreModule} For the browse module.
+ *
+ * @internal
+ */
+const browseXStoreModule = {
+    state: () => ({
+        ...resettableBrowseState(),
+        selectedFilters: {},
+        params: {},
+        config: {
+            threshold: 24,
+            pageSize: 24,
+            pageMode: 'infinite_scroll',
+        },
+        status: 'initial',
+        isNoResults: false,
+        fromNoResultsWithFilters: false,
+    }),
+    getters: {
+        request,
+    },
+    mutations: {
+        appendResults(state, results) {
+            state.results = [...state.results, ...results];
+        },
+        resetState(state) {
+            Object.assign(state, resettableBrowseState());
+        },
+        resetStateForReload(state) {
+            const { selectedCategory, facets, sort, page, ...resettable } = resettableBrowseState();
+            Object.assign(state, resettable);
+        },
+        setResults(state, results) {
+            state.results = results;
+        },
+        setFacets(state, facets) {
+            state.facets = facets;
+        },
+        setSelectedFilters(state, selectedFilters) {
+            state.selectedFilters = groupItemsBy(selectedFilters, filter => isFacetFilter(filter) ? filter.facetId : UNKNOWN_FACET_KEY);
+        },
+        setBanners(state, banners) {
+            state.banners = banners;
+        },
+        setPromoteds(state, promoteds) {
+            state.promoteds = promoteds;
+        },
+        setTotalResults(state, totalResults) {
+            state.totalResults = totalResults;
+        },
+        setSort(state, sort) {
+            state.sort = sort;
+        },
+        setPage(state, page) {
+            state.page = page;
+        },
+        setSelectedCategory(state, selectedCategory) {
+            state.selectedCategory = selectedCategory;
+        },
+        setConfig,
+        mergeConfig,
+        setIsAppendResults(state, isAppendResults) {
+            state.isAppendResults = isAppendResults;
+        },
+        setIsNoResults(state, isNoResults) {
+            state.isNoResults = isNoResults;
+        },
+        setFromNoResultsWithFilters(state, fromNoResultsWithFilters) {
+            state.fromNoResultsWithFilters = fromNoResultsWithFilters;
+        },
+        setStatus,
+        setParams(state, params) {
+            state.params = params;
+        },
+        setOrigin(state, origin = null) {
+            state.origin = origin;
+        },
+        setBrowseTagging(state, browseTagging) {
+            state.browseTagging = browseTagging;
+        },
+        setDisplayBrowseTagging(state, displayBrowseTagging) {
+            state.displayBrowseTagging = displayBrowseTagging;
+        },
+        updateResult(state, result) {
+            const stateResult = state.results.find(stateResult => result.id === stateResult.id);
+            if (stateResult) {
+                Object.assign(stateResult, result);
+            }
+        },
+        updateResultsFromEnrichment(state, enrichmentResults) {
+            DefaultResultsEnrichmentService.instance.updateResults(state.results, enrichmentResults);
+        },
+        setStats(state, stats) {
+            state.stats = stats;
+        },
+    },
+    actions: {
+        cancelFetchAndSaveBrowseResponse,
+        fetchBrowseResponse,
+        fetchAndSaveBrowseResponse,
+        fetchAndSaveResultsEnrichment,
+        increasePageAppendingResults,
+        resetRequestOnRefinement,
+        saveBrowseResponse,
+        setUrlParams,
+        saveOrigin,
+    },
+};
+/**
+ * Function to return the "resettable" part of the state. This will be used in the `resetState`
+ * mutation to reset to the initial state.
+ *
+ * @returns The "resettable" part of the {@link BrowseState}.
+ *
+ * @internal
+ */
+function resettableBrowseState() {
+    return {
+        selectedCategory: {
+            browseValue: '',
+            browseField: '',
+        },
+        results: [],
+        facets: [],
+        banners: [],
+        promoteds: [],
+        totalResults: 0,
+        sort: '',
+        page: 1,
+        origin: null,
+        isAppendResults: false,
+        browseTagging: {
+            url: '',
+            params: {},
+        },
+        displayBrowseTagging: {
+            url: '',
+            params: {},
+        },
+        stats: {},
+    };
+}
+
+export { browseXStoreModule, resettableBrowseState };
+//# sourceMappingURL=module.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"module.js","sources":["../../../../../src/x-modules/browse/store/module.ts"],"sourcesContent":["import type { Stats } from '@empathyco/x-types'\nimport type { BrowseXStoreModule } from './types'\nimport { isFacetFilter } from '@empathyco/x-types'\nimport { DefaultResultsEnrichmentService } from '../../../services/results-enrichment.service'\nimport { setStatus } from '../../../store'\nimport { mergeConfig, setConfig } from '../../../store/utils/config-store.utils'\nimport { groupItemsBy } from '../../../utils/array'\nimport { UNKNOWN_FACET_KEY } from '../../facets/store/constants'\nimport {\n  cancelFetchAndSaveBrowseResponse,\n  fetchAndSaveBrowseResponse,\n  fetchBrowseResponse,\n  saveBrowseResponse,\n} from './actions'\nimport { fetchAndSaveResultsEnrichment } from './actions/fetch-and-save-results-enrichment.action'\nimport { increasePageAppendingResults } from './actions/increase-page-apending-results.action'\nimport { resetRequestOnRefinement } from './actions/reset-request-on-refinement.action'\nimport { saveOrigin } from './actions/save-origin.action'\nimport { setUrlParams } from './actions/set-url-params.action'\nimport { request } from './getters/request.getter'\n\n/**\n * {@link XStoreModule} For the browse module.\n *\n * @internal\n */\nexport const browseXStoreModule: BrowseXStoreModule = {\n  state: () => ({\n    ...resettableBrowseState(),\n    selectedFilters: {},\n    params: {},\n    config: {\n      threshold: 24,\n      pageSize: 24,\n      pageMode: 'infinite_scroll',\n    },\n    status: 'initial',\n    isNoResults: false,\n    fromNoResultsWithFilters: false,\n  }),\n  getters: {\n    request,\n  },\n  mutations: {\n    appendResults(state, results) {\n      state.results = [...state.results, ...results]\n    },\n    resetState(state) {\n      Object.assign(state, resettableBrowseState())\n    },\n    resetStateForReload(state) {\n      const { selectedCategory, facets, sort, page, ...resettable } = resettableBrowseState()\n      Object.assign(state, resettable)\n    },\n    setResults(state, results) {\n      state.results = results\n    },\n    setFacets(state, facets) {\n      state.facets = facets\n    },\n    setSelectedFilters(state, selectedFilters) {\n      state.selectedFilters = groupItemsBy(selectedFilters, filter =>\n        isFacetFilter(filter) ? filter.facetId : UNKNOWN_FACET_KEY,\n      )\n    },\n    setBanners(state, banners) {\n      state.banners = banners\n    },\n    setPromoteds(state, promoteds) {\n      state.promoteds = promoteds\n    },\n    setTotalResults(state, totalResults) {\n      state.totalResults = totalResults\n    },\n    setSort(state, sort) {\n      state.sort = sort\n    },\n    setPage(state, page) {\n      state.page = page\n    },\n    setSelectedCategory(state, selectedCategory) {\n      state.selectedCategory = selectedCategory\n    },\n    setConfig,\n    mergeConfig,\n    setIsAppendResults(state, isAppendResults) {\n      state.isAppendResults = isAppendResults\n    },\n    setIsNoResults(state, isNoResults) {\n      state.isNoResults = isNoResults\n    },\n    setFromNoResultsWithFilters(state, fromNoResultsWithFilters) {\n      state.fromNoResultsWithFilters = fromNoResultsWithFilters\n    },\n    setStatus,\n    setParams(state, params) {\n      state.params = params\n    },\n    setOrigin(state, origin = null) {\n      state.origin = origin\n    },\n    setBrowseTagging(state, browseTagging) {\n      state.browseTagging = browseTagging\n    },\n    setDisplayBrowseTagging(state, displayBrowseTagging) {\n      state.displayBrowseTagging = displayBrowseTagging\n    },\n    updateResult(state, result) {\n      const stateResult = state.results.find(stateResult => result.id === stateResult.id)\n      if (stateResult) {\n        Object.assign(stateResult, result)\n      }\n    },\n    updateResultsFromEnrichment(state, enrichmentResults) {\n      DefaultResultsEnrichmentService.instance.updateResults(state.results, enrichmentResults)\n    },\n    setStats(state, stats) {\n      state.stats = stats\n    },\n  },\n  actions: {\n    cancelFetchAndSaveBrowseResponse,\n    fetchBrowseResponse,\n    fetchAndSaveBrowseResponse,\n    fetchAndSaveResultsEnrichment,\n    increasePageAppendingResults,\n    resetRequestOnRefinement,\n    saveBrowseResponse,\n    setUrlParams,\n    saveOrigin,\n  },\n}\n\n/**\n * Function to return the \"resettable\" part of the state. This will be used in the `resetState`\n * mutation to reset to the initial state.\n *\n * @returns The \"resettable\" part of the {@link BrowseState}.\n *\n * @internal\n */\nexport function resettableBrowseState() {\n  return {\n    selectedCategory: {\n      browseValue: '',\n      browseField: '',\n    },\n    results: [],\n    facets: [],\n    banners: [],\n    promoteds: [],\n    totalResults: 0,\n    sort: '',\n    page: 1,\n    origin: null,\n    isAppendResults: false,\n    browseTagging: {\n      url: '',\n      params: {},\n    },\n    displayBrowseTagging: {\n      url: '',\n      params: {},\n    },\n    stats: {} as Stats,\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAqBA;;;;AAIG;AACI,MAAM,kBAAkB,GAAuB;AACpD,IAAA,KAAK,EAAE,OAAO;AACZ,QAAA,GAAG,qBAAqB,EAAE;AAC1B,QAAA,eAAe,EAAE,EAAE;AACnB,QAAA,MAAM,EAAE,EAAE;AACV,QAAA,MAAM,EAAE;AACN,YAAA,SAAS,EAAE,EAAE;AACb,YAAA,QAAQ,EAAE,EAAE;AACZ,YAAA,QAAQ,EAAE,iBAAiB;AAC5B,SAAA;AACD,QAAA,MAAM,EAAE,SAAS;AACjB,QAAA,WAAW,EAAE,KAAK;AAClB,QAAA,wBAAwB,EAAE,KAAK;KAChC,CAAC;AACF,IAAA,OAAO,EAAE;QACP,OAAO;AACR,KAAA;AACD,IAAA,SAAS,EAAE;QACT,aAAa,CAAC,KAAK,EAAE,OAAO,EAAA;AAC1B,YAAA,KAAK,CAAC,OAAO,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,EAAE,GAAG,OAAO,CAAC;QAChD,CAAC;AACD,QAAA,UAAU,CAAC,KAAK,EAAA;YACd,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,qBAAqB,EAAE,CAAC;QAC/C,CAAC;AACD,QAAA,mBAAmB,CAAC,KAAK,EAAA;AACvB,YAAA,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,UAAU,EAAE,GAAG,qBAAqB,EAAE;AACvF,YAAA,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,UAAU,CAAC;QAClC,CAAC;QACD,UAAU,CAAC,KAAK,EAAE,OAAO,EAAA;AACvB,YAAA,KAAK,CAAC,OAAO,GAAG,OAAO;QACzB,CAAC;QACD,SAAS,CAAC,KAAK,EAAE,MAAM,EAAA;AACrB,YAAA,KAAK,CAAC,MAAM,GAAG,MAAM;QACvB,CAAC;QACD,kBAAkB,CAAC,KAAK,EAAE,eAAe,EAAA;YACvC,KAAK,CAAC,eAAe,GAAG,YAAY,CAAC,eAAe,EAAE,MAAM,IAC1D,aAAa,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,OAAO,GAAG,iBAAiB,CAC3D;QACH,CAAC;QACD,UAAU,CAAC,KAAK,EAAE,OAAO,EAAA;AACvB,YAAA,KAAK,CAAC,OAAO,GAAG,OAAO;QACzB,CAAC;QACD,YAAY,CAAC,KAAK,EAAE,SAAS,EAAA;AAC3B,YAAA,KAAK,CAAC,SAAS,GAAG,SAAS;QAC7B,CAAC;QACD,eAAe,CAAC,KAAK,EAAE,YAAY,EAAA;AACjC,YAAA,KAAK,CAAC,YAAY,GAAG,YAAY;QACnC,CAAC;QACD,OAAO,CAAC,KAAK,EAAE,IAAI,EAAA;AACjB,YAAA,KAAK,CAAC,IAAI,GAAG,IAAI;QACnB,CAAC;QACD,OAAO,CAAC,KAAK,EAAE,IAAI,EAAA;AACjB,YAAA,KAAK,CAAC,IAAI,GAAG,IAAI;QACnB,CAAC;QACD,mBAAmB,CAAC,KAAK,EAAE,gBAAgB,EAAA;AACzC,YAAA,KAAK,CAAC,gBAAgB,GAAG,gBAAgB;QAC3C,CAAC;QACD,SAAS;QACT,WAAW;QACX,kBAAkB,CAAC,KAAK,EAAE,eAAe,EAAA;AACvC,YAAA,KAAK,CAAC,eAAe,GAAG,eAAe;QACzC,CAAC;QACD,cAAc,CAAC,KAAK,EAAE,WAAW,EAAA;AAC/B,YAAA,KAAK,CAAC,WAAW,GAAG,WAAW;QACjC,CAAC;QACD,2BAA2B,CAAC,KAAK,EAAE,wBAAwB,EAAA;AACzD,YAAA,KAAK,CAAC,wBAAwB,GAAG,wBAAwB;QAC3D,CAAC;QACD,SAAS;QACT,SAAS,CAAC,KAAK,EAAE,MAAM,EAAA;AACrB,YAAA,KAAK,CAAC,MAAM,GAAG,MAAM;QACvB,CAAC;AACD,QAAA,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAAA;AAC5B,YAAA,KAAK,CAAC,MAAM,GAAG,MAAM;QACvB,CAAC;QACD,gBAAgB,CAAC,KAAK,EAAE,aAAa,EAAA;AACnC,YAAA,KAAK,CAAC,aAAa,GAAG,aAAa;QACrC,CAAC;QACD,uBAAuB,CAAC,KAAK,EAAE,oBAAoB,EAAA;AACjD,YAAA,KAAK,CAAC,oBAAoB,GAAG,oBAAoB;QACnD,CAAC;QACD,YAAY,CAAC,KAAK,EAAE,MAAM,EAAA;YACxB,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,IAAI,MAAM,CAAC,EAAE,KAAK,WAAW,CAAC,EAAE,CAAC;YACnF,IAAI,WAAW,EAAE;AACf,gBAAA,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC;YACpC;QACF,CAAC;QACD,2BAA2B,CAAC,KAAK,EAAE,iBAAiB,EAAA;YAClD,+BAA+B,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,EAAE,iBAAiB,CAAC;QAC1F,CAAC;QACD,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAA;AACnB,YAAA,KAAK,CAAC,KAAK,GAAG,KAAK;QACrB,CAAC;AACF,KAAA;AACD,IAAA,OAAO,EAAE;QACP,gCAAgC;QAChC,mBAAmB;QACnB,0BAA0B;QAC1B,6BAA6B;QAC7B,4BAA4B;QAC5B,wBAAwB;QACxB,kBAAkB;QAClB,YAAY;QACZ,UAAU;AACX,KAAA;;AAGH;;;;;;;AAOG;SACa,qBAAqB,GAAA;IACnC,OAAO;AACL,QAAA,gBAAgB,EAAE;AAChB,YAAA,WAAW,EAAE,EAAE;AACf,YAAA,WAAW,EAAE,EAAE;AAChB,SAAA;AACD,QAAA,OAAO,EAAE,EAAE;AACX,QAAA,MAAM,EAAE,EAAE;AACV,QAAA,OAAO,EAAE,EAAE;AACX,QAAA,SAAS,EAAE,EAAE;AACb,QAAA,YAAY,EAAE,CAAC;AACf,QAAA,IAAI,EAAE,EAAE;AACR,QAAA,IAAI,EAAE,CAAC;AACP,QAAA,MAAM,EAAE,IAAI;AACZ,QAAA,eAAe,EAAE,KAAK;AACtB,QAAA,aAAa,EAAE;AACb,YAAA,GAAG,EAAE,EAAE;AACP,YAAA,MAAM,EAAE,EAAE;AACX,SAAA;AACD,QAAA,oBAAoB,EAAE;AACpB,YAAA,GAAG,EAAE,EAAE;AACP,YAAA,MAAM,EAAE,EAAE;AACX,SAAA;AACD,QAAA,KAAK,EAAE,EAAW;KACnB;AACH;;;;"}

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

@@ -0,0 +1,213 @@
+import { namespacedWireCommit, namespacedWireDispatchWithoutPayload, namespacedWireCommitWithoutPayload, namespacedWireDispatch } from '../../wiring/namespaced-wires.factory.js';
+import { filterTruthyPayload } from '../../wiring/wires.operators.js';
+import { createWiring } from '../../wiring/wiring.utils.js';
+
+/**
+ * `browse` {@link XModuleName | XModule name}.
+ *
+ * @internal
+ */
+const moduleName = 'browse';
+/**
+ * WireCommit for {@link BrowseXModule}.
+ *
+ * @internal
+ */
+const wireCommit = namespacedWireCommit(moduleName);
+/**
+ * WireCommit without Payload for {@link BrowseXModule}.
+ *
+ * @internal
+ */
+const wireCommitWithoutPayload = namespacedWireCommitWithoutPayload(moduleName);
+/**
+ * WireDispatch for {@link BrowseXModule}.
+ *
+ * @internal
+ */
+const wireDispatch = namespacedWireDispatch(moduleName);
+/**
+ * WireDispatchWithoutPayload for {@link BrowseXModule}.
+ *
+ * @internal
+ */
+const wireDispatchWithoutPayload = namespacedWireDispatchWithoutPayload(moduleName);
+/**
+ * Cancels the {@link BrowseActions.fetchAndSaveBrowseResponse} request promise.
+ *
+ * @public
+ */
+const cancelFetchAndSaveBrowseResponseWire = wireDispatchWithoutPayload('cancelFetchAndSaveBrowseResponse');
+/**
+ * Sets the browse state `origin`.
+ *
+ * @public
+ */
+const saveBrowseOriginWire = wireDispatch('saveOrigin', ({ metadata }) => metadata);
+/**
+ * Requests and stores the browse response.
+ *
+ * @public
+ */
+const fetchAndSaveBrowseResponseWire = wireDispatch('fetchAndSaveBrowseResponse');
+/**
+ * Requests and stores the enrichment results for the results.
+ *
+ * @public
+ */
+const fetchAndSaveBrowseResultsEnrichmentWire = wireDispatch('fetchAndSaveResultsEnrichment');
+/**
+ * Sets the browse state `selectedCategory`.
+ *
+ * @public
+ */
+const setBrowseCategory = wireCommit('setSelectedCategory');
+/**
+ * Clears the browse state `selectedCategory`.
+ *
+ * @public
+ */
+const clearBrowseQuery = wireCommit('setSelectedCategory', {
+    browseField: '',
+    browseValue: '',
+});
+/**
+ * Sets the browse state `selectedFilters`.
+ *
+ * @public
+ */
+const setBrowseSelectedFilters = wireCommit('setSelectedFilters');
+/**
+ * Sets the browse state `sort`.
+ *
+ * @public
+ */
+const setBrowseSort = wireCommit('setSort');
+/**
+ * Sets the browse state `query`.
+ *
+ * @public
+ */
+const setBrowseUrlParamsWire = wireDispatch('setUrlParams');
+/**
+ * Sets the browse state `page`.
+ *
+ * @public
+ */
+const setBrowsePage = wireCommit('setPage');
+/**
+ * Sets the browse state `params`.
+ *
+ * @public
+ */
+const setBrowseExtraParams = wireCommit('setParams');
+/**
+ * Resets the browse state to reload the current browse.
+ *
+ * @public
+ */
+const resetBrowseStateForReloadWire = wireCommitWithoutPayload('resetStateForReload');
+/**
+ * Resets the browse state `isNoResults`.
+ *
+ * @public
+ */
+const resetIsNoBrowseResults = wireCommit('setIsNoResults', false);
+/**
+ * Resets the browse state `fromNoResultsWithFilters`.
+ *
+ * @public
+ */
+const resetFromNoBrowseResultsWithFilters = wireCommit('setFromNoResultsWithFilters', false);
+/**
+ * Increases the current browse state `page` by one.
+ *
+ * @public
+ */
+const increaseBrowsePageAppendingResultsWire = wireDispatchWithoutPayload('increasePageAppendingResults');
+/**
+ * Resets the browse state `isAppendingResults`.
+ *
+ * @public
+ */
+const resetBrowseAppending = wireCommit('setIsAppendResults', false);
+/**
+ * Resets the {@link BrowseGetters.request} parameters when refining request and before the actual
+ * request is launched.
+ *
+ * @public
+ */
+const resetBrowseRequestOnRefinementWire = wireDispatch('resetRequestOnRefinement', ({ eventPayload: newRequest, metadata: { oldValue } }) => ({
+    newRequest,
+    oldRequest: oldValue,
+}));
+/**
+ * Resets the browse state when the request is changed to null. See the
+ * {@link BrowseXStoreModule} for details.
+ *
+ * @public
+ */
+const resetBrowseStateIfNoRequestWire = filterTruthyPayload(wireCommitWithoutPayload('resetState'));
+/**
+ * Browse wiring.
+ *
+ * @internal
+ */
+const browseWiring = createWiring({
+    ParamsLoadedFromUrl: {
+        setBrowseUrlParamsWire,
+        saveBrowseOriginWire,
+    },
+    UserClickedABrowseSort: {
+        setBrowseSort,
+    },
+    UserReachedResultsListEnd: {
+        increaseBrowsePageAppendingResultsWire,
+    },
+    BrowseRequestUpdated: {
+        resetBrowseStateIfNoRequestWire,
+        fetchAndSaveBrowseResponseWire,
+    },
+    BrowseRequestChanged: {
+        resetBrowseRequestOnRefinementWire,
+    },
+    SelectedFiltersForRequestChanged: {
+        setBrowseSelectedFilters,
+    },
+    ResultsChanged: {
+        resetBrowseAppending,
+        fetchAndSaveBrowseResultsEnrichmentWire,
+    },
+    ReloadBrowseRequested: {
+        resetBrowseStateForReloadWire,
+    },
+    SelectedSortProvided: {
+        setBrowseSort,
+    },
+    ExtraParamsChanged: {
+        setBrowseExtraParams,
+    },
+    UserClickedCloseX: {
+        clearBrowseQuery,
+        resetBrowseStateForReloadWire,
+        cancelFetchAndSaveBrowseResponseWire,
+    },
+    UserClickedOpenX: {
+        clearBrowseQuery,
+        resetBrowseStateForReloadWire,
+        cancelFetchAndSaveBrowseResponseWire,
+    },
+    UserClickedOutOfMainModal: {
+        clearBrowseQuery,
+    },
+    UserSelectedAPage: {
+        setBrowsePage,
+        resetBrowseAppending,
+    },
+    UserBrowsedToCategory: {
+        setBrowseCategory,
+    },
+});
+
+export { browseWiring, cancelFetchAndSaveBrowseResponseWire, clearBrowseQuery, fetchAndSaveBrowseResponseWire, fetchAndSaveBrowseResultsEnrichmentWire, increaseBrowsePageAppendingResultsWire, resetBrowseAppending, resetBrowseRequestOnRefinementWire, resetBrowseStateForReloadWire, resetBrowseStateIfNoRequestWire, resetFromNoBrowseResultsWithFilters, resetIsNoBrowseResults, saveBrowseOriginWire, setBrowseCategory, setBrowseExtraParams, setBrowsePage, setBrowseSelectedFilters, setBrowseSort, setBrowseUrlParamsWire };
+//# sourceMappingURL=wiring.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"wiring.js","sources":["../../../../src/x-modules/browse/wiring.ts"],"sourcesContent":["import type { WirePayload } from '../../wiring'\nimport type { InternalBrowseRequest } from './types'\nimport {\n  createWiring,\n  filterTruthyPayload,\n  namespacedWireCommit,\n  namespacedWireCommitWithoutPayload,\n  namespacedWireDispatch,\n  namespacedWireDispatchWithoutPayload,\n} from '../../wiring'\n\n/**\n * `browse` {@link XModuleName | XModule name}.\n *\n * @internal\n */\nconst moduleName = 'browse'\n\n/**\n * WireCommit for {@link BrowseXModule}.\n *\n * @internal\n */\nconst wireCommit = namespacedWireCommit(moduleName)\n\n/**\n * WireCommit without Payload for {@link BrowseXModule}.\n *\n * @internal\n */\nconst wireCommitWithoutPayload = namespacedWireCommitWithoutPayload(moduleName)\n\n/**\n * WireDispatch for {@link BrowseXModule}.\n *\n * @internal\n */\nconst wireDispatch = namespacedWireDispatch(moduleName)\n\n/**\n * WireDispatchWithoutPayload for {@link BrowseXModule}.\n *\n * @internal\n */\nconst wireDispatchWithoutPayload = namespacedWireDispatchWithoutPayload(moduleName)\n\n/**\n * Cancels the {@link BrowseActions.fetchAndSaveBrowseResponse} request promise.\n *\n * @public\n */\nexport const cancelFetchAndSaveBrowseResponseWire = wireDispatchWithoutPayload(\n  'cancelFetchAndSaveBrowseResponse',\n)\n\n/**\n * Sets the browse state `origin`.\n *\n * @public\n */\nexport const saveBrowseOriginWire = wireDispatch('saveOrigin', ({ metadata }) => metadata)\n\n/**\n * Requests and stores the browse response.\n *\n * @public\n */\nexport const fetchAndSaveBrowseResponseWire = wireDispatch('fetchAndSaveBrowseResponse')\n\n/**\n * Requests and stores the enrichment results for the results.\n *\n * @public\n */\nexport const fetchAndSaveBrowseResultsEnrichmentWire = wireDispatch('fetchAndSaveResultsEnrichment')\n\n/**\n * Sets the browse state `selectedCategory`.\n *\n * @public\n */\nexport const setBrowseCategory = wireCommit('setSelectedCategory')\n\n/**\n * Clears the browse state `selectedCategory`.\n *\n * @public\n */\nexport const clearBrowseQuery = wireCommit('setSelectedCategory', {\n  browseField: '',\n  browseValue: '',\n})\n\n/**\n * Sets the browse state `selectedFilters`.\n *\n * @public\n */\nexport const setBrowseSelectedFilters = wireCommit('setSelectedFilters')\n\n/**\n * Sets the browse state `sort`.\n *\n * @public\n */\nexport const setBrowseSort = wireCommit('setSort')\n\n/**\n * Sets the browse state `query`.\n *\n * @public\n */\nexport const setBrowseUrlParamsWire = wireDispatch('setUrlParams')\n\n/**\n * Sets the browse state `page`.\n *\n * @public\n */\nexport const setBrowsePage = wireCommit('setPage')\n\n/**\n * Sets the browse state `params`.\n *\n * @public\n */\nexport const setBrowseExtraParams = wireCommit('setParams')\n\n/**\n * Resets the browse state to reload the current browse.\n *\n * @public\n */\nexport const resetBrowseStateForReloadWire = wireCommitWithoutPayload('resetStateForReload')\n\n/**\n * Resets the browse state `isNoResults`.\n *\n * @public\n */\nexport const resetIsNoBrowseResults = wireCommit('setIsNoResults', false)\n\n/**\n * Resets the browse state `fromNoResultsWithFilters`.\n *\n * @public\n */\nexport const resetFromNoBrowseResultsWithFilters = wireCommit('setFromNoResultsWithFilters', false)\n\n/**\n * Increases the current browse state `page` by one.\n *\n * @public\n */\nexport const increaseBrowsePageAppendingResultsWire = wireDispatchWithoutPayload(\n  'increasePageAppendingResults',\n)\n\n/**\n * Resets the browse state `isAppendingResults`.\n *\n * @public\n */\nexport const resetBrowseAppending = wireCommit('setIsAppendResults', false)\n\n/**\n * Resets the {@link BrowseGetters.request} parameters when refining request and before the actual\n * request is launched.\n *\n * @public\n */\nexport const resetBrowseRequestOnRefinementWire = wireDispatch(\n  'resetRequestOnRefinement',\n  ({ eventPayload: newRequest, metadata: { oldValue } }: WirePayload<InternalBrowseRequest>) => ({\n    newRequest,\n    oldRequest: oldValue as InternalBrowseRequest,\n  }),\n)\n\n/**\n * Resets the browse state when the request is changed to null. See the\n * {@link BrowseXStoreModule} for details.\n *\n * @public\n */\nexport const resetBrowseStateIfNoRequestWire = filterTruthyPayload<InternalBrowseRequest | null>(\n  wireCommitWithoutPayload('resetState'),\n)\n\n/**\n * Browse wiring.\n *\n * @internal\n */\nexport const browseWiring = createWiring({\n  ParamsLoadedFromUrl: {\n    setBrowseUrlParamsWire,\n    saveBrowseOriginWire,\n  },\n  UserClickedABrowseSort: {\n    setBrowseSort,\n  },\n  UserReachedResultsListEnd: {\n    increaseBrowsePageAppendingResultsWire,\n  },\n  BrowseRequestUpdated: {\n    resetBrowseStateIfNoRequestWire,\n    fetchAndSaveBrowseResponseWire,\n  },\n  BrowseRequestChanged: {\n    resetBrowseRequestOnRefinementWire,\n  },\n  SelectedFiltersForRequestChanged: {\n    setBrowseSelectedFilters,\n  },\n  ResultsChanged: {\n    resetBrowseAppending,\n    fetchAndSaveBrowseResultsEnrichmentWire,\n  },\n  ReloadBrowseRequested: {\n    resetBrowseStateForReloadWire,\n  },\n  SelectedSortProvided: {\n    setBrowseSort,\n  },\n  ExtraParamsChanged: {\n    setBrowseExtraParams,\n  },\n  UserClickedCloseX: {\n    clearBrowseQuery,\n    resetBrowseStateForReloadWire,\n    cancelFetchAndSaveBrowseResponseWire,\n  },\n  UserClickedOpenX: {\n    clearBrowseQuery,\n    resetBrowseStateForReloadWire,\n    cancelFetchAndSaveBrowseResponseWire,\n  },\n  UserClickedOutOfMainModal: {\n    clearBrowseQuery,\n  },\n  UserSelectedAPage: {\n    setBrowsePage,\n    resetBrowseAppending,\n  },\n  UserBrowsedToCategory: {\n    setBrowseCategory,\n  },\n})\n"],"names":[],"mappings":";;;;AAWA;;;;AAIG;AACH,MAAM,UAAU,GAAG,QAAQ;AAE3B;;;;AAIG;AACH,MAAM,UAAU,GAAG,oBAAoB,CAAC,UAAU,CAAC;AAEnD;;;;AAIG;AACH,MAAM,wBAAwB,GAAG,kCAAkC,CAAC,UAAU,CAAC;AAE/E;;;;AAIG;AACH,MAAM,YAAY,GAAG,sBAAsB,CAAC,UAAU,CAAC;AAEvD;;;;AAIG;AACH,MAAM,0BAA0B,GAAG,oCAAoC,CAAC,UAAU,CAAC;AAEnF;;;;AAIG;MACU,oCAAoC,GAAG,0BAA0B,CAC5E,kCAAkC;AAGpC;;;;AAIG;AACI,MAAM,oBAAoB,GAAG,YAAY,CAAC,YAAY,EAAE,CAAC,EAAE,QAAQ,EAAE,KAAK,QAAQ;AAEzF;;;;AAIG;MACU,8BAA8B,GAAG,YAAY,CAAC,4BAA4B;AAEvF;;;;AAIG;MACU,uCAAuC,GAAG,YAAY,CAAC,+BAA+B;AAEnG;;;;AAIG;MACU,iBAAiB,GAAG,UAAU,CAAC,qBAAqB;AAEjE;;;;AAIG;AACI,MAAM,gBAAgB,GAAG,UAAU,CAAC,qBAAqB,EAAE;AAChE,IAAA,WAAW,EAAE,EAAE;AACf,IAAA,WAAW,EAAE,EAAE;AAChB,CAAA;AAED;;;;AAIG;MACU,wBAAwB,GAAG,UAAU,CAAC,oBAAoB;AAEvE;;;;AAIG;MACU,aAAa,GAAG,UAAU,CAAC,SAAS;AAEjD;;;;AAIG;MACU,sBAAsB,GAAG,YAAY,CAAC,cAAc;AAEjE;;;;AAIG;MACU,aAAa,GAAG,UAAU,CAAC,SAAS;AAEjD;;;;AAIG;MACU,oBAAoB,GAAG,UAAU,CAAC,WAAW;AAE1D;;;;AAIG;MACU,6BAA6B,GAAG,wBAAwB,CAAC,qBAAqB;AAE3F;;;;AAIG;AACI,MAAM,sBAAsB,GAAG,UAAU,CAAC,gBAAgB,EAAE,KAAK;AAExE;;;;AAIG;AACI,MAAM,mCAAmC,GAAG,UAAU,CAAC,6BAA6B,EAAE,KAAK;AAElG;;;;AAIG;MACU,sCAAsC,GAAG,0BAA0B,CAC9E,8BAA8B;AAGhC;;;;AAIG;AACI,MAAM,oBAAoB,GAAG,UAAU,CAAC,oBAAoB,EAAE,KAAK;AAE1E;;;;;AAKG;MACU,kCAAkC,GAAG,YAAY,CAC5D,0BAA0B,EAC1B,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,EAAsC,MAAM;IAC7F,UAAU;AACV,IAAA,UAAU,EAAE,QAAiC;AAC9C,CAAA,CAAC;AAGJ;;;;;AAKG;AACI,MAAM,+BAA+B,GAAG,mBAAmB,CAChE,wBAAwB,CAAC,YAAY,CAAC;AAGxC;;;;AAIG;AACI,MAAM,YAAY,GAAG,YAAY,CAAC;AACvC,IAAA,mBAAmB,EAAE;QACnB,sBAAsB;QACtB,oBAAoB;AACrB,KAAA;AACD,IAAA,sBAAsB,EAAE;QACtB,aAAa;AACd,KAAA;AACD,IAAA,yBAAyB,EAAE;QACzB,sCAAsC;AACvC,KAAA;AACD,IAAA,oBAAoB,EAAE;QACpB,+BAA+B;QAC/B,8BAA8B;AAC/B,KAAA;AACD,IAAA,oBAAoB,EAAE;QACpB,kCAAkC;AACnC,KAAA;AACD,IAAA,gCAAgC,EAAE;QAChC,wBAAwB;AACzB,KAAA;AACD,IAAA,cAAc,EAAE;QACd,oBAAoB;QACpB,uCAAuC;AACxC,KAAA;AACD,IAAA,qBAAqB,EAAE;QACrB,6BAA6B;AAC9B,KAAA;AACD,IAAA,oBAAoB,EAAE;QACpB,aAAa;AACd,KAAA;AACD,IAAA,kBAAkB,EAAE;QAClB,oBAAoB;AACrB,KAAA;AACD,IAAA,iBAAiB,EAAE;QACjB,gBAAgB;QAChB,6BAA6B;QAC7B,oCAAoC;AACrC,KAAA;AACD,IAAA,gBAAgB,EAAE;QAChB,gBAAgB;QAChB,6BAA6B;QAC7B,oCAAoC;AACrC,KAAA;AACD,IAAA,yBAAyB,EAAE;QACzB,gBAAgB;AACjB,KAAA;AACD,IAAA,iBAAiB,EAAE;QACjB,aAAa;QACb,oBAAoB;AACrB,KAAA;AACD,IAAA,qBAAqB,EAAE;QACrB,iBAAiB;AAClB,KAAA;AACF,CAAA;;;;"}

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

@@ -0,0 +1,21 @@
+import { XPlugin } from '../../plugins/x-plugin.js';
+import { browseEmitters } from './store/emitters.js';
+import { browseXStoreModule } from './store/module.js';
+import { browseWiring } from './wiring.js';
+
+/**
+ * Search {@link XModule} implementation. This module is auto-registered as soon as you
+ * import any component from the `browse` entry point.
+ *
+ * @public
+ */
+const browseXModule = {
+    name: 'browse',
+    storeModule: browseXStoreModule,
+    storeEmitters: browseEmitters,
+    wiring: browseWiring,
+};
+XPlugin.registerXModule(browseXModule);
+
+export { browseXModule };
+//# sourceMappingURL=x-module.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"x-module.js","sources":["../../../../src/x-modules/browse/x-module.ts"],"sourcesContent":["// XModule\nimport type { XModule } from '../x-modules.types'\nimport type { BrowseXStoreModule } from './store/types'\nimport { XPlugin } from '../../plugins/x-plugin'\nimport { browseEmitters } from './store/emitters'\nimport { browseXStoreModule } from './store/module'\nimport { browseWiring } from './wiring'\n\n/**\n * Search {@link XModule} alias.\n *\n * @public\n */\nexport type BrowseXModule = XModule<BrowseXStoreModule>\n\n/**\n * Search {@link XModule} implementation. This module is auto-registered as soon as you\n * import any component from the `browse` entry point.\n *\n * @public\n */\nexport const browseXModule: BrowseXModule = {\n  name: 'browse',\n  storeModule: browseXStoreModule,\n  storeEmitters: browseEmitters,\n  wiring: browseWiring,\n}\n\nXPlugin.registerXModule(browseXModule)\n"],"names":[],"mappings":";;;;;AAeA;;;;;AAKG;AACI,MAAM,aAAa,GAAkB;AAC1C,IAAA,IAAI,EAAE,QAAQ;AACd,IAAA,WAAW,EAAE,kBAAkB;AAC/B,IAAA,aAAa,EAAE,cAAc;AAC7B,IAAA,MAAM,EAAE,YAAY;;AAGtB,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC;;;;"}

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 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 allows you 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 at the URL!_\n\n```vue\n<template>\n  <UrlHandler />\n</template>\n\n<script setup>\nimport { UrlHandler } from '@empathyco/x-components/url-handler'\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 at the URL!_\n\n```vue\n<template>\n  <UrlHandler query=\"q\" page=\"p\" filter=\"f\" sort=\"s\" />\n</template>\n\n<script setup>\nimport { UrlHandler } from '@empathyco/x-components/url-handler'\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 the 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,WAAA,CAA8E,uBAAA,EAAA;AAAA,IAAhE,MAAA,EAAO,QAAA;AAAA,IAAU,UAAA,EAAU,IAAA,CAAA,UAAA;AAAA,IAAa,UAAA,EAAU,IAAA,CAAA;AAAA,GAAA,EAAA,IAAA,EAAA,CAAA,EAAA,CAAA,YAAA,EAAA,YAAA,CAAA,CAAA;;;;;;"}
+{"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 && !urlParams.browseField && !urlParams.browseValue) {\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      } else if (all.browseField && all.browseValue) {\n        $x.emit(\n          'UserBrowsedToCategory',\n          { browseValue: all.browseValue, browseField: all.browseField },\n          metadata,\n        )\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 allows you 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 at the URL!_\n\n```vue\n<template>\n  <UrlHandler />\n</template>\n\n<script setup>\nimport { UrlHandler } from '@empathyco/x-components/url-handler'\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 at the URL!_\n\n```vue\n<template>\n  <UrlHandler query=\"q\" page=\"p\" filter=\"f\" sort=\"s\" />\n</template>\n\n<script setup>\nimport { UrlHandler } from '@empathyco/x-components/url-handler'\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 the 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,WAAA,CAA8E,uBAAA,EAAA;AAAA,IAAhE,MAAA,EAAO,QAAA;AAAA,IAAU,UAAA,EAAU,IAAA,CAAA,UAAA;AAAA,IAAa,UAAA,EAAU,IAAA,CAAA;AAAA,GAAA,EAAA,IAAA,EAAA,CAAA,EAAA,CAAA,YAAA,EAAA,YAAA,CAAA,CAAA;;;;;;"}