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

package/dist/sensor/SensorPublished.d.ts

@@ -1,2 +0,0 @@
-import React from "react";
-export declare const SensorPublished: React.FC;

package/dist/sensor/SensorPublished.js

@@ -1,16 +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.SensorPublished = void 0;
-const react_1 = __importDefault(require("react"));
-const ReactiveComponent_1 = __importDefault(require("@appbaseio/reactivesearch/lib/components/basic/ReactiveComponent"));
-const SensorPublished = () => (react_1.default.createElement(ReactiveComponent_1.default, { componentId: "SensorPublished", customQuery: () => ({
-        query: {
-            match: {
-                published: true,
-            },
-        },
-    }) }));
-exports.SensorPublished = SensorPublished;

package/dist/sensor/SensorSearch.d.ts

@@ -1,2 +0,0 @@
-import React from "react";
-export declare const SensorSearch: React.FC;

package/dist/sensor/SensorSearch.js

@@ -1,82 +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.SensorSearch = void 0;
-const react_1 = __importDefault(require("react"));
-const DataSearch_1 = __importDefault(require("@appbaseio/reactivesearch/lib/components/search/DataSearch"));
-const hooks_1 = require("../hooks");
-const SensorSearch = () => {
-    const { fields } = (0, hooks_1.useConfig)();
-    const { searchQuery } = (0, hooks_1.useSearch)();
-    // ignore search fields only set for instant search
-    const searchFields = react_1.default.useMemo(() => fields.filter((field) => ["always_search", "search_page"].includes(field.searchType)), [fields]);
-    if (!searchQuery || !searchFields.length) {
-        return null;
-    }
-    return (react_1.default.createElement(react_1.default.Fragment, null,
-        react_1.default.createElement(DataSearch_1.default, { fuzziness: 1, queryFormat: "and", autosuggest: false, value: searchQuery, componentId: "SensorSearch", style: { display: "none" }, dataField: searchFields.map((field) => field.field), fieldWeights: searchFields.map((field) => field.importance), customQuery: (value, props) => {
-                const { dataField, fieldWeights } = props;
-                const fieldsCrossFields = dataField.map((field, index) => `${field}^${fieldWeights[index]}`);
-                const fieldsPhrase = dataField.map((field, index) => `${field}^${fieldWeights[index]}`);
-                const fieldsPhrasePrefix = dataField
-                    .filter((field) => !field.includes("."))
-                    .map((field, index) => `${field}^${fieldWeights[index]}`);
-                const query = {
-                    bool: {
-                        should: [
-                            {
-                                nested: {
-                                    path: "curations",
-                                    query: {
-                                        term: {
-                                            "curations.searchTerm.keyword": value === null || value === void 0 ? void 0 : value.toLowerCase(),
-                                        },
-                                    },
-                                },
-                            },
-                            ...(fieldsCrossFields.length > 0
-                                ? [
-                                    {
-                                        multi_match: {
-                                            query: value,
-                                            fields: fieldsCrossFields,
-                                            type: "cross_fields",
-                                            operator: "and",
-                                        },
-                                    },
-                                ]
-                                : []),
-                            ...(fieldsPhrase.length > 0
-                                ? [
-                                    {
-                                        multi_match: {
-                                            query: value,
-                                            fields: fieldsPhrase,
-                                            type: "phrase",
-                                            operator: "and",
-                                        },
-                                    },
-                                ]
-                                : []),
-                            ...(fieldsPhrasePrefix.length > 0
-                                ? [
-                                    {
-                                        multi_match: {
-                                            query: value,
-                                            fields: fieldsPhrasePrefix,
-                                            type: "phrase_prefix",
-                                            operator: "and",
-                                        },
-                                    },
-                                ]
-                                : []),
-                        ],
-                        minimum_should_match: "1",
-                    },
-                };
-                return { query };
-            } })));
-};
-exports.SensorSearch = SensorSearch;

package/dist/sensor/SensorSort.d.ts

@@ -1,2 +0,0 @@
-import React from "react";
-export declare const SensorSort: React.FC;

package/dist/sensor/SensorSort.js

@@ -1,205 +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.SensorSort = void 0;
-const react_1 = __importDefault(require("react"));
-const ReactiveComponent_1 = __importDefault(require("@appbaseio/reactivesearch/lib/components/basic/ReactiveComponent"));
-const hooks_1 = require("../hooks");
-const debug = require("debug")("reactify-search:SensorSort");
-const SensorSort = () => {
-    const config = (0, hooks_1.useConfig)();
-    const curation = (0, hooks_1.useCuration)();
-    const collection = (0, hooks_1.useCollection)();
-    const globalCuration = (curation === null || curation === void 0 ? void 0 : curation.id) === "global";
-    const { sortOption } = (0, hooks_1.useSort)();
-    const searchQuery = react_1.default.useMemo(() => {
-        if (typeof window === "undefined")
-            return "";
-        const urlParams = new URLSearchParams(window.location.search);
-        return urlParams.get("q") || "";
-    }, []);
-    const { sort, query } = react_1.default.useMemo(() => {
-        return {
-            sort: buildSort({
-                config,
-                sortOption,
-                collection,
-                curation,
-                globalCuration,
-            }),
-            query: buildQuery({
-                sortOption,
-                curation,
-                globalCuration,
-            }),
-        };
-    }, [config, sortOption, curation]);
-    react_1.default.useEffect(() => {
-        debug("searchQuery", searchQuery);
-        debug("sort", sort);
-        debug("query", query);
-    }, [searchQuery, sort]);
-    return (react_1.default.createElement(ReactiveComponent_1.default, { componentId: "SensorSort", customQuery: () => ({
-            sort,
-            query,
-        }) }));
-};
-exports.SensorSort = SensorSort;
-const buildSort = (args) => {
-    var _a;
-    const { config, curation, sortOption, collection, globalCuration } = args;
-    debug("buildSortQuery.start", {
-        config,
-        curation,
-        sortOption,
-    });
-    // return default sort option if unset
-    if (!sortOption) {
-        return collection
-            ? mapCollectionPositionSortClause(collection)
-            : ["_score"];
-    }
-    // curation positions are only applied for the default `collections.position` or `_score` sort
-    // if the sort is something else, apply a normal sort which applies what the user has requested
-    if (!["_score", "collections.position"].includes(sortOption.field)) {
-        return [{ [sortOption.field]: sortOption.direction }];
-    }
-    // no matching curation, return default sort clause
-    if (!curation) {
-        return collection
-            ? mapCollectionPositionSortClause(collection)
-            : ["_score"];
-    }
-    const sorts = [];
-    // show pins first
-    if (globalCuration && collection) {
-        sorts.push(...mapCollectionPositionSortClause(collection));
-    }
-    else {
-        sorts.push({
-            "curations.position": {
-                unmapped_type: "long",
-                order: "asc",
-                nested: {
-                    path: "curations",
-                    filter: {
-                        term: {
-                            [`curations.${"collection" === curation.type
-                                ? "collectionHandle"
-                                : "searchTerm"}.keyword`]: "collection" === curation.type
-                                ? curation.collectionHandle
-                                : (_a = curation.searchTerm) === null || _a === void 0 ? void 0 : _a.toLowerCase(),
-                        },
-                    },
-                },
-            },
-        });
-    }
-    if (0 < curation.boosting.groupings.length) {
-        const groupings = curation.boosting.groupings.sort((a, b) => a.position > b.position ? 1 : -1);
-        for (const grouping of groupings) {
-            try {
-                const query = JSON.parse(grouping.query);
-                if (query)
-                    sorts.push(query);
-            }
-            catch (_b) {
-                console.error(`query could not be parsed for boost grouping`, grouping);
-            }
-        }
-    }
-    if (0 < curation.boosting.sortings.length) {
-        const sortings = curation.boosting.sortings.sort((a, b) => a.position > b.position ? 1 : -1);
-        for (const sorting of sortings) {
-            try {
-                const query = JSON.parse(sorting.query);
-                if (query)
-                    sorts.push(query);
-            }
-            catch (_c) {
-                console.error(`query could not be parsed for boost sorting`, sorting);
-            }
-        }
-    }
-    // finally, for collections, if no other sorting is defined, sort by index order to provide
-    // a consistent order
-    if ("collection" === curation.type && sorts.length === 0) {
-        sorts.push("_doc");
-    }
-    // finally, for search, sort by score
-    if ("search" === curation.type) {
-        sorts.push("_score");
-    }
-    return sorts;
-};
-/**
- * Return a sort clause which sorts by position within the given collection.
- */
-function mapCollectionPositionSortClause(collection) {
-    return [
-        {
-            "collections.position": {
-                order: "asc",
-                nested: {
-                    path: "collections",
-                    filter: {
-                        term: {
-                            "collections.handle.keyword": collection.handle,
-                        },
-                    },
-                },
-            },
-        },
-    ];
-}
-const buildQuery = (args) => {
-    var _a;
-    const { curation, sortOption, globalCuration } = args;
-    if (!curation || globalCuration) {
-        return undefined;
-    }
-    return {
-        bool: {
-            must_not: [
-                {
-                    nested: {
-                        path: "curations",
-                        query: {
-                            bool: {
-                                must: [
-                                    {
-                                        term: {
-                                            [`curations.${"collection" === curation.type
-                                                ? "collectionHandle"
-                                                : "searchTerm"}.keyword`]: "collection" === curation.type
-                                                ? curation.collectionHandle
-                                                : (_a = curation.searchTerm) === null || _a === void 0 ? void 0 : _a.toLowerCase(),
-                                        },
-                                    },
-                                    {
-                                        term: {
-                                            "curations.hidden": true,
-                                        },
-                                    },
-                                ],
-                            },
-                        },
-                    },
-                },
-                // hide callout when not sorting by _score or collections.position
-                ...(sortOption &&
-                    !["_score", "collections.position"].includes(sortOption.field)
-                    ? [
-                        {
-                            term: {
-                                type: "callout",
-                            },
-                        },
-                    ]
-                    : []),
-            ],
-        },
-    };
-};

package/dist/sensor/SensorSortScore.d.ts

@@ -1,2 +0,0 @@
-import React from "react";
-export declare const SensorSortScore: React.FC;

package/dist/sensor/SensorSortScore.js

@@ -1,12 +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.SensorSortScore = void 0;
-const react_1 = __importDefault(require("react"));
-const ReactiveComponent_1 = __importDefault(require("@appbaseio/reactivesearch/lib/components/basic/ReactiveComponent"));
-const SensorSortScore = () => (react_1.default.createElement(ReactiveComponent_1.default, { componentId: "SensorSortScore", customQuery: () => ({
-        sort: { _score: "desc" },
-    }) }));
-exports.SensorSortScore = SensorSortScore;

package/dist/sensor/SensorStack.d.ts

@@ -1,2 +0,0 @@
-import React from "react";
-export declare const SensorStack: React.FC;

package/dist/sensor/SensorStack.js

@@ -1,31 +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.SensorStack = void 0;
-const react_1 = __importDefault(require("react"));
-const hooks_1 = require("../hooks");
-const SensorSort_1 = require("./SensorSort");
-const SensorSearch_1 = require("./SensorSearch");
-const SensorSortScore_1 = require("./SensorSortScore");
-const SensorPublished_1 = require("./SensorPublished");
-const SensorCollection_1 = require("./SensorCollection");
-const SensorInventoryAvailable_1 = require("./SensorInventoryAvailable");
-const SensorStack = () => {
-    const { instantSearch } = (0, hooks_1.useSearch)();
-    // instant search mode
-    if (instantSearch) {
-        return (react_1.default.createElement(react_1.default.Fragment, null,
-            react_1.default.createElement(SensorPublished_1.SensorPublished, null),
-            react_1.default.createElement(SensorSortScore_1.SensorSortScore, null)));
-    }
-    // result grid mode
-    return (react_1.default.createElement(react_1.default.Fragment, null,
-        react_1.default.createElement(SensorSort_1.SensorSort, null),
-        react_1.default.createElement(SensorSearch_1.SensorSearch, null),
-        react_1.default.createElement(SensorPublished_1.SensorPublished, null),
-        react_1.default.createElement(SensorCollection_1.SensorCollection, null),
-        react_1.default.createElement(SensorInventoryAvailable_1.SensorInventoryAvailable, null)));
-};
-exports.SensorStack = SensorStack;

package/dist/sensor/index.d.ts

@@ -1,8 +0,0 @@
-export * from "./SensorSort";
-export * from "./SensorSearch";
-export * from "./SensorPublished";
-export * from "./SensorSortScore";
-export * from "./SensorCollection";
-export * from "./SensorInventoryAvailable";
-export * from "./SensorStack";
-export declare const SENSOR_IDS: string[];

package/dist/sensor/index.js

@@ -1,29 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SENSOR_IDS = void 0;
-__exportStar(require("./SensorSort"), exports);
-__exportStar(require("./SensorSearch"), exports);
-__exportStar(require("./SensorPublished"), exports);
-__exportStar(require("./SensorSortScore"), exports);
-__exportStar(require("./SensorCollection"), exports);
-__exportStar(require("./SensorInventoryAvailable"), exports);
-__exportStar(require("./SensorStack"), exports);
-// this is consumed by the react prop in various components
-exports.SENSOR_IDS = [
-    "SensorSort",
-    "SensorSearch",
-    "SensorSortScore",
-    "SensorPublished",
-    "SensorCollection",
-    "SensorInventoryAvailable",
-];

package/dist/types/config.d.ts

@@ -1,25 +0,0 @@
-import { Sort, Filter, FilterOption, Redirect, Field, Curation } from "./firestore";
-export interface Config {
-    sort: ConfigSort[];
-    fields: ConfigField[];
-    filters: ConfigFilter[];
-    redirects: ConfigRedirect[];
-    curations: ConfigCuration[];
-}
-export declare type ConfigSort = Omit<Sort, "enabled">;
-export declare type ConfigField = Omit<Field, "enabled">;
-export declare type ConfigRedirect = Omit<Redirect, "enabled" | "keywords">;
-export declare type ConfigFilter = Omit<Filter, "enabled" | "keywords"> & {
-    options: Omit<FilterOption, "enabled">[];
-};
-export declare type ConfigFilterOption = Omit<FilterOption, "enabled">;
-export declare type ConfigCuration = Omit<Curation, "keywords" | "boosting" | "longRunningTask" | "callouts"> & {
-    boosting: {
-        groupings: (NonNullable<NonNullable<Curation["boosting"]>["groupings"]>[0] & {
-            query: string;
-        })[];
-        sortings: (NonNullable<NonNullable<Curation["boosting"]>["sortings"]>[0] & {
-            query: string;
-        })[];
-    };
-};

package/dist/types/config.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/elastic.d.ts

@@ -1,209 +0,0 @@
-import { Callout } from "./firestore";
-import { Maybe, ProductVariantInventoryPolicy, MetafieldValueType } from "./graphql";
-export declare enum ElasticDocumentType {
-    Callout = "callout",
-    Product = "product"
-}
-export declare type ElasticDocument = ElasticCallout | ElasticProduct;
-export interface ElasticCallout {
-    type: ElasticDocumentType.Callout;
-    key: string;
-    callout: Omit<Callout, "keywords">;
-    /** elastic callouts are always published */
-    published: true;
-    /** elastic callouts are always attached to one curation */
-    curations: [ElasticCuration];
-}
-export interface ElasticProduct {
-    type: ElasticDocumentType.Product;
-    /** the log id from which this product was last uploaded */
-    lastLogId: string;
-    /** legacy resource id */
-    id: number;
-    storefrontId: string;
-    title: string;
-    description: string;
-    vendor: string;
-    product_type: string;
-    handle: string;
-    url: string;
-    tags: string[];
-    collection_titles: string[];
-    /** tag prefixes defined in tagKeys are split to their own attributes */
-    [key: `tags_${string}`]: string[] | undefined;
-    /** decimal number e.g. 99.95 */
-    price_min: number;
-    /** decimal number e.g. 99.95 */
-    price_max: number;
-    /** array of option names e.g. ["Colour", "Size"] */
-    options: string[];
-    /** @todo it would be better to use ProductStatus directly, which has uppercase */
-    status: "active" | "archived" | "draft";
-    published: boolean;
-    /** ISO 8601 datetime */
-    published_at: Maybe<string>;
-    /** ISO 8601 datetime */
-    updated_at: string;
-    /** ISO 8601 datetime */
-    created_at: string;
-    tracks_inventory: boolean;
-    /** originalSrc URL for featured image */
-    image: Maybe<string>;
-    /** array of images (undefined if images are disabled in sync settings) */
-    images?: ElasticImage[];
-    /** array of variants attached to product (undefined if variants are disabled in sync settings) */
-    variants?: ElasticVariant[];
-    /** price ranges from presentment prices (undefined if presentment prices or variants are disabled in sync settings) */
-    presentment_price_ranges?: {
-        min_variant_price: ElasticPresentmentPrice[];
-        max_variant_price: ElasticPresentmentPrice[];
-    };
-    /** array of variant skus (undefined if variants are disabled in sync settings) */
-    variant_skus?: string[];
-    /** combined array of option values from all option types (undefined if variants are disabled in sync settings) */
-    variant_options?: string[];
-    /** array of collections which this product belongs to (undefined if collections are disabled in sync settings) */
-    collections?: ElasticCollection[];
-    /** array of whitelisted metafields (undefined if metafields are disabled in sync settings) */
-    metafields?: ElasticMetafield[];
-    /** decimal number e.g. 99.95 (undefined if variants are disabled in sync settings) */
-    discount_amount?: number;
-    /** combined inventory for all variants (undefined if variants are disabled in sync settings) */
-    inventory_total?: number;
-    /** number of days since published, null if unpublished */
-    published_days: Maybe<number>;
-    /** collection of curations that this product is attached to */
-    curations?: ElasticCuration[];
-}
-export interface ElasticVariant {
-    /** legacy resource id */
-    id: number;
-    storefrontId: string;
-    title: string;
-    sku: Maybe<string>;
-    barcode: Maybe<string>;
-    /** array of presentment prices (undefined if presentment prices are disabled in sync settings) */
-    presentment_prices?: {
-        price: ElasticPresentmentPrice;
-        compare_at_price: Maybe<ElasticPresentmentPrice>;
-    }[];
-    /** decimal number e.g. 99.95 */
-    price: number;
-    /** decimal number e.g. 99.95 */
-    compare_at_price: Maybe<number>;
-    /** value string for option 1 e.g. Blue */
-    option1: Maybe<string>;
-    /** value string for option 2 e.g. Medium */
-    option2: Maybe<string>;
-    /** value string for option 3 */
-    option3: Maybe<string>;
-    /** sort position within the product */
-    position: number;
-    inventory_policy: ProductVariantInventoryPolicy;
-    inventory_quantity: number;
-    available: boolean;
-    /** array of images (only available if this variant has been merged from another product and if images are enabled in sync settings) */
-    images?: ElasticImage[];
-}
-export interface ElasticCollection {
-    /** legacy resource id */
-    id: number;
-    storefrontId: string;
-    handle: string;
-    title: string;
-    position: number;
-}
-export interface ElasticMetafield {
-    key: string;
-    type: string;
-    value: string;
-    namespace: string;
-    /**
-     * Legacy valueType attribute which is no longer provided by Shopify. We still
-     * populate this field to prevent any frontends breaking which rely on it.
-     *
-     * @see https://shopify.dev/apps/metafields/definitions/types
-     */
-    value_type: MetafieldValueType;
-}
-export interface ElasticPresentmentPrice {
-    /** decimal number e.g. 99.95 */
-    amount: number;
-    currency_code: string;
-}
-export interface ElasticImage {
-    /** originalSrc URL */
-    src: string;
-    /** alt text */
-    alt: Maybe<string>;
-}
-export interface ElasticCuration {
-    id: string;
-    hidden: boolean;
-    position?: number;
-    searchTerm?: string;
-    collectionHandle?: string;
-}
-export declare type ElasticBulkOperationUpdate = [
-    {
-        update: {
-            _index: string;
-            _id: string;
-        };
-    },
-    {
-        script?: {
-            lang: "painless";
-            source: string;
-            params?: Record<string, any>;
-        };
-        upsert?: Partial<ElasticProduct>;
-        scripted_upsert?: true;
-        doc?: Partial<ElasticProduct>;
-        doc_as_upsert?: true;
-    }
-];
-export declare type ElasticBulkOperationIndex = [
-    {
-        index: {
-            _index: string;
-            _id: string;
-        };
-    },
-    ElasticDocument
-];
-export declare type ElasticBulkOperation = ElasticBulkOperationUpdate | ElasticBulkOperationIndex;
-export declare type ElasticSearchResult<T = ElasticDocument> = {
-    hits: {
-        hits: ElasticHit<T>[];
-    };
-};
-export declare type ElasticHit<T = ElasticDocument> = {
-    _id: string;
-    _source: T;
-    _score: number | null;
-};
-export declare enum ElasticDataType {
-    Text = "text",
-    Long = "long",
-    Date = "date",
-    Float = "float",
-    Nested = "nested",
-    Keyword = "keyword",
-    Boolean = "boolean"
-}
-export interface ElasticProperty {
-    analyzer?: string;
-    type: ElasticDataType;
-    ignore_above?: number;
-    fields?: {
-        [key: string]: ElasticField;
-    };
-    properties?: {
-        [key: string]: ElasticProperty;
-    };
-}
-export interface ElasticField {
-    type: ElasticDataType;
-    ignore_above?: number;
-}

package/dist/types/elastic.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ElasticDataType = exports.ElasticDocumentType = void 0;
-var ElasticDocumentType;
-(function (ElasticDocumentType) {
-    ElasticDocumentType["Callout"] = "callout";
-    ElasticDocumentType["Product"] = "product";
-})(ElasticDocumentType = exports.ElasticDocumentType || (exports.ElasticDocumentType = {}));
-var ElasticDataType;
-(function (ElasticDataType) {
-    ElasticDataType["Text"] = "text";
-    ElasticDataType["Long"] = "long";
-    ElasticDataType["Date"] = "date";
-    ElasticDataType["Float"] = "float";
-    ElasticDataType["Nested"] = "nested";
-    ElasticDataType["Keyword"] = "keyword";
-    ElasticDataType["Boolean"] = "boolean";
-})(ElasticDataType = exports.ElasticDataType || (exports.ElasticDataType = {}));