@usereactify/search 4.4.0-beta.0 → 5.0.0-beta.1

package/dist/hooks/reactivesearch/useReactiveFilterListProps.js

@@ -1,106 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-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.handle);
-    const nestedField = react_1.default.useMemo(() => {
-        const nestedFields = ["variants"];
-        const topField = filter.field.split(".")[0];
-        if (nestedFields.includes(topField))
-            return topField;
-        return undefined;
-    }, [filter]);
-    // define a custom query for when settingsHideUnavailable is enabled and the target field is inside variants
-    // customQuery defines how this filter affects *other* components like the results component
-    const customQuery = react_1.default.useMemo(() => {
-        if (!filter.settingsHideUnavailable ||
-            !filter.field.startsWith("variants."))
-            return undefined;
-        return (value) => {
-            if (!value)
-                return {};
-            // reactivesearch sometimes returns string, sometimes string[]
-            const valueArray = "string" === typeof value ? [value] : value;
-            if (0 === valueArray.length)
-                return {};
-            return {
-                query: {
-                    nested: {
-                        path: "variants",
-                        query: {
-                            bool: {
-                                must: [
-                                    {
-                                        match: {
-                                            "variants.available": "true",
-                                        },
-                                    },
-                                    {
-                                        terms: {
-                                            [filter.field]: valueArray,
-                                        },
-                                    },
-                                ],
-                            },
-                        },
-                    },
-                },
-            };
-        };
-    }, [filter]);
-    // define a default query for when settingsHideUnavailable is enabled and the target field is inside variants
-    // defaultQuery defines how this filter affects itself i.e. the options displayed
-    const defaultQuery = react_1.default.useMemo(() => {
-        if (!filter.settingsHideUnavailable ||
-            !filter.field.startsWith("variants."))
-            return undefined;
-        // override the aggregation query to filter the results by the variants.available attribute
-        return () => {
-            return {
-                aggs: {
-                    reactivesearch_nested: {
-                        nested: { path: "variants" },
-                        aggs: {
-                            reactify_nested_outer: {
-                                filter: {
-                                    match: {
-                                        "variants.available": "true",
-                                    },
-                                },
-                                aggs: {
-                                    [filter.field]: {
-                                        terms: {
-                                            field: filter.field,
-                                            size: 100,
-                                            order: { _count: "desc" },
-                                        },
-                                    },
-                                },
-                            },
-                        },
-                    },
-                },
-            };
-        };
-    }, [filter]);
-    return react_1.default.useMemo(() => ({
-        nestedField,
-        customQuery,
-        defaultQuery,
-        URLParams: true,
-        componentId: filter.handle,
-        dataField: filter.field,
-        filterLabel: filter.name,
-        react: reactiveReactProp,
-        size: parseInt(filter.displaySize) || undefined,
-        showFilter: filter.settingsShowFilter || true,
-        showLoadMore: filter.settingsShowMore || false,
-        showSearch: (filter === null || filter === void 0 ? void 0 : filter.settingsShowSearch) || false,
-    }), [filter, reactiveReactProp]);
-};
-exports.useReactiveFilterListProps = useReactiveFilterListProps;

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

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

package/dist/hooks/reactivesearch/useReactiveReactProp.js

@@ -1,25 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useReactiveReactProp = void 0;
-const react_1 = __importDefault(require("react"));
-const sensor_1 = require("../../sensor");
-const useFilters_1 = require("../useFilters");
-const provider_1 = require("../../provider");
-const useReactiveReactProp = (currentHandle) => {
-    const filters = (0, useFilters_1.useFilters)();
-    const { additionalComponentHandles } = (0, provider_1.useContext)();
-    return react_1.default.useMemo(() => {
-        return {
-            and: [
-                "SearchInput",
-                ...sensor_1.SENSOR_IDS,
-                ...(additionalComponentHandles !== null && additionalComponentHandles !== void 0 ? additionalComponentHandles : []),
-                ...filters.map((filter) => filter.handle),
-            ].filter((handle) => handle !== currentHandle),
-        };
-    }, [filters, currentHandle]);
-};
-exports.useReactiveReactProp = useReactiveReactProp;

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

@@ -1,19 +0,0 @@
-declare type Props = {
-    pageSize?: number;
-};
-export declare const useReactiveResultListProps: (props?: Props) => {
-    size: number;
-    URLParams: boolean;
-    showLoader: boolean;
-    dataField: string;
-    showResultStats: boolean;
-    react: {
-        and: string[];
-    };
-    componentId: string;
-    scrollOnChange: boolean;
-    pagination: boolean;
-    infiniteScroll: boolean;
-    renderNoResults: () => null;
-};
-export {};

package/dist/hooks/reactivesearch/useReactiveResultListProps.js

@@ -1,32 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useReactiveResultListProps = void 0;
-const react_1 = __importDefault(require("react"));
-const hooks_1 = require("../../hooks");
-const useReactiveReactProp_1 = require("./useReactiveReactProp");
-const useReactiveResultListProps = (props = {}) => {
-    const { pageSize } = props;
-    const filterStack = (0, hooks_1.useFilterStack)();
-    const reactiveReactProp = (0, useReactiveReactProp_1.useReactiveReactProp)();
-    const size = react_1.default.useMemo(() => {
-        var _a;
-        return (_a = pageSize !== null && pageSize !== void 0 ? pageSize : filterStack === null || filterStack === void 0 ? void 0 : filterStack.pageSize) !== null && _a !== void 0 ? _a : 20;
-    }, [pageSize, filterStack]);
-    return react_1.default.useMemo(() => ({
-        size,
-        URLParams: true,
-        showLoader: false,
-        dataField: "title",
-        showResultStats: false,
-        react: reactiveReactProp,
-        componentId: "page",
-        scrollOnChange: false,
-        pagination: (filterStack === null || filterStack === void 0 ? void 0 : filterStack.paginationType) !== "infinite_scroll",
-        infiniteScroll: (filterStack === null || filterStack === void 0 ? void 0 : filterStack.paginationType) === "infinite_scroll",
-        renderNoResults: () => null, // always use only render, otherwise both are shown
-    }), [filterStack, reactiveReactProp, pageSize]);
-};
-exports.useReactiveResultListProps = useReactiveResultListProps;

package/dist/hooks/useAnalytics.d.ts

@@ -1,95 +0,0 @@
-export declare const useAnalytics: () => {
-    track: (event: TrackEvent) => Promise<import("axios").AxiosResponse<any, any> | undefined>;
-};
-export declare type TrackEvent = TrackEvent.SearchEvent | TrackEvent.ZeroResultsEvent | TrackEvent.ViewProductEvent | TrackEvent.ClickProductEvent | TrackEvent.ViewPromotionEvent | TrackEvent.ClickPromotionEvent | TrackEvent.PaginationChangeEvent | TrackEvent.SortChangeEvent | TrackEvent.FilterChangeEvent;
-export declare namespace TrackEvent {
-    interface SearchEvent {
-        eventName: "search";
-        payload: SearchEvent.Payload;
-    }
-    namespace SearchEvent {
-        interface Payload {
-            searchTerm: string;
-        }
-    }
-    interface ZeroResultsEvent {
-        eventName: "zeroResults";
-        payload: ZeroResultsEvent.Payload;
-    }
-    namespace ZeroResultsEvent {
-        interface Payload {
-            searchTerm: string;
-        }
-    }
-    interface ViewProductEvent {
-        eventName: "viewProduct";
-        payload: ViewProductEvent.Payload;
-    }
-    namespace ViewProductEvent {
-        interface Payload {
-            elasticProduct: ElasticProduct;
-        }
-    }
-    interface ClickProductEvent {
-        eventName: "clickProduct";
-        payload: ClickProductEvent.Payload;
-    }
-    namespace ClickProductEvent {
-        interface Payload {
-            elasticProduct: ElasticProduct;
-        }
-    }
-    interface ViewPromotionEvent {
-        eventName: "viewPromotion";
-        payload: ViewPromotionEvent.Payload;
-    }
-    namespace ViewPromotionEvent {
-        interface Payload {
-            link: string;
-            title: string;
-        }
-    }
-    interface ClickPromotionEvent {
-        eventName: "clickPromotion";
-        payload: ClickPromotionEvent.Payload;
-    }
-    namespace ClickPromotionEvent {
-        interface Payload {
-            link: string;
-            title: string;
-        }
-    }
-    interface PaginationChangeEvent {
-        eventName: "paginationChange";
-        payload: PaginationChangeEvent.Payload;
-    }
-    namespace PaginationChangeEvent {
-        interface Payload {
-            page: number;
-            source: "search" | "collection";
-        }
-    }
-    interface SortChangeEvent {
-        eventName: "sortChange";
-        payload: SortChangeEvent.Payload;
-    }
-    namespace SortChangeEvent {
-        interface Payload {
-            type: string;
-        }
-    }
-    interface FilterChangeEvent {
-        eventName: "filterChange";
-        payload: FilterChangeEvent.Payload;
-    }
-    namespace FilterChangeEvent {
-        interface Payload {
-            name: string;
-            value: string;
-        }
-    }
-    interface ElasticProduct {
-        id: number;
-        title: string;
-    }
-}

package/dist/hooks/useAnalytics.js

@@ -1,110 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useAnalytics = void 0;
-const axios_1 = __importDefault(require("axios"));
-const provider_1 = require("../provider");
-const useAnalytics = () => {
-    const { shopifyPermanentDomain } = (0, provider_1.useContext)();
-    const url = "https://analytics.search.reactify.app/record/";
-    const track = (event) => __awaiter(void 0, void 0, void 0, function* () {
-        if (!shopifyPermanentDomain) {
-            console.warn(new Error('Unable to send tracking event, missing value for "shopifyPermanentDomain".'));
-            return;
-        }
-        const events = getTrackEvents(event);
-        return axios_1.default.post(url, { events }, { headers: { "X-Reactify-Tenant": shopifyPermanentDomain } });
-    });
-    return { track };
-};
-exports.useAnalytics = useAnalytics;
-function getTrackEvents(event) {
-    const { eventName } = event;
-    let events = [];
-    switch (eventName) {
-        case "search":
-            events = [
-                {
-                    eventName,
-                    payload: event.payload,
-                },
-            ];
-            break;
-        case "zeroResults":
-            events = [
-                {
-                    eventName,
-                    payload: event.payload,
-                },
-            ];
-            break;
-        case "viewProduct":
-            events = [
-                {
-                    eventName,
-                    payload: event.payload,
-                },
-            ];
-            break;
-        case "clickProduct":
-            events = [
-                {
-                    eventName,
-                    payload: event.payload,
-                },
-            ];
-            break;
-        case "viewPromotion":
-            events = [
-                {
-                    eventName,
-                    payload: event.payload,
-                },
-            ];
-            break;
-        case "clickPromotion":
-            events = [
-                {
-                    eventName,
-                    payload: event.payload,
-                },
-            ];
-            break;
-        case "paginationChange":
-            events = [
-                {
-                    eventName,
-                    payload: event.payload,
-                },
-            ];
-            break;
-        case "sortChange":
-            events = [
-                {
-                    eventName,
-                    payload: event.payload,
-                },
-            ];
-            break;
-        case "filterChange":
-            events = [
-                {
-                    eventName,
-                    payload: event.payload,
-                },
-            ];
-            break;
-    }
-    return events;
-}

package/dist/hooks/useCollection.d.ts

@@ -1 +0,0 @@
-export declare const useCollection: () => import("../provider").Collection | undefined;

package/dist/hooks/useCollection.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useCollection = void 0;
-const provider_1 = require("../provider");
-const useCollection = () => (0, provider_1.useContext)().collection;
-exports.useCollection = useCollection;

package/dist/hooks/useConfig.d.ts

@@ -1 +0,0 @@
-export declare const useConfig: () => import("..").Config;

package/dist/hooks/useConfig.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useConfig = void 0;
-const provider_1 = require("../provider");
-const useConfig = () => (0, provider_1.useContext)().config;
-exports.useConfig = useConfig;

package/dist/hooks/useCuration.d.ts

@@ -1 +0,0 @@
-export declare const useCuration: () => import("..").ConfigCuration | undefined;

package/dist/hooks/useCuration.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useCuration = void 0;
-const provider_1 = require("../provider");
-const useCuration = () => (0, provider_1.useContext)().curation;
-exports.useCuration = useCuration;

package/dist/hooks/useFilterCollapsedState.d.ts

@@ -1,8 +0,0 @@
-import { ConfigFilterOption } from "../types/config";
-export declare const useFilterCollapsedState: (filter: ConfigFilterOption) => {
-    collapsed: boolean;
-    shouldRender: boolean;
-    collapsedShow: () => void;
-    collapsedHide: () => void;
-    collapsedToggle: () => void;
-};

package/dist/hooks/useFilterCollapsedState.js

@@ -1,27 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useFilterCollapsedState = void 0;
-const react_1 = __importDefault(require("react"));
-const useFilterCollapsedState = (filter) => {
-    // @todo use settingsCollapsedDesktop and settingsCollapsedMobile with device detection
-    const [collapsed, setCollapsed] = react_1.default.useState(filter.settingsCollapsedDesktop);
-    // when the filter is shown, it needs to stay rendered or when it's collapsed, the filter context
-    // will be lost which isn't expected behaviour
-    const [shouldRender, setShouldRender] = react_1.default.useState(!collapsed);
-    // enable render when filter is uncollapsed
-    react_1.default.useEffect(() => {
-        if (!collapsed)
-            setShouldRender(true);
-    }, [collapsed]);
-    return {
-        collapsed,
-        shouldRender,
-        collapsedShow: react_1.default.useCallback(() => setCollapsed(true), []),
-        collapsedHide: react_1.default.useCallback(() => setCollapsed(false), []),
-        collapsedToggle: react_1.default.useCallback(() => setCollapsed((collapsed) => !collapsed), []),
-    };
-};
-exports.useFilterCollapsedState = useFilterCollapsedState;

package/dist/hooks/useFilterListProps.d.ts

@@ -1,22 +0,0 @@
-import { ConfigFilterOption } from "../types/config";
-import { ReactivesearchFilterProps } from "../types/reactivesearch";
-export declare const useFilterListProps: (filter: ConfigFilterOption, reactivesearchFilterProps: ReactivesearchFilterProps) => {
-    filter: ConfigFilterOption;
-    options: {
-        checked: boolean;
-        doc_count: number;
-        key: string;
-    }[];
-    hasSelected: boolean;
-    totalSelected: number;
-    loading: boolean;
-    error: Error | null;
-    handleChange: (value: string) => void;
-    data: {
-        doc_count: number;
-        key: string;
-    }[];
-    value: string | {
-        [key: string]: boolean;
-    };
-};

package/dist/hooks/useFilterListProps.js

@@ -1,35 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useFilterListProps = void 0;
-const react_1 = __importDefault(require("react"));
-// converts reactivesearch props returned in filters to a cleaned up/filtered version
-const useFilterListProps = (filter, reactivesearchFilterProps) => {
-    return react_1.default.useMemo(() => {
-        const { data, value } = reactivesearchFilterProps;
-        // remove excluded options, sort alphabeticaly, map checked boolean
-        const options = data
-            .filter(({ key }) => {
-            var _a, _b;
-            if ((_a = filter.valuesExclude) === null || _a === void 0 ? void 0 : _a.includes(key))
-                return false;
-            if (!!((_b = filter.valuesManual) === null || _b === void 0 ? void 0 : _b.length) && !filter.valuesManual.includes(key))
-                return false;
-            return true;
-        })
-            .sort((a, b) => a.key.localeCompare(b.key))
-            .map((option) => (Object.assign(Object.assign({}, option), { checked: (typeof value === "object" && value[option.key]) ||
-                value === option.key })));
-        // work out if at least one option selected
-        const hasSelected = (typeof value === "object" && 0 < Object.keys(value).length) ||
-            (typeof value !== "object" && !!value);
-        const totalSelected = options.filter((option) => option.checked).length;
-        return Object.assign(Object.assign({}, reactivesearchFilterProps), { filter,
-            options,
-            hasSelected,
-            totalSelected });
-    }, [filter, reactivesearchFilterProps]);
-};
-exports.useFilterListProps = useFilterListProps;

package/dist/hooks/useFilterStack.d.ts

@@ -1 +0,0 @@
-export declare const useFilterStack: () => import("..").ConfigFilter | undefined;

package/dist/hooks/useFilterStack.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useFilterStack = void 0;
-const provider_1 = require("../provider");
-const useFilterStack = () => (0, provider_1.useContext)().filterStack;
-exports.useFilterStack = useFilterStack;

package/dist/hooks/useFilters.d.ts

@@ -1 +0,0 @@
-export declare const useFilters: () => Omit<import("../types/firestore").FilterOption, "enabled">[];

package/dist/hooks/useFilters.js

@@ -1,17 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useFilters = void 0;
-const react_1 = __importDefault(require("react"));
-const useFilterStack_1 = require("./useFilterStack");
-const useFilters = () => {
-    const filterStack = (0, useFilterStack_1.useFilterStack)();
-    return react_1.default.useMemo(() => {
-        if (!filterStack)
-            return [];
-        return filterStack.options.sort((a, b) => a.position > b.position ? 1 : -1);
-    }, [filterStack]);
-};
-exports.useFilters = useFilters;

package/dist/hooks/useLiveConfig.d.ts

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

package/dist/hooks/useLiveConfig.js

@@ -1,74 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useLiveConfig = void 0;
-const react_1 = __importDefault(require("react"));
-const debug = require("debug")("reactify-search:useLiveConfig");
-// 5 minute cache expiry
-const CACHE_EXPIRY = 5 * 60 * 1000;
-// synchronously returns cached and non-expired config from session storage
-function getCachedConfig() {
-    var _a;
-    if (typeof window === "undefined") {
-        return;
-    }
-    // skip checking cache if url search param "nocache" is set
-    const skipCache = new URLSearchParams(window.location.href.split("?")[1]).get("nocache") !==
-        null;
-    if (skipCache) {
-        debug("skipping cache");
-        return;
-    }
-    const sessionConfig = JSON.parse((_a = window.sessionStorage.getItem("reactify-search:config")) !== null && _a !== void 0 ? _a : "null");
-    if (sessionConfig) {
-        const sessionConfigTtl = sessionConfig.expiresAt - Date.now();
-        debug(`found ${sessionConfigTtl > 0 ? "cached" : "expired"} config`);
-        if (sessionConfigTtl > 0) {
-            debug(`config expires in ${(sessionConfigTtl / 1000).toFixed()} seconds`);
-            return sessionConfig.config;
-        }
-    }
-    return;
-}
-const useLiveConfig = (shopifyPermanentDomain, configId) => {
-    const [config, setConfig] = react_1.default.useState(getCachedConfig());
-    react_1.default.useEffect(() => {
-        const cachedConfig = getCachedConfig();
-        if (cachedConfig)
-            return;
-        (() => __awaiter(void 0, void 0, void 0, function* () {
-            debug("fetching fresh config");
-            const searchParams = new URLSearchParams();
-            searchParams.set("shop", shopifyPermanentDomain);
-            if (configId) {
-                searchParams.set("id", configId);
-            }
-            const skipCache = new URLSearchParams(window.location.href.split("?")[1]).get("nocache") !== null;
-            if (skipCache) {
-                searchParams.set("nocache", "true");
-            }
-            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,
-                noCache: skipCache,
-                config: json.body,
-            }));
-        }))();
-    }, [shopifyPermanentDomain, configId]);
-    return {
-        config,
-    };
-};
-exports.useLiveConfig = useLiveConfig;

package/dist/hooks/usePages.d.ts

@@ -1,10 +0,0 @@
-import { ReactivesearchPaginationProps } from "../types/reactivesearch";
-export declare const usePages: (props: ReactivesearchPaginationProps) => {
-    pagesToShow: number[];
-    hasNextPage: boolean;
-    buildPagePath: (page: number) => string;
-    handleNextPage: (event?: any) => void;
-    hasPreviousPage: boolean;
-    actualCurrentPage: number;
-    handlePreviousPage: (event?: any) => void;
-};