@usereactify/search 4.1.0-beta.3 → 4.1.0

package/dist/filter/Filter.js

@@ -30,7 +30,7 @@ const Filter = (props) => {
     if ("multi" === filter.displayType) {
         return (react_1.default.createElement(MultiList_1.default, Object.assign({ showCheckbox: false }, reactiveFilterListProps, { render: (reactivesearchFilterProps) => (react_1.default.createElement(FilterListInner, Object.assign({}, props, { reactivesearchFilterProps: reactivesearchFilterProps }))) })));
     }
-    console.error(`filter with display type "${filter.displayType}" not yet supported`);
+    console.log(`filter with display type "${filter.displayType}" not yet supported`);
     return null;
 };
 exports.Filter = Filter;

package/dist/hooks/reactivesearch/useReactiveFilterListProps.js

@@ -7,7 +7,7 @@ exports.useReactiveFilterListProps = void 0;
 const react_1 = __importDefault(require("react"));
 const useReactiveReactProp_1 = require("./useReactiveReactProp");
 const useReactiveFilterListProps = (filter) => {
-    const reactiveReactProp = (0, useReactiveReactProp_1.useReactiveReactProp)(filter.id);
+    const reactiveReactProp = (0, useReactiveReactProp_1.useReactiveReactProp)(filter.handle);
     const nestedField = react_1.default.useMemo(() => {
         const nestedFields = ["variants"];
         const topField = filter.field.split(".")[0];
@@ -93,7 +93,7 @@ const useReactiveFilterListProps = (filter) => {
         customQuery,
         defaultQuery,
         URLParams: true,
-        componentId: filter.id,
+        componentId: filter.handle,
         dataField: filter.field,
         filterLabel: filter.name,
         react: reactiveReactProp,

package/dist/hooks/reactivesearch/useReactiveReactProp.d.ts

@@ -1,3 +1,3 @@
-export declare const useReactiveReactProp: (currentId?: string | undefined) => {
+export declare const useReactiveReactProp: (currentHandle?: string | undefined) => {
     and: string[];
 };

package/dist/hooks/reactivesearch/useReactiveReactProp.js

@@ -8,18 +8,18 @@ const react_1 = __importDefault(require("react"));
 const sensor_1 = require("../../sensor");
 const useFilters_1 = require("../useFilters");
 const provider_1 = require("../../provider");
-const useReactiveReactProp = (currentId) => {
+const useReactiveReactProp = (currentHandle) => {
     const filters = (0, useFilters_1.useFilters)();
-    const { additionalComponentIds } = (0, provider_1.useContext)();
+    const { additionalComponentHandles } = (0, provider_1.useContext)();
     return react_1.default.useMemo(() => {
         return {
             and: [
                 "SearchInput",
                 ...sensor_1.SENSOR_IDS,
-                ...(additionalComponentIds !== null && additionalComponentIds !== void 0 ? additionalComponentIds : []),
-                ...filters.map((filter) => filter.id),
-            ].filter((id) => id !== currentId),
+                ...(additionalComponentHandles !== null && additionalComponentHandles !== void 0 ? additionalComponentHandles : []),
+                ...filters.map((filter) => filter.handle),
+            ].filter((handle) => handle !== currentHandle),
         };
-    }, [filters, currentId]);
+    }, [filters, currentHandle]);
 };
 exports.useReactiveReactProp = useReactiveReactProp;

package/dist/hooks/useLiveConfig.d.ts

@@ -1,4 +1,4 @@
 import { Config } from "../types/config";
-export declare const useLiveConfig: (shopifyPermanentDomain: string) => {
+export declare const useLiveConfig: (shopifyPermanentDomain: string, configId?: string | undefined) => {
     config: Config | undefined;
 };

package/dist/hooks/useLiveConfig.js

@@ -41,7 +41,7 @@ function getCachedConfig() {
     }
     return;
 }
-const useLiveConfig = (shopifyPermanentDomain) => {
+const useLiveConfig = (shopifyPermanentDomain, configId) => {
     const [config, setConfig] = react_1.default.useState(getCachedConfig());
     react_1.default.useEffect(() => {
         const cachedConfig = getCachedConfig();
@@ -49,14 +49,19 @@ const useLiveConfig = (shopifyPermanentDomain) => {
             return;
         (() => __awaiter(void 0, void 0, void 0, function* () {
             debug("fetching fresh config");
-            const json = yield fetch(`https://config.search.reactify.app/?shop=${shopifyPermanentDomain}`).then((response) => response.json());
+            const searchParams = new URLSearchParams();
+            searchParams.set("shop", shopifyPermanentDomain);
+            if (configId) {
+                searchParams.set("id", configId);
+            }
+            const json = yield fetch(`https://config.search.reactify.app/?${searchParams.toString()}`).then((response) => response.json());
             setConfig(json.body);
             window.sessionStorage.setItem("reactify-search:config", JSON.stringify({
                 expiresAt: new Date().getTime() + CACHE_EXPIRY,
                 config: json.body,
             }));
         }))();
-    }, [shopifyPermanentDomain]);
+    }, [shopifyPermanentDomain, configId]);
     return {
         config,
     };

package/dist/hooks/useSort.d.ts

@@ -1,5 +1,5 @@
 export declare const useSort: () => {
     sortOption: import("..").ConfigSort | undefined;
     sortOptions: import("..").ConfigSort[];
-    setSortOption: (sortOptionId: string) => void;
+    setSortOption: (sortOptionHandle: string) => void;
 };

package/dist/hooks/useSort.js

@@ -10,12 +10,12 @@ const hooks_1 = require("../hooks");
 const useSort = () => {
     const { track } = (0, hooks_1.useAnalytics)();
     const { sortOption, sortOptions, setSortOption } = (0, provider_1.useContext)();
-    const handleSortChange = react_1.default.useCallback((sortOptionId) => {
-        setSortOption(sortOptionId);
+    const handleSortChange = react_1.default.useCallback((sortOptionHandle) => {
+        setSortOption(sortOptionHandle);
         track({
             eventName: "sortChange",
             payload: {
-                type: sortOptionId,
+                type: sortOptionHandle,
             },
         });
     }, [track, setSortOption]);

package/dist/provider.d.ts

@@ -14,19 +14,20 @@ declare type Context = {
     onRedirect?: (type: "redirect" | "search", url: string) => void;
     submitSearch: (localSearchQuery?: string) => void;
     setSearchQuery: (searchQuery: string) => void;
-    setSortOption: (sortOptionId: string) => void;
+    setSortOption: (sortOptionHandle: string) => void;
     showInstantSearchResults: boolean;
     setShowInstantSearchResults: (showInstantSearchResults: boolean) => void;
     theme?: Theme;
     curation?: ConfigCuration;
     /** Array of additional component IDs managed outside of Reactify Search */
-    additionalComponentIds?: string[];
+    additionalComponentHandles?: string[];
 };
 declare const Context: React.Context<Context | undefined>;
 declare type Props = {
     index: string;
     shopifyPermanentDomain: string;
-    filterStackId?: string;
+    configId?: string;
+    filterStackHandle?: string;
     collection?: Collection;
     noReactiveBase?: boolean;
     instantSearch?: boolean;
@@ -34,7 +35,7 @@ declare type Props = {
     credentials?: Credentials;
     theme?: Theme;
     /** Array of additional component IDs managed outside of Reactify Search */
-    additionalComponentIds?: string[];
+    additionalComponentHandles?: string[];
     /**
      * Optional render function to display a component when the config is loading.
      */

package/dist/provider.js

@@ -50,7 +50,7 @@ Sentry.init({
 });
 const Provider = (_a) => {
     var { renderBooting } = _a, props = __rest(_a, ["renderBooting"]);
-    const { config } = (0, hooks_1.useLiveConfig)(props.shopifyPermanentDomain);
+    const { config } = (0, hooks_1.useLiveConfig)(props.shopifyPermanentDomain, props.configId);
     if (!config) {
         if (renderBooting)
             return renderBooting();
@@ -61,17 +61,17 @@ const Provider = (_a) => {
             scope.setTag("shop", props.shopifyPermanentDomain);
             if (!!props.collection)
                 scope.setTag("collection", props.collection.handle);
-            if (!!props.filterStackId)
-                scope.setTag("filterStackId", props.filterStackId);
+            if (!!props.filterStackHandle)
+                scope.setTag("filter", props.filterStackHandle);
             if (!!props.instantSearch)
-                scope.setTag("instantSearch", true);
+                scope.setTag("search", true);
         } },
         react_1.default.createElement(exports.ConfiguredProvider, Object.assign({}, props, { config: config }))));
 };
 exports.Provider = Provider;
 const ConfiguredProvider = (props) => {
     var _a, _b;
-    const { index, config, children, collection, instantSearch, filterStackId, noReactiveBase, shopifyPermanentDomain, additionalComponentIds, onRedirect, } = props;
+    const { index, config, children, collection, instantSearch, filterStackHandle, noReactiveBase, shopifyPermanentDomain, additionalComponentHandles, onRedirect, } = props;
     const credentials = (_a = props.credentials) !== null && _a !== void 0 ? _a : defaultCredentials;
     const theme = (_b = props.theme) !== null && _b !== void 0 ? _b : {
         typography: {
@@ -110,13 +110,13 @@ const ConfiguredProvider = (props) => {
             setSearchQuery(searchQueryFromURL);
     }, [searchQueryFromURL]);
     react_1.default.useEffect(() => {
-        if (searchSortFromURL && (sortOption === null || sortOption === void 0 ? void 0 : sortOption.id) !== searchSortFromURL) {
+        if (searchSortFromURL && (sortOption === null || sortOption === void 0 ? void 0 : sortOption.handle) !== searchSortFromURL) {
             setSortOption(searchSortFromURL, true);
         }
     }, [searchSortFromURL]);
     react_1.default.useEffect(() => {
-        if (window.location.search === "" && (sortOption === null || sortOption === void 0 ? void 0 : sortOption.id)) {
-            setSortOption(sortOptions[0].id, true);
+        if (window.location.search === "" && (sortOption === null || sortOption === void 0 ? void 0 : sortOption.handle)) {
+            setSortOption(sortOption.handle, true);
         }
     }, [window.location.href]);
     const [showInstantSearchResults, setShowInstantSearchResults] = react_1.default.useState(false);
@@ -140,7 +140,7 @@ const ConfiguredProvider = (props) => {
     // do not attempt to resolve a filter stack if in instantSearch mode
     const filterStack = instantSearch
         ? undefined
-        : useFilterStack(config, collection, filterStackId);
+        : useFilterStack(config, collection, filterStackHandle);
     const curation = useCuration(config, collection, searchQuery);
     const contextValue = react_1.default.useMemo(() => ({
         index,
@@ -159,7 +159,7 @@ const ConfiguredProvider = (props) => {
         setShowInstantSearchResults,
         theme,
         curation,
-        additionalComponentIds,
+        additionalComponentHandles,
         instantSearch: !!instantSearch,
         showInstantSearchResults: !!showInstantSearchResults && !!searchQuery,
     }), [
@@ -176,7 +176,7 @@ const ConfiguredProvider = (props) => {
         onRedirect,
         submitSearch,
         instantSearch,
-        additionalComponentIds,
+        additionalComponentHandles,
         showInstantSearchResults,
         theme,
     ]);
@@ -200,15 +200,16 @@ const useSortState = (config, collection) => {
             .sort((a, b) => `${a.position}`.localeCompare(`${b.position}`))
             .filter(({ visibility }) => ["all", type].includes(visibility));
     }, [config, collection]);
-    const [sortOptionState, setSortOptionState] = react_1.default.useState((_a = sortOptions[0]) === null || _a === void 0 ? void 0 : _a.id);
-    const sortOption = react_1.default.useMemo(() => sortOptions.find(({ id }) => id === sortOptionState) || sortOptions[0], [sortOptions, sortOptionState]);
-    const setSortOption = react_1.default.useCallback((sortOptionId, ignoreHistoryState = false) => {
-        setSortOptionState(sortOptionId);
+    const [sortOptionState, setSortOptionState] = react_1.default.useState((_a = sortOptions[0]) === null || _a === void 0 ? void 0 : _a.handle);
+    const sortOption = react_1.default.useMemo(() => sortOptions.find(({ handle }) => handle === sortOptionState) ||
+        sortOptions[0], [sortOptions, sortOptionState]);
+    const setSortOption = react_1.default.useCallback((sortOptionHandle, ignoreHistoryState = false) => {
+        setSortOptionState(sortOptionHandle);
         if (!ignoreHistoryState) {
             const url = new URL(window.location.href);
             url.searchParams.has("sort")
-                ? url.searchParams.set("sort", sortOptionId)
-                : url.searchParams.append("sort", sortOptionId);
+                ? url.searchParams.set("sort", sortOptionHandle)
+                : url.searchParams.append("sort", sortOptionHandle);
             window.history.pushState({}, "", url.toString());
         }
     }, [window.location.href]);
@@ -220,22 +221,37 @@ const useSortState = (config, collection) => {
 // @todo we need a better name for the overall page like "Filter Stack" or something,
 // each block is then called a filter so like Size would be a "Filter" and then each
 // value within it is a "Filter Option"
-const useFilterStack = (config, collection, filterStackId) => react_1.default.useMemo(() => {
-    var _a;
-    // manually select filter stack by ID if provided
-    if (filterStackId) {
-        const filterStack = config.filters.find((filter) => filterStackId === filter.id);
-        if (filterStack)
-            return filterStack;
+const useFilterStack = (config, collection, filterStackHandle) => react_1.default.useMemo(() => {
+    const type = !!collection ? "collection" : "search";
+    // select filters by type
+    const matchingFilterStacks = config.filters.filter((filter) => filter.type === type);
+    // select filter stack by handle if provided
+    if (filterStackHandle) {
+        const matchingFilterStack = matchingFilterStacks.find((filterStack) => filterStackHandle === filterStack.handle);
+        if (matchingFilterStack) {
+            return matchingFilterStack;
+        }
     }
-    // automatically select filter stack by collection if provided
+    // select filter stack by collection if provided
     if (collection === null || collection === void 0 ? void 0 : collection.handle) {
-        const filterStack = config.filters.find((filter) => { var _a; return (_a = filter.collections) === null || _a === void 0 ? void 0 : _a.includes(collection.handle); });
-        if (filterStack)
-            return filterStack;
+        const matchingFilterStack = matchingFilterStacks.find((filterStack) => { var _a; return (_a = filterStack.collections) === null || _a === void 0 ? void 0 : _a.includes(collection.handle); });
+        if (matchingFilterStack) {
+            return matchingFilterStack;
+        }
     }
-    const type = !!collection ? "collection" : "search";
-    return ((_a = config.filters.find((filter) => type === filter.type)) !== null && _a !== void 0 ? _a : config.filters[0]);
+    // select filter with "default" handle
+    let matchingFilterStack = matchingFilterStacks.find((filterStack) => filterStack.handle === "default");
+    if (matchingFilterStack) {
+        return matchingFilterStack;
+    }
+    // select any filter with "default" handle
+    matchingFilterStack = config.filters.find((filterStack) => filterStack.handle === "default");
+    if (matchingFilterStack) {
+        return matchingFilterStack;
+    }
+    // select any available filter as a last resort
+    matchingFilterStack = config.filters[0];
+    return matchingFilterStack;
 }, [config, collection]);
 const useCuration = (config, collection, searchQuery) => react_1.default.useMemo(() => {
     debug("resolveCuration.start", { config, collection, searchQuery });

package/dist/types/firestore.d.ts

@@ -107,6 +107,7 @@ export interface DefinedField {
 export interface Sort {
     id: string;
     name: string;
+    handle: string;
     field: string;
     position: number;
     enabled: boolean;
@@ -116,6 +117,7 @@ export interface Sort {
 export interface Filter {
     id: string;
     name: string;
+    handle: string;
     enabled: boolean;
     pageSize: number;
     keywords: string[];
@@ -135,6 +137,7 @@ export interface FilterOption {
     field: string;
     id: string;
     name: string;
+    handle: string;
     position: number;
     settingsCollapsedDesktop: boolean;
     settingsCollapsedMobile: boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@usereactify/search",
   "description": "React UI library for Reactify Search",
-  "version": "4.1.0-beta.3",
+  "version": "4.1.0",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",