@usereactify/search 5.58.0 → 5.59.0-beta.2

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

@@ -1,6 +1,6 @@
 import React from "react";
 import { Config, ConfigCuration, ConfigRedirect, ReactivesearchResultProps } from "../types";
-export type ReactifySearchMode = "search" | "collection" | "instant-search";
+export type ReactifySearchMode = "search" | "collection" | "instant-search" | "curated-page";
 export declare const ReactifySearchContext: React.Context<{
     config: Config;
     options: {
@@ -28,6 +28,14 @@ export declare const ReactifySearchContext: React.Context<{
         collectionHandle: string;
     } | {
         mode: "instant-search";
+    } | {
+        mode: "curated-page";
+        variation: "collection";
+        handle: string;
+    } | {
+        mode: "curated-page";
+        variation: "search";
+        searchTerm: string;
     });
     search: {
         searchTerm: string;
@@ -75,6 +83,14 @@ export declare const useReactifySearchContext: () => {
         collectionHandle: string;
     } | {
         mode: "instant-search";
+    } | {
+        mode: "curated-page";
+        variation: "collection";
+        handle: string;
+    } | {
+        mode: "curated-page";
+        variation: "search";
+        searchTerm: string;
     });
     search: {
         searchTerm: string;

package/dist/src/hooks/useReactifySearchContext.js

@@ -1,11 +1,37 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useReactifySearchContext = exports.ReactifySearchContext = void 0;
-const react_1 = __importDefault(require("react"));
+const react_1 = __importStar(require("react"));
 exports.ReactifySearchContext = react_1.default.createContext(undefined);
-const useReactifySearchContext = () => react_1.default.useContext(exports.ReactifySearchContext);
+const useReactifySearchContext = () => {
+    const context = (0, react_1.useContext)(exports.ReactifySearchContext);
+    if (!context) {
+        throw new Error("useReactifySearchContext must be used within a ReactifySearchProvider");
+    }
+    return context;
+};
 exports.useReactifySearchContext = useReactifySearchContext;
 //# sourceMappingURL=useReactifySearchContext.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"useReactifySearchContext.js","sourceRoot":"","sources":["../../../src/hooks/useReactifySearchContext.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAMb,QAAA,qBAAqB,GAAG,eAAK,CAAC,aAAa,CA6DtD,SAAS,CAAC,CAAC;AAEN,MAAM,wBAAwB,GAAG,GAAG,EAAE,CAC3C,eAAK,CAAC,UAAU,CAAC,6BAAqB,CAAE,CAAC;AAD9B,QAAA,wBAAwB,4BACM","sourcesContent":["import React from \"react\";\n\nimport { Config, ConfigCuration, ConfigRedirect, ReactivesearchResultProps } from \"../types\";\n\nexport type ReactifySearchMode = \"search\" | \"collection\" | \"instant-search\";\n\nexport const ReactifySearchContext = React.createContext<\n  | {\n      config: Config;\n      options: {\n        clientId: string;\n        mode: ReactifySearchMode;\n        index: string;\n        shopifyPermanentDomain: string;\n        market?: string;\n        filtersHandle?: string;\n        credentials?: string;\n        onRedirect?: (type: \"redirect\" | \"search\", url: string) => void;\n        theme: Record<string, unknown>;\n        additionalComponentIds?: Array<string>;\n        includeFields?: Array<string>;\n        excludeFields?: Array<string>;\n        query?: Record<string, string>;\n        preload?: {\n          config: Config;\n          state: unknown;\n        };\n      } & (\n        | {\n            mode: \"search\";\n          }\n        | {\n            mode: \"collection\";\n            collectionHandle: string;\n          }\n        | {\n            mode: \"instant-search\";\n          }\n      );\n      search: {\n        searchTerm: string;\n        setSearchTerm: React.Dispatch<React.SetStateAction<string>>;\n        showInstantSearchResults: boolean;\n        setShowInstantSearchResults: React.Dispatch<\n          React.SetStateAction<boolean>\n        >;\n        searchRedirect: ConfigRedirect | undefined;\n      };\n      sortby: {\n        sortOption: string;\n        setSortOption: React.Dispatch<React.SetStateAction<string>>;\n      };\n      results: {\n        results: ReactivesearchResultProps[\"data\"];\n        setResults: React.Dispatch<\n          React.SetStateAction<ReactivesearchResultProps[\"data\"]>\n        >;\n        resultStats?: ReactivesearchResultProps[\"resultStats\"];\n        setResultStats: React.Dispatch<\n          React.SetStateAction<\n            ReactivesearchResultProps[\"resultStats\"] | undefined\n          >\n        >;\n      };\n      curation: ConfigCuration | undefined;\n    }\n  | undefined\n>(undefined);\n\nexport const useReactifySearchContext = () =>\n  React.useContext(ReactifySearchContext)!;\n"]}
+{"version":3,"file":"useReactifySearchContext.js","sourceRoot":"","sources":["../../../src/hooks/useReactifySearchContext.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAA0C;AAM7B,QAAA,qBAAqB,GAAG,eAAK,CAAC,aAAa,CAiEtD,SAAS,CAAC,CAAC;AAEN,MAAM,wBAAwB,GAAG,GAAG,EAAE;IAC3C,MAAM,OAAO,GAAG,IAAA,kBAAU,EAAC,6BAAqB,CAAC,CAAC;IAClD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;IAC3F,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AANW,QAAA,wBAAwB,4BAMnC","sourcesContent":["import React, { useContext } from \"react\";\n\nimport { Config, ConfigCuration, ConfigRedirect, ReactivesearchResultProps } from \"../types\";\n\nexport type ReactifySearchMode = \"search\" | \"collection\" | \"instant-search\" | \"curated-page\";\n\nexport const ReactifySearchContext = React.createContext<\n  | {\n      config: Config;\n      options: {\n        clientId: string;\n        mode: ReactifySearchMode;\n        index: string;\n        shopifyPermanentDomain: string;\n        market?: string;\n        filtersHandle?: string;\n        credentials?: string;\n        onRedirect?: (type: \"redirect\" | \"search\", url: string) => void;\n        theme: Record<string, unknown>;\n        additionalComponentIds?: Array<string>;\n        includeFields?: Array<string>;\n        excludeFields?: Array<string>;\n        query?: Record<string, string>;\n        preload?: {\n          config: Config;\n          state: unknown;\n        };\n      } & (\n        | {\n            mode: \"search\";\n          }\n        | {\n            mode: \"collection\";\n            collectionHandle: string;\n          }\n        | {\n            mode: \"instant-search\";\n          }\n        | {\n            mode: \"curated-page\";\n            variation: \"collection\";\n            handle: string;\n          }\n        | {\n            mode: \"curated-page\";\n            variation: \"search\";\n            searchTerm: string;\n          }\n      );\n      search: {\n        searchTerm: string;\n        setSearchTerm: React.Dispatch<React.SetStateAction<string>>;\n        showInstantSearchResults: boolean;\n        setShowInstantSearchResults: React.Dispatch<React.SetStateAction<boolean>>;\n        searchRedirect: ConfigRedirect | undefined;\n      };\n      sortby: {\n        sortOption: string;\n        setSortOption: React.Dispatch<React.SetStateAction<string>>;\n      };\n      results: {\n        results: ReactivesearchResultProps[\"data\"];\n        setResults: React.Dispatch<React.SetStateAction<ReactivesearchResultProps[\"data\"]>>;\n        resultStats?: ReactivesearchResultProps[\"resultStats\"];\n        setResultStats: React.Dispatch<\n          React.SetStateAction<ReactivesearchResultProps[\"resultStats\"] | undefined>\n        >;\n      };\n      curation: ConfigCuration | undefined;\n    }\n  | undefined\n>(undefined);\n\nexport const useReactifySearchContext = () => {\n  const context = useContext(ReactifySearchContext);\n  if (!context) {\n    throw new Error(\"useReactifySearchContext must be used within a ReactifySearchProvider\");\n  }\n  return context;\n};\n"]}

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

@@ -1,4 +1,4 @@
-import { Sort, FilterGroup, FilterFacet, Redirect, Relevance, Curation, Market, Antonym, Synonym, Callout, MerchandisingCalloutAutofillBehaviour } from "./firestore";
+import { Antonym, Callout, Curation, FilterFacet, FilterGroup, Market, MerchandisingCalloutAutofillBehaviour, Redirect, Relevance, SearchableField, Sort, Synonym } from "./firestore";
 export type Config = {
     index: string;
     endpoint: string;
@@ -14,6 +14,7 @@ export type Config = {
     };
     sort: Array<ConfigSort>;
     fields: Array<ConfigField>;
+    searchableFields: Array<ConfigSeachableField>;
     filters: Array<ConfigFilter>;
     redirects: Array<ConfigRedirect>;
     curations: Array<ConfigCuration>;
@@ -34,6 +35,7 @@ export type ConfigSynonym = Omit<Synonym, "enabled">;
 export type ConfigCallout = Omit<Callout, "enabled">;
 export type ConfigSort = Omit<Sort, "enabled">;
 export type ConfigField = Omit<Relevance, "enabled">;
+export type ConfigSeachableField = Omit<SearchableField, "enabled">;
 export type ConfigRedirect = Omit<Redirect, "enabled" | "keywords">;
 export type ConfigFilter = Omit<FilterGroup, "enabled" | "keywords"> & {
     options: Omit<FilterFacet, "enabled">[];
@@ -41,11 +43,11 @@ export type ConfigFilter = Omit<FilterGroup, "enabled" | "keywords"> & {
 export type ConfigFilterFacet = Omit<FilterFacet, "enabled">;
 export type ConfigCuration = Omit<Curation, "keywords" | "boosting" | "longRunningTask" | "callouts"> & {
     boosting: {
-        groupings: Array<(NonNullable<NonNullable<Curation["boosting"]>["groupings"]>[0] & {
+        groupings: Array<NonNullable<NonNullable<Curation["boosting"]>["groupings"]>[0] & {
             query: string;
-        })>;
-        sortings: Array<(NonNullable<NonNullable<Curation["boosting"]>["sortings"]>[0] & {
+        }>;
+        sortings: Array<NonNullable<NonNullable<Curation["boosting"]>["sortings"]>[0] & {
             query: string;
-        })>;
+        }>;
     };
 };

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

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/types/config.ts"],"names":[],"mappings":"","sourcesContent":["import { Sort, FilterGroup, FilterFacet, Redirect, Relevance, Curation, Market, Antonym, Synonym, Callout, MerchandisingCalloutAutofillBehaviour } from \"./firestore\";\n\n// when exposed as config, most resources have the `enabled` and `keywords` attributes removed\n// curation boosting groupings and sortings both have a json encoded elastic query added to them\n\nexport type Config = {\n  index: string;\n  endpoint: string;\n  cluster: string;\n  version: string;\n  key: string;\n  cache: {\n    enabled: boolean;\n    seconds: number;\n  };\n  merchandising: {\n    calloutAutofillBehaviour: MerchandisingCalloutAutofillBehaviour;\n  };\n  sort: Array<ConfigSort>;\n  fields: Array<ConfigField>;\n  filters: Array<ConfigFilter>;\n  redirects: Array<ConfigRedirect>;\n  curations: Array<ConfigCuration>;\n  antonyms: Array<ConfigAntonym>;\n  synonyms: Array<ConfigSynonym>;\n  callouts: Array<ConfigCallout>;\n  markets: Array<Market>;\n  suggestions: {\n    exclude: Array<string>;\n  };\n  sensors: {\n    search: Array<unknown>;\n    collection: Array<unknown>;\n  };\n}\n\nexport type ConfigAntonym = Omit<Antonym, \"enabled\">;\nexport type ConfigSynonym = Omit<Synonym, \"enabled\">;\nexport type ConfigCallout = Omit<Callout, \"enabled\">;\nexport type ConfigSort = Omit<Sort, \"enabled\">;\nexport type ConfigField = Omit<Relevance, \"enabled\">;\nexport type ConfigRedirect = Omit<Redirect, \"enabled\" | \"keywords\">;\nexport type ConfigFilter = Omit<FilterGroup, \"enabled\" | \"keywords\"> & { options: Omit<FilterFacet, \"enabled\">[] };\nexport type ConfigFilterFacet = Omit<FilterFacet, \"enabled\">;\nexport type ConfigCuration = Omit<Curation, \"keywords\" | \"boosting\" | \"longRunningTask\" | \"callouts\"> & {\n  boosting: {\n    groupings: Array<(NonNullable<NonNullable<Curation[\"boosting\"]>[\"groupings\"]>[0] & { query: string })>;\n    sortings: Array<(NonNullable<NonNullable<Curation[\"boosting\"]>[\"sortings\"]>[0] & { query: string })>;\n  };\n};"]}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/types/config.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  Antonym,\n  Callout,\n  Curation,\n  FilterFacet,\n  FilterGroup,\n  Market,\n  MerchandisingCalloutAutofillBehaviour,\n  Redirect,\n  Relevance,\n  SearchableField,\n  Sort,\n  Synonym,\n} from \"./firestore\";\n\n// when exposed as config, most resources have the `enabled` and `keywords` attributes removed\n// curation boosting groupings and sortings both have a json encoded elastic query added to them\n\nexport type Config = {\n  index: string;\n  endpoint: string;\n  cluster: string;\n  version: string;\n  key: string;\n  cache: {\n    enabled: boolean;\n    seconds: number;\n  };\n  merchandising: {\n    calloutAutofillBehaviour: MerchandisingCalloutAutofillBehaviour;\n  };\n  sort: Array<ConfigSort>;\n  fields: Array<ConfigField>;\n  searchableFields: Array<ConfigSeachableField>;\n  filters: Array<ConfigFilter>;\n  redirects: Array<ConfigRedirect>;\n  curations: Array<ConfigCuration>;\n  antonyms: Array<ConfigAntonym>;\n  synonyms: Array<ConfigSynonym>;\n  callouts: Array<ConfigCallout>;\n  markets: Array<Market>;\n  suggestions: {\n    exclude: Array<string>;\n  };\n  sensors: {\n    search: Array<unknown>;\n    collection: Array<unknown>;\n  };\n};\n\nexport type ConfigAntonym = Omit<Antonym, \"enabled\">;\nexport type ConfigSynonym = Omit<Synonym, \"enabled\">;\nexport type ConfigCallout = Omit<Callout, \"enabled\">;\nexport type ConfigSort = Omit<Sort, \"enabled\">;\nexport type ConfigField = Omit<Relevance, \"enabled\">;\nexport type ConfigSeachableField = Omit<SearchableField, \"enabled\">;\nexport type ConfigRedirect = Omit<Redirect, \"enabled\" | \"keywords\">;\nexport type ConfigFilter = Omit<FilterGroup, \"enabled\" | \"keywords\"> & {\n  options: Omit<FilterFacet, \"enabled\">[];\n};\nexport type ConfigFilterFacet = Omit<FilterFacet, \"enabled\">;\nexport type ConfigCuration = Omit<\n  Curation,\n  \"keywords\" | \"boosting\" | \"longRunningTask\" | \"callouts\"\n> & {\n  boosting: {\n    groupings: Array<\n      NonNullable<NonNullable<Curation[\"boosting\"]>[\"groupings\"]>[0] & { query: string }\n    >;\n    sortings: Array<\n      NonNullable<NonNullable<Curation[\"boosting\"]>[\"sortings\"]>[0] & { query: string }\n    >;\n  };\n};\n\n"]}