@getlupa/vue 0.6.3 → 0.7.0

package/dist/lupaSearch.js

@@ -1635,6 +1635,14 @@ const track$1 = (queryKey, event, environment, customBaseUrl) => __awaiter(void
   }
   return res.json();
 });
+const loadRedirectionRules = (queryKey, environment, customBaseUrl) => __awaiter(void 0, void 0, void 0, function* () {
+  const res = yield fetch(`${getApiUrl$1(environment, customBaseUrl)}redirections/${queryKey}`, Object.assign(Object.assign({}, defaultConfig$1), { method: "GET" }));
+  if (res.status < 400) {
+    return res.json();
+  }
+  const errors = yield res.json();
+  return { success: false, errors };
+});
 const LupaSearchSdk = {
   query: (queryKey, publicQuery, options = null) => {
     if (options === null || options === void 0 ? void 0 : options.customUrl) {
@@ -1656,6 +1664,9 @@ const LupaSearchSdk = {
   },
   queryByIds: (queryKey, ids, options = null) => {
     return queryByIds(queryKey, ids, (options === null || options === void 0 ? void 0 : options.environment) || "production", options === null || options === void 0 ? void 0 : options.customBaseUrl);
+  },
+  loadRedirectionRules: (queryKey, options = null) => {
+    return loadRedirectionRules(queryKey, (options === null || options === void 0 ? void 0 : options.environment) || "production", options === null || options === void 0 ? void 0 : options.customBaseUrl);
   }
 };
 const getNormalizedString = (str) => {
@@ -1734,6 +1745,13 @@ const escapeHtml = (value) => {
   });
   return output;
 };
+const inputMatches = (input, possibleValues) => {
+  if (!input) {
+    return false;
+  }
+  const normalizedInput = getNormalizedString(input);
+  return possibleValues.some((v) => getNormalizedString(v).startsWith(normalizedInput));
+};
 const initAnalyticsTracking = (analyticsOptions) => {
   try {
     if (analyticsOptions == null ? void 0 : analyticsOptions.enabled) {
@@ -2684,12 +2702,86 @@ const toggleHierarchyParam = (params = [], param = "", removeAllLevels = false)
   }
   return getMostSpecificHierarchyTerms([param, ...params]);
 };
+const CACHE_KEY = "lupasearch-client-redirections";
+const useRedirectionStore = defineStore("redirections", () => {
+  const redirections = vue.ref({ rules: [] });
+  const redirectionOptions = vue.ref({ enabled: false, queryKey: "" });
+  const saveToLocalStorage = () => {
+    try {
+      localStorage.setItem(
+        CACHE_KEY,
+        JSON.stringify({ redirections: redirections.value, savedAt: Date.now() })
+      );
+    } catch (e) {
+    }
+  };
+  const tryLoadFromLocalStorage = (config) => {
+    var _a;
+    if (!config.cacheSeconds)
+      return false;
+    try {
+      const data = JSON.parse((_a = localStorage.getItem(CACHE_KEY)) != null ? _a : "");
+      if ((data == null ? void 0 : data.redirections) && Date.now() - data.savedAt < 1e3 * config.cacheSeconds) {
+        redirections.value = data.redirections;
+        return true;
+      }
+    } catch (e) {
+    }
+    return false;
+  };
+  const initiate = (config, options) => __async(exports, null, function* () {
+    var _a, _b, _c, _d;
+    if ((_a = redirectionOptions.value) == null ? void 0 : _a.enabled) {
+      return;
+    }
+    redirectionOptions.value = config;
+    if (!(config == null ? void 0 : config.enabled)) {
+      return;
+    }
+    const loaded = tryLoadFromLocalStorage(config);
+    if (loaded || ((_c = (_b = redirections.value) == null ? void 0 : _b.rules) == null ? void 0 : _c.length) > 0) {
+      return;
+    }
+    try {
+      const result = yield LupaSearchSdk.loadRedirectionRules(config.queryKey, options);
+      if (!((_d = result == null ? void 0 : result.rules) == null ? void 0 : _d.length)) {
+        return;
+      }
+      redirections.value = result;
+      saveToLocalStorage();
+    } catch (e) {
+    }
+  });
+  const redirectOnKeywordIfConfigured = (input, routingBehavior = "direct-link") => {
+    var _a, _b, _c, _d;
+    if (!((_b = (_a = redirections.value) == null ? void 0 : _a.rules) == null ? void 0 : _b.length)) {
+      return false;
+    }
+    const redirectTo = redirections.value.rules.find((r) => inputMatches(input, r.sources));
+    if (!redirectTo) {
+      return false;
+    }
+    const url = ((_c = redirectionOptions.value) == null ? void 0 : _c.urlTransfromer) ? (_d = redirectionOptions.value) == null ? void 0 : _d.urlTransfromer(redirectTo == null ? void 0 : redirectTo.target) : redirectTo == null ? void 0 : redirectTo.target;
+    if (routingBehavior === "event") {
+      emitRoutingEvent(url);
+    } else {
+      window.location.assign(url);
+    }
+    return true;
+  };
+  return {
+    redirections,
+    redirectOnKeywordIfConfigured,
+    initiate
+  };
+});
 const useParamsStore = defineStore("params", () => {
   const params = vue.ref({});
   const defaultLimit = vue.ref(DEFAULT_PAGE_SIZE);
   const searchResultsLink = vue.ref("");
   const searchString = vue.ref("");
   const optionsStore = useOptionsStore();
+  const redirectionStore = useRedirectionStore();
   const query = vue.computed(() => params.value[QUERY_PARAMS_PARSED.QUERY]);
   const page = vue.computed(() => {
     const page2 = Number(params.value[QUERY_PARAMS_PARSED.PAGE]) || 1;
@@ -2767,6 +2859,13 @@ const useParamsStore = defineStore("params", () => {
     facet
   }) => {
     var _a;
+    const redirectionApplied = redirectionStore.redirectOnKeywordIfConfigured(
+      searchText,
+      optionsStore.boxRoutingBehavior
+    );
+    if (redirectionApplied) {
+      return;
+    }
     if (!searchResultsLink.value || linksMatch(searchResultsLink.value, window.location.pathname)) {
       const singleFacetParam = facet ? getFacetParam(facet.key, [facet.title]) : void 0;
       const facetParam = singleFacetParam ? [
@@ -4682,6 +4781,7 @@ const _sfc_main$_ = /* @__PURE__ */ vue.defineComponent({
     const searchBoxStore = useSearchBoxStore();
     const optionsStore = useOptionsStore();
     const trackingStore = useTrackingStore();
+    const redirectionStore = useRedirectionStore();
     const inputValue = vue.ref("");
     const suggestedValue = vue.ref(defaultSuggestedValue);
     const opened = vue.ref(props.isSearchContainer);
@@ -4720,6 +4820,7 @@ const _sfc_main$_ = /* @__PURE__ */ vue.defineComponent({
       paramsStore.setSearchResultsLink(props.options.links.searchResults);
       searchBoxStore.saveOptions({ newOptions: props.options });
       optionsStore.setSearchBoxOptions({ options: props.options });
+      redirectionStore.initiate(props.options.redirections, props.options.options);
       bindSearchTriggers(searchTriggers.value, handleCurrentValueSearch);
       if (props.isSearchContainer && searchBoxInput.value) {
         (_a2 = searchBoxInput.value) == null ? void 0 : _a2.focus();
@@ -9426,6 +9527,7 @@ const _sfc_main$c = /* @__PURE__ */ vue.defineComponent({
     const trackingStore = useTrackingStore();
     const dynamicDataStore = useDynamicDataStore();
     const screenStore = useScreenStore();
+    const redirectionStore = useRedirectionStore();
     const initialFilters = vue.computed(() => {
       var _a;
       return (_a = props.initialFilters) != null ? _a : {};
@@ -9451,17 +9553,18 @@ const _sfc_main$c = /* @__PURE__ */ vue.defineComponent({
       const searchParams = getSearchParams((_a = props.options.ssr) == null ? void 0 : _a.url);
       paramStore.add(parseParams(searchParams));
     };
-    vue.onMounted(() => {
+    vue.onMounted(() => __async(this, null, function* () {
       var _a, _b;
       window.addEventListener("popstate", handlePopState);
       window.addEventListener("resize", handleResize);
+      yield redirectionStore.initiate(props.options.redirections, props.options.options);
       if (props.initialData) {
         searchResultStore.add(__spreadValues({}, props.initialData));
       }
       handleMounted();
       (_b = (_a = props.options.callbacks) == null ? void 0 : _a.onMounted) == null ? void 0 : _b.call(_a);
       mounted.value = true;
-    });
+    }));
     vue.onBeforeUnmount(() => {
       window.removeEventListener("resize", handleResize);
       window.removeEventListener("popstate", handlePopState);
@@ -9505,6 +9608,13 @@ const _sfc_main$c = /* @__PURE__ */ vue.defineComponent({
       const context = getLupaTrackingContext();
       const limit = publicQuery.limit || defaultSearchResultPageSize.value;
       const query2 = __spreadProps(__spreadValues(__spreadValues({}, publicQuery), context), { limit });
+      const redirectionApplied = redirectionStore.redirectOnKeywordIfConfigured(
+        publicQuery.searchText,
+        optionStore.searchResultsRoutingBehavior
+      );
+      if (redirectionApplied) {
+        return;
+      }
       if (!query2.searchText && props.options.disallowEmptyQuery) {
         return;
       }

package/dist/lupaSearch.mjs

@@ -1633,6 +1633,14 @@ const track$1 = (queryKey, event, environment, customBaseUrl) => __awaiter(void
   }
   return res.json();
 });
+const loadRedirectionRules = (queryKey, environment, customBaseUrl) => __awaiter(void 0, void 0, void 0, function* () {
+  const res = yield fetch(`${getApiUrl$1(environment, customBaseUrl)}redirections/${queryKey}`, Object.assign(Object.assign({}, defaultConfig$1), { method: "GET" }));
+  if (res.status < 400) {
+    return res.json();
+  }
+  const errors = yield res.json();
+  return { success: false, errors };
+});
 const LupaSearchSdk = {
   query: (queryKey, publicQuery, options = null) => {
     if (options === null || options === void 0 ? void 0 : options.customUrl) {
@@ -1654,6 +1662,9 @@ const LupaSearchSdk = {
   },
   queryByIds: (queryKey, ids, options = null) => {
     return queryByIds(queryKey, ids, (options === null || options === void 0 ? void 0 : options.environment) || "production", options === null || options === void 0 ? void 0 : options.customBaseUrl);
+  },
+  loadRedirectionRules: (queryKey, options = null) => {
+    return loadRedirectionRules(queryKey, (options === null || options === void 0 ? void 0 : options.environment) || "production", options === null || options === void 0 ? void 0 : options.customBaseUrl);
   }
 };
 const getNormalizedString = (str) => {
@@ -1732,6 +1743,13 @@ const escapeHtml = (value) => {
   });
   return output;
 };
+const inputMatches = (input, possibleValues) => {
+  if (!input) {
+    return false;
+  }
+  const normalizedInput = getNormalizedString(input);
+  return possibleValues.some((v) => getNormalizedString(v).startsWith(normalizedInput));
+};
 const initAnalyticsTracking = (analyticsOptions) => {
   try {
     if (analyticsOptions == null ? void 0 : analyticsOptions.enabled) {
@@ -2682,12 +2700,86 @@ const toggleHierarchyParam = (params = [], param = "", removeAllLevels = false)
   }
   return getMostSpecificHierarchyTerms([param, ...params]);
 };
+const CACHE_KEY = "lupasearch-client-redirections";
+const useRedirectionStore = defineStore("redirections", () => {
+  const redirections = ref({ rules: [] });
+  const redirectionOptions = ref({ enabled: false, queryKey: "" });
+  const saveToLocalStorage = () => {
+    try {
+      localStorage.setItem(
+        CACHE_KEY,
+        JSON.stringify({ redirections: redirections.value, savedAt: Date.now() })
+      );
+    } catch (e) {
+    }
+  };
+  const tryLoadFromLocalStorage = (config) => {
+    var _a;
+    if (!config.cacheSeconds)
+      return false;
+    try {
+      const data = JSON.parse((_a = localStorage.getItem(CACHE_KEY)) != null ? _a : "");
+      if ((data == null ? void 0 : data.redirections) && Date.now() - data.savedAt < 1e3 * config.cacheSeconds) {
+        redirections.value = data.redirections;
+        return true;
+      }
+    } catch (e) {
+    }
+    return false;
+  };
+  const initiate = (config, options) => __async(void 0, null, function* () {
+    var _a, _b, _c, _d;
+    if ((_a = redirectionOptions.value) == null ? void 0 : _a.enabled) {
+      return;
+    }
+    redirectionOptions.value = config;
+    if (!(config == null ? void 0 : config.enabled)) {
+      return;
+    }
+    const loaded = tryLoadFromLocalStorage(config);
+    if (loaded || ((_c = (_b = redirections.value) == null ? void 0 : _b.rules) == null ? void 0 : _c.length) > 0) {
+      return;
+    }
+    try {
+      const result = yield LupaSearchSdk.loadRedirectionRules(config.queryKey, options);
+      if (!((_d = result == null ? void 0 : result.rules) == null ? void 0 : _d.length)) {
+        return;
+      }
+      redirections.value = result;
+      saveToLocalStorage();
+    } catch (e) {
+    }
+  });
+  const redirectOnKeywordIfConfigured = (input, routingBehavior = "direct-link") => {
+    var _a, _b, _c, _d;
+    if (!((_b = (_a = redirections.value) == null ? void 0 : _a.rules) == null ? void 0 : _b.length)) {
+      return false;
+    }
+    const redirectTo = redirections.value.rules.find((r) => inputMatches(input, r.sources));
+    if (!redirectTo) {
+      return false;
+    }
+    const url = ((_c = redirectionOptions.value) == null ? void 0 : _c.urlTransfromer) ? (_d = redirectionOptions.value) == null ? void 0 : _d.urlTransfromer(redirectTo == null ? void 0 : redirectTo.target) : redirectTo == null ? void 0 : redirectTo.target;
+    if (routingBehavior === "event") {
+      emitRoutingEvent(url);
+    } else {
+      window.location.assign(url);
+    }
+    return true;
+  };
+  return {
+    redirections,
+    redirectOnKeywordIfConfigured,
+    initiate
+  };
+});
 const useParamsStore = defineStore("params", () => {
   const params = ref({});
   const defaultLimit = ref(DEFAULT_PAGE_SIZE);
   const searchResultsLink = ref("");
   const searchString = ref("");
   const optionsStore = useOptionsStore();
+  const redirectionStore = useRedirectionStore();
   const query = computed(() => params.value[QUERY_PARAMS_PARSED.QUERY]);
   const page = computed(() => {
     const page2 = Number(params.value[QUERY_PARAMS_PARSED.PAGE]) || 1;
@@ -2765,6 +2857,13 @@ const useParamsStore = defineStore("params", () => {
     facet
   }) => {
     var _a;
+    const redirectionApplied = redirectionStore.redirectOnKeywordIfConfigured(
+      searchText,
+      optionsStore.boxRoutingBehavior
+    );
+    if (redirectionApplied) {
+      return;
+    }
     if (!searchResultsLink.value || linksMatch(searchResultsLink.value, window.location.pathname)) {
       const singleFacetParam = facet ? getFacetParam(facet.key, [facet.title]) : void 0;
       const facetParam = singleFacetParam ? [
@@ -4680,6 +4779,7 @@ const _sfc_main$_ = /* @__PURE__ */ defineComponent({
     const searchBoxStore = useSearchBoxStore();
     const optionsStore = useOptionsStore();
     const trackingStore = useTrackingStore();
+    const redirectionStore = useRedirectionStore();
     const inputValue = ref("");
     const suggestedValue = ref(defaultSuggestedValue);
     const opened = ref(props.isSearchContainer);
@@ -4718,6 +4818,7 @@ const _sfc_main$_ = /* @__PURE__ */ defineComponent({
       paramsStore.setSearchResultsLink(props.options.links.searchResults);
       searchBoxStore.saveOptions({ newOptions: props.options });
       optionsStore.setSearchBoxOptions({ options: props.options });
+      redirectionStore.initiate(props.options.redirections, props.options.options);
       bindSearchTriggers(searchTriggers.value, handleCurrentValueSearch);
       if (props.isSearchContainer && searchBoxInput.value) {
         (_a2 = searchBoxInput.value) == null ? void 0 : _a2.focus();
@@ -9424,6 +9525,7 @@ const _sfc_main$c = /* @__PURE__ */ defineComponent({
     const trackingStore = useTrackingStore();
     const dynamicDataStore = useDynamicDataStore();
     const screenStore = useScreenStore();
+    const redirectionStore = useRedirectionStore();
     const initialFilters = computed(() => {
       var _a;
       return (_a = props.initialFilters) != null ? _a : {};
@@ -9449,17 +9551,18 @@ const _sfc_main$c = /* @__PURE__ */ defineComponent({
       const searchParams = getSearchParams((_a = props.options.ssr) == null ? void 0 : _a.url);
       paramStore.add(parseParams(searchParams));
     };
-    onMounted(() => {
+    onMounted(() => __async(this, null, function* () {
       var _a, _b;
       window.addEventListener("popstate", handlePopState);
       window.addEventListener("resize", handleResize);
+      yield redirectionStore.initiate(props.options.redirections, props.options.options);
       if (props.initialData) {
         searchResultStore.add(__spreadValues({}, props.initialData));
       }
       handleMounted();
       (_b = (_a = props.options.callbacks) == null ? void 0 : _a.onMounted) == null ? void 0 : _b.call(_a);
       mounted.value = true;
-    });
+    }));
     onBeforeUnmount(() => {
       window.removeEventListener("resize", handleResize);
       window.removeEventListener("popstate", handlePopState);
@@ -9503,6 +9606,13 @@ const _sfc_main$c = /* @__PURE__ */ defineComponent({
       const context = getLupaTrackingContext();
       const limit = publicQuery.limit || defaultSearchResultPageSize.value;
       const query2 = __spreadProps(__spreadValues(__spreadValues({}, publicQuery), context), { limit });
+      const redirectionApplied = redirectionStore.redirectOnKeywordIfConfigured(
+        publicQuery.searchText,
+        optionStore.searchResultsRoutingBehavior
+      );
+      if (redirectionApplied) {
+        return;
+      }
       if (!query2.searchText && props.options.disallowEmptyQuery) {
         return;
       }

package/dist/src/stores/redirections.d.ts

@@ -0,0 +1,18 @@
+import { RedirectionOptions } from '../types/redirections/RedirectionOptions';
+import { RedirectionRules } from '@getlupa/client-sdk/Types';
+import { type Ref } from 'vue';
+import { SdkOptions } from '../types/General';
+import { RoutingBehavior } from '../types/search-results/RoutingBehavior';
+export declare const useRedirectionStore: import("pinia").StoreDefinition<"redirections", import("pinia")._UnwrapAll<Pick<{
+    redirections: Ref<RedirectionRules>;
+    redirectOnKeywordIfConfigured: (input: string, routingBehavior?: RoutingBehavior) => boolean;
+    initiate: (config?: RedirectionOptions, options?: SdkOptions) => Promise<void>;
+}, "redirections">>, Pick<{
+    redirections: Ref<RedirectionRules>;
+    redirectOnKeywordIfConfigured: (input: string, routingBehavior?: RoutingBehavior) => boolean;
+    initiate: (config?: RedirectionOptions, options?: SdkOptions) => Promise<void>;
+}, never>, Pick<{
+    redirections: Ref<RedirectionRules>;
+    redirectOnKeywordIfConfigured: (input: string, routingBehavior?: RoutingBehavior) => boolean;
+    initiate: (config?: RedirectionOptions, options?: SdkOptions) => Promise<void>;
+}, "redirectOnKeywordIfConfigured" | "initiate">>;

package/dist/src/types/redirections/RedirectionOptions.d.ts

@@ -0,0 +1,6 @@
+export type RedirectionOptions = {
+    enabled: boolean;
+    queryKey: string;
+    cacheSeconds?: number;
+    urlTransfromer?: (redirectTo: string) => string;
+};

package/dist/src/types/search-box/SearchBoxOptions.d.ts

@@ -6,12 +6,14 @@ import type { SearchBoxHistory } from './SearchBoxHistory';
 import type { SearchBoxPanel } from './SearchBoxPanel';
 import { DisplaySuggestion } from './Common';
 import { QueryParams } from '../search-results/QueryParams';
+import { RedirectionOptions } from '../redirections/RedirectionOptions';
 export type SearchBoxOptions = SearchBoxPanelOptions & {
     inputSelector: string;
     searchTriggers?: string[];
     routingBehavior?: RoutingBehavior;
     dynamicData?: DynamicData;
     callbacks?: SearchBoxEventCallbacks;
+    redirections?: RedirectionOptions;
 };
 export type SearchBoxOptionLabels = {
     placeholder: string;

package/dist/src/types/search-results/SearchResultsOptions.d.ts

@@ -3,6 +3,7 @@ import type { CategoryFilterOptions } from '../product-list/ProductListOptions';
 import type { SearchResultsAdditionalPanelOptions } from './SearchResultsAdditionalPanelOptions';
 import type { SearchResultsProductCardOptions } from './SearchResultsProductCardOptions';
 import type { SearchResultsSortOptions } from './SearchResultsSort';
+import { RedirectionOptions } from '../redirections/RedirectionOptions';
 export type SearchResultsOptions = SearchResultsProductOptions & SearchResultsAdditionalPanels & {
     containerSelector: string;
     breadcrumbs: SearchResultsBreadcrumb[];
@@ -12,6 +13,7 @@ export type SearchResultsOptions = SearchResultsProductOptions & SearchResultsAd
     categories?: CategoryFilterOptions;
     dynamicData?: DynamicData;
     ssr?: SsrOptions;
+    redirections?: RedirectionOptions;
 };
 export type SsrOptions = {
     baseUrl?: string;

package/dist/src/utils/string.utils.d.ts

@@ -7,3 +7,4 @@ export declare const getDisplayValue: (value?: string | number) => string;
 export declare const getProductKey: (index: string, product: Document, idKey: string | undefined) => string;
 export declare const normalizeFloat: (value?: string) => number;
 export declare const escapeHtml: (value?: string) => string;
+export declare const inputMatches: (input: string, possibleValues: string[]) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getlupa/vue",
-  "version": "0.6.3",
+  "version": "0.7.0",
   "main": "dist/lupaSearch.js",
   "module": "dist/lupaSearch.mjs",
   "types": "dist/src/index.d.ts",
@@ -23,7 +23,7 @@
     "vue": "^3.0.0"
   },
   "devDependencies": {
-    "@getlupa/client-sdk": "^1.3.5",
+    "@getlupa/client-sdk": "^1.4.0",
     "@pinia/testing": "^0.1.2",
     "@rollup/plugin-babel": "5.3.0",
     "@rollup/plugin-commonjs": "^21.0.1",