@usereactify/search 3.11.0-beta.0 → 3.12.0-beta.2

package/dist/filter/FilterStack.js

@@ -14,7 +14,7 @@ const FilterStack = (props) => {
         return null;
     if (render)
         return render(filters);
-    return (react_1.default.createElement(react_1.default.Fragment, null, filters.map((filter) => (react_1.default.createElement(FilterWithState, Object.assign({ key: filter.id, filter: filter }, props))))));
+    return (react_1.default.createElement(react_1.default.Fragment, null, filters.map((filter) => (react_1.default.createElement(FilterWithState, Object.assign({ key: filter.handle, filter: filter }, props))))));
 };
 exports.FilterStack = FilterStack;
 const FilterWithState = ({ filter, renderFilter, }) => {

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/provider.d.ts

@@ -20,14 +20,14 @@ declare type Context = {
     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;
     configId?: string;
-    filterStackId?: string;
+    filterStackHandle?: string;
     collection?: Collection;
     noReactiveBase?: boolean;
     instantSearch?: boolean;
@@ -35,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

@@ -38,7 +38,7 @@ const Provider = (_a) => {
 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: {
@@ -107,7 +107,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,
@@ -126,7 +126,7 @@ const ConfiguredProvider = (props) => {
         setShowInstantSearchResults,
         theme,
         curation,
-        additionalComponentIds,
+        additionalComponentHandles,
         instantSearch: !!instantSearch,
         showInstantSearchResults: !!showInstantSearchResults && !!searchQuery,
     }), [
@@ -143,7 +143,7 @@ const ConfiguredProvider = (props) => {
         onRedirect,
         submitSearch,
         instantSearch,
-        additionalComponentIds,
+        additionalComponentHandles,
         showInstantSearchResults,
         theme,
     ]);
@@ -187,22 +187,31 @@ 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";
+    // exclude filters by type
+    const filterStacks = config.filters.filter((filter) => filter.type === type);
+    // select filter stack by handle if provided
+    if (filterStackHandle) {
+        const matchingFilterStack = filterStacks.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 = filterStacks.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
+    const matchingFilterStack = filterStacks.find((filterStack) => filterStack.handle === "default");
+    if (matchingFilterStack) {
+        return matchingFilterStack;
+    }
+    // select any available filter as a last resort
+    return config.filters[0];
 }, [config, collection]);
 const useCuration = (config, collection, searchQuery) => react_1.default.useMemo(() => {
     debug("resolveCuration.start", { config, collection, searchQuery });

package/dist/types/firestore.d.ts

@@ -116,6 +116,7 @@ export interface Sort {
 export interface Filter {
     id: string;
     name: string;
+    handle: string;
     enabled: boolean;
     pageSize: number;
     keywords: string[];
@@ -135,6 +136,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": "3.11.0-beta.0",
+  "version": "3.12.0-beta.2",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",