@usereactify/search 5.0.0-beta.1 → 5.0.0-beta.4

package/dist/src/hooks/useSearch.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSearch = void 0;
+const react_1 = __importDefault(require("react"));
+const hooks_1 = require("../hooks");
+const useSearch = () => {
+    const { options, config, search } = (0, hooks_1.useReactifySearchContext)();
+    const handleSubmitSearch = react_1.default.useCallback((localSearchQuery) => {
+        const actualSearchQuery = localSearchQuery !== null && localSearchQuery !== void 0 ? localSearchQuery : search.searchQuery;
+        if (!actualSearchQuery)
+            return;
+        const redirect = config.redirects.find((redirect) => redirect.query.trim().toLowerCase() ===
+            actualSearchQuery.trim().toLowerCase());
+        search.setInstantSearchVisible(false);
+        if (options.onRedirect) {
+            options.onRedirect(redirect ? "redirect" : "search", redirect ? redirect.url : `/search?q=${actualSearchQuery}`);
+        }
+        else if (redirect) {
+            window.location.href = redirect.url;
+        }
+        else {
+            window.location.href = `/search?q=${actualSearchQuery}`;
+        }
+    }, [search.searchQuery]);
+    return {
+        searchQuery: search.searchQuery,
+        setSearchQuery: search.setSearchQuery,
+        submitSearch: handleSubmitSearch,
+        showInstantSearchResults: !!search.instantSearchVisible && !!search.searchQuery,
+        setShowInstantSearchResults: search.setInstantSearchVisible,
+    };
+};
+exports.useSearch = useSearch;
+//# sourceMappingURL=useSearch.js.map

package/dist/src/hooks/useSearch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSearch.js","sourceRoot":"","sources":["../../../src/hooks/useSearch.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAE1B,oCAAoD;AAE7C,MAAM,SAAS,GAAG,GAAG,EAAE;IAC5B,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAA,gCAAwB,GAAE,CAAC;IAE/D,MAAM,kBAAkB,GAAG,eAAK,CAAC,WAAW,CAAC,CAAC,gBAAyB,EAAE,EAAE;QACzE,MAAM,iBAAiB,GAAG,gBAAgB,aAAhB,gBAAgB,cAAhB,gBAAgB,GAAI,MAAM,CAAC,WAAW,CAAC;QACjE,IAAI,CAAC,iBAAiB;YAAE,OAAO;QAE/B,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,CACpC,CAAC,QAAQ,EAAE,EAAE,CACX,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,iBAAiB,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CACzC,CAAC;QAEF,MAAM,CAAC,uBAAuB,CAAC,KAAK,CAAC,CAAC;QAEtC,IAAI,OAAO,CAAC,UAAU,EAAE;YACtB,OAAO,CAAC,UAAU,CAChB,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,EAChC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,iBAAiB,EAAE,CAC3D,CAAC;SACH;aAAM,IAAI,QAAQ,EAAE;YACnB,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC;SACrC;aAAM;YACL,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,aAAa,iBAAiB,EAAE,CAAC;SACzD;IACH,CAAC,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;IAEzB,OAAO;QACL,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,YAAY,EAAE,kBAAkB;QAChC,wBAAwB,EAAE,CAAC,CAAC,MAAM,CAAC,oBAAoB,IAAI,CAAC,CAAC,MAAM,CAAC,WAAW;QAC/E,2BAA2B,EAAE,MAAM,CAAC,uBAAuB;KAC5D,CAAC;AACJ,CAAC,CAAC;AAlCW,QAAA,SAAS,aAkCpB"}

package/dist/src/hooks/useSortby.d.ts

@@ -0,0 +1,6 @@
+import { ConfigSort } from "../types";
+export declare const useSortby: () => {
+    sortOption: ConfigSort | undefined;
+    sortOptions: Array<ConfigSort>;
+    setSortOption: (sortOptionHandle: string, ignoreHistoryState?: boolean | undefined) => void;
+};

package/dist/src/hooks/useSortby.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSortby = void 0;
+const react_1 = __importDefault(require("react"));
+const hooks_1 = require("../hooks");
+const useSortby = () => {
+    const { options, config, sortby } = (0, hooks_1.useReactifySearchContext)();
+    const { track } = (0, hooks_1.useAnalytics)();
+    const sortOptions = react_1.default.useMemo(() => {
+        return config.sort
+            .sort((a, b) => `${a.position}`.localeCompare(`${b.position}`))
+            .filter(({ visibility }) => ["all", options.mode].includes(visibility));
+    }, [options.mode, config]);
+    const sortOption = react_1.default.useMemo(() => sortOptions.find(({ handle }) => handle === sortby.sortOption) ||
+        sortOptions[0], [sortOptions, sortby.sortOption]);
+    const setSortOption = react_1.default.useCallback((sortOptionHandle, ignoreHistoryState = false) => {
+        sortby.setSortOption(sortOptionHandle);
+        if (!ignoreHistoryState) {
+            const url = new URL(window.location.href);
+            url.searchParams.has("sort")
+                ? url.searchParams.set("sort", sortOptionHandle)
+                : url.searchParams.append("sort", sortOptionHandle);
+            window.history.pushState({}, "", url.toString());
+        }
+        track({
+            eventName: "sortChange",
+            payload: {
+                type: sortOptionHandle,
+            },
+        });
+    }, [window.location.href]);
+    return {
+        sortOptions,
+        sortOption,
+        setSortOption,
+    };
+};
+exports.useSortby = useSortby;
+//# sourceMappingURL=useSortby.js.map

package/dist/src/hooks/useSortby.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSortby.js","sourceRoot":"","sources":["../../../src/hooks/useSortby.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAG1B,oCAAkE;AAE3D,MAAM,SAAS,GAAG,GAIvB,EAAE;IACF,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAA,gCAAwB,GAAE,CAAC;IAC/D,MAAM,EAAE,KAAK,EAAE,GAAG,IAAA,oBAAY,GAAE,CAAC;IAEjC,MAAM,WAAW,GAAG,eAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QACrC,OAAO,MAAM,CAAC,IAAI;aACf,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;aAC9D,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;IAC5E,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IAE3B,MAAM,UAAU,GAAG,eAAK,CAAC,OAAO,CAC9B,GAAG,EAAE,CACH,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,KAAK,MAAM,CAAC,UAAU,CAAC;QAC9D,WAAW,CAAC,CAAC,CAAC,EAChB,CAAC,WAAW,EAAE,MAAM,CAAC,UAAU,CAAC,CACjC,CAAC;IAEF,MAAM,aAAa,GAAG,eAAK,CAAC,WAAW,CACrC,CAAC,gBAAwB,EAAE,kBAAkB,GAAG,KAAK,EAAE,EAAE;QACvD,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;QACvC,IAAI,CAAC,kBAAkB,EAAE;YACvB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC1C,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC;gBAC1B,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC;gBAChD,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;YACtD,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;SAClD;QAED,KAAK,CAAC;YACJ,SAAS,EAAE,YAAY;YACvB,OAAO,EAAE;gBACP,IAAI,EAAE,gBAAgB;aACvB;SACF,CAAC,CAAC;IACL,CAAC,EACD,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CACvB,CAAC;IAEF,OAAO;QACL,WAAW;QACX,UAAU;QACV,aAAa;KACd,CAAC;AACJ,CAAC,CAAC;AA/CW,QAAA,SAAS,aA+CpB"}

package/dist/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./components";
+export * from "./hooks";
+export * from "./types";

package/dist/src/index.js

@@ -0,0 +1,19 @@
+"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 });
+__exportStar(require("./components"), exports);
+__exportStar(require("./hooks"), exports);
+__exportStar(require("./types"), exports);
+const package_json_1 = require("../package.json");
+const debug = require("debug")("reactify-search:");
+debug(`${package_json_1.name} v${package_json_1.version}`);
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+CAA6B;AAC7B,0CAAwB;AACxB,0CAAwB;AAExB,kDAAgD;AAChD,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,kBAAkB,CAAC,CAAC;AAEnD,KAAK,CAAC,GAAG,mBAAI,KAAK,sBAAO,EAAE,CAAC,CAAC"}

package/dist/src/types/config.d.ts

@@ -0,0 +1,26 @@
+import { Sort, Filter, FilterOption, Redirect, Field, Curation } from "./firestore";
+export interface Config {
+    index: string;
+    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/src/types/config.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=config.js.map

package/dist/src/types/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/types/config.ts"],"names":[],"mappings":""}

package/dist/src/types/elastic.d.ts

@@ -0,0 +1,209 @@
+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/src/types/elastic.js

@@ -0,0 +1,19 @@
+"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 = {}));
+//# sourceMappingURL=elastic.js.map

package/dist/src/types/elastic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"elastic.js","sourceRoot":"","sources":["../../../src/types/elastic.ts"],"names":[],"mappings":";;;AAOA,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,0CAAmB,CAAA;AACrB,CAAC,EAHW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAG9B;AA6LD,IAAY,eAQX;AARD,WAAY,eAAe;IACzB,gCAAa,CAAA;IACb,gCAAa,CAAA;IACb,gCAAa,CAAA;IACb,kCAAe,CAAA;IACf,oCAAiB,CAAA;IACjB,sCAAmB,CAAA;IACnB,sCAAmB,CAAA;AACrB,CAAC,EARW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAQ1B"}

package/dist/src/types/firestore.d.ts

@@ -0,0 +1,280 @@
+declare type Timestamp = string;
+import { ShopifyProduct } from "./shopify";
+import { ElasticDataType } from "./elastic";
+export interface Log {
+    id: string;
+    keywords: string[];
+    message: string;
+    platform: "reactify" | "shopify" | "elastic";
+    percentCompleted: number;
+    action?: {
+        type: "retry";
+        label: string;
+        task: Task["taskId"];
+    };
+    step: "download" | "transform" | "merge" | "upload" | "cleanup" | "complete" | "sync";
+    title: string;
+    type: "bulk";
+    data?: string;
+    progress: "new" | "error" | "complete" | "partiallyComplete";
+    status: "success" | "info" | "warning" | "critical";
+    createdAt: Timestamp;
+    updatedAt?: Timestamp;
+    finishedAt?: Timestamp;
+}
+export interface Task {
+    logId: string;
+    taskId: "download" | "transform" | "merge" | "upload" | "cleanup" | "refreshDefinedFields" | "install";
+    firstRun: boolean;
+    createdAt: Timestamp;
+    updatedAt?: Timestamp;
+}
+export interface TaskDownload extends Task {
+    taskId: "download";
+    type: "collection" | "product";
+    productUrl?: string;
+    collectionUrl?: string;
+}
+export interface TaskTransform extends Task {
+    taskId: "transform";
+    productUrl: string;
+    collectionUrl: string;
+}
+export interface TaskMerge extends Task {
+    taskId: "merge";
+    productCount: number;
+    collectionCount: number;
+    startAfterId?: string;
+}
+export interface TaskUpload extends Task {
+    taskId: "upload";
+    productCount: number;
+    collectionCount: number;
+    startAfterId?: string;
+}
+export interface TaskCleanup extends Task {
+    taskId: "cleanup";
+}
+export interface TaskRefreshDefinedFields extends Task {
+    taskId: "refreshDefinedFields";
+}
+export interface TaskInstall extends Task {
+    taskId: "install";
+}
+export interface Lock {
+    logId: string;
+    taskType: "sync";
+    createdAt: Timestamp;
+}
+export interface SettingsInstance {
+    index: string;
+    cloudId: string;
+    endpoint: string;
+    password: string;
+    username: string;
+    syncFrequency: string;
+    syncThreshold: number;
+    provider: "elastic" | "aws";
+    storefrontAccessToken: string;
+    customMappings: string;
+}
+export interface SettingsProduct {
+    tagChild?: string;
+    tagKeys?: string[];
+    tagParent?: string;
+    syncObjects: string[];
+    tagExclude?: string[];
+    tagSeparator?: string;
+    metafieldWhitelist?: string[];
+}
+export interface SettingsCurations {
+    moreInfo?: boolean;
+    pageSize?: number;
+    gridColumns?: number;
+}
+export interface Field {
+    id: string;
+    field: string;
+    enabled: boolean;
+    importance: number;
+    searchType: "always_search" | "search_page" | "instant_search";
+}
+export interface DefinedField {
+    label: string;
+    value: string;
+    type: ElasticDataType;
+}
+export interface Sort {
+    id: string;
+    name: string;
+    handle: string;
+    field: string;
+    position: number;
+    enabled: boolean;
+    direction: "desc" | "asc";
+    visibility: "all" | "search" | "collection";
+}
+export interface Filter {
+    id: string;
+    name: string;
+    handle: string;
+    enabled: boolean;
+    pageSize: number;
+    keywords: string[];
+    defaultSort: string;
+    collections: string[];
+    type: "search" | "collection";
+    paginationType: "pagination" | "load_more" | "next_prev" | "infinite_scroll";
+    inventoryVisibility: "show_all" | "hide_products" | "hide_variants" | "hide_all";
+}
+export interface FilterOption {
+    displaySize: string;
+    displaySliderInterval: string;
+    displaySliderStep: string;
+    displayType: "multi" | "single" | "range" | "slider";
+    displayView: "list" | "check" | "swatch" | "box";
+    enabled: boolean;
+    field: string;
+    id: string;
+    name: string;
+    handle: string;
+    position: number;
+    settingsCollapsedDesktop: boolean;
+    settingsCollapsedMobile: boolean;
+    settingsShowFilter: boolean;
+    settingsShowMore: boolean;
+    settingsShowSearch: boolean;
+    settingsUppercase: boolean;
+    settingsHideUnavailable: boolean;
+    valuesExclude: Array<string>;
+    valuesManual: Array<string>;
+    valuesShow: "all" | "manual";
+}
+export interface Redirect {
+    id: string;
+    url: string;
+    query: string;
+    enabled: boolean;
+    keywords: string[];
+}
+export interface Curation {
+    id: string;
+    title: string;
+    status: CurationStatus;
+    published: boolean;
+    keywords: string[];
+    searchTerm?: string;
+    longRunningTask?: boolean;
+    collectionHandle?: string;
+    type: "collection" | "search";
+    boosting?: {
+        groupings?: BoostGrouping[];
+        sortings?: BoostSorting[];
+    };
+    sort?: CurationSort;
+}
+export interface CurationSort {
+    sortTag?: string;
+    sortOption: string;
+    sortDirection: "asc" | "desc";
+    sortVariantOption?: "option1" | "option2" | "option3";
+}
+export declare enum CurationStatus {
+    Draft = "draft",
+    Publishing = "publishing",
+    Published = "published",
+    Unpublishing = "unpublishing",
+    Resetting = "resetting",
+    Pinning = "pinning",
+    Sorting = "sorting"
+}
+export interface CurationHiding {
+    productId: number;
+    productHandle: string;
+}
+export interface BoostGrouping {
+    key: string;
+    value: string;
+    field: string;
+    position: number;
+    operation: string;
+}
+export interface BoostSorting {
+    key: string;
+    field: string;
+    query?: string;
+    position: number;
+    direction: "asc" | "desc";
+}
+export declare type Pin = PinProduct | PinCallout;
+export declare enum PinType {
+    Product = "product",
+    Callout = "callout"
+}
+export interface PinProduct {
+    key: string;
+    type: PinType.Product;
+    position: number;
+    productId: number;
+    productHandle: string;
+}
+export interface PinCallout {
+    key: string;
+    type: PinType.Callout;
+    position: number;
+    calloutId: string;
+}
+export interface Callout {
+    id: string;
+    link: string;
+    title: string;
+    content: string;
+    enabled: boolean;
+    textColor: string;
+    keywords: string[];
+    mobileImage: string;
+    mobileVideo: string;
+    desktopVideo: string;
+    desktopImage: string;
+    backgroundColor: string;
+    visibility: "desktop" | "mobile" | "all";
+    displayColumns: string;
+    displayRows: string;
+    selectedDates?: {
+        end: Timestamp;
+        start: Timestamp;
+    };
+}
+export interface Synonym {
+    id: string;
+    name: string;
+    enabled: boolean;
+    keywords: string[];
+    synonyms: string[];
+    type: "group" | "oneway";
+}
+export interface MergedValue {
+    id: string;
+    name: string;
+    field: string;
+    keywords: string[];
+    values: string[];
+}
+export interface Collection {
+    title: string;
+    handle: string;
+    shopifyId: string;
+    productIds: string[];
+    storefrontId: string;
+    legacyResourceId: number;
+}
+export declare type Product = Omit<ShopifyProduct, "variants" | "images" | "media" | "metafields"> & {
+    variants: (Omit<ShopifyProduct["variants"]["edges"][0]["node"], "presentmentPrices"> & {
+        images?: ShopifyProduct["images"]["edges"][0]["node"][];
+        presentmentPrices: ShopifyProduct["variants"]["edges"][0]["node"]["presentmentPrices"]["edges"][0]["node"][];
+    })[];
+    images: ShopifyProduct["images"]["edges"][0]["node"][];
+    media: ShopifyProduct["media"]["edges"][0]["node"][];
+    metafields: ShopifyProduct["metafields"]["edges"][0]["node"][];
+};
+export {};