@usereactify/search 5.17.2 → 5.18.0

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [5.18.0](https://bitbucket.org/usereactify/reactify-search-ui/compare/release-v5.17.2...release-v5.18.0) (2023-03-17)
+
+
+### Features
+
+* add Suggestions component ([21514bb](https://bitbucket.org/usereactify/reactify-search-ui/commit/21514bb7d643647b1ac2a19b57ec649e5a0684b3))
+* improve elasticsearch types and add related field ([dd88e8a](https://bitbucket.org/usereactify/reactify-search-ui/commit/dd88e8a3ee5e1dce990495aa03b8fe814e35d6c5))
+
 ### [5.17.2](https://bitbucket.org/usereactify/reactify-search-ui/compare/release-v5.17.1...release-v5.17.2) (2023-01-23)
 
 

package/dist/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@usereactify/search",
     "description": "React UI library for Reactify Search",
-    "version": "5.17.2",
+    "version": "5.18.0",
     "license": "MIT",
     "main": "dist/src/index.js",
     "types": "dist/src/index.d.ts",

package/dist/src/components/Example/ExampleSuggestions.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { SuggestionsProps } from "../../components";
+export declare type ExampleSuggestionsProps = React.ComponentProps<NonNullable<SuggestionsProps["render"]>>;
+export declare const ExampleSuggestions: React.FC<ExampleSuggestionsProps>;

package/dist/src/components/Example/ExampleSuggestions.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExampleSuggestions = void 0;
+const react_1 = __importDefault(require("react"));
+const hooks_1 = require("../../hooks");
+const ExampleSuggestions = (props) => {
+    const { setSearchTerm } = (0, hooks_1.useSearch)();
+    return (react_1.default.createElement(react_1.default.Fragment, null,
+        react_1.default.createElement("h3", null, "Suggestions"),
+        react_1.default.createElement("ul", null, props.suggestions.map((suggestion) => (react_1.default.createElement("li", { onClick: () => setSearchTerm(suggestion.text) }, suggestion.text))))));
+};
+exports.ExampleSuggestions = ExampleSuggestions;
+//# sourceMappingURL=ExampleSuggestions.js.map

package/dist/src/components/Example/ExampleSuggestions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExampleSuggestions.js","sourceRoot":"","sources":["../../../../src/components/Example/ExampleSuggestions.tsx"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAG1B,uCAAwC;AAMjC,MAAM,kBAAkB,GAAsC,CACnE,KAAK,EACL,EAAE;IACF,MAAM,EAAE,aAAa,EAAE,GAAG,IAAA,iBAAS,GAAE,CAAC;IAEtC,OAAO,CACL;QACE,wDAAoB;QACpB,0CACG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CACrC,sCAAI,OAAO,EAAE,GAAG,EAAE,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,CAAC,IAC9C,UAAU,CAAC,IAAI,CACb,CACN,CAAC,CACC,CACJ,CACJ,CAAC;AACJ,CAAC,CAAC;AAjBW,QAAA,kBAAkB,sBAiB7B","sourcesContent":["import React from \"react\";\n\nimport { SuggestionsProps } from \"../../components\";\nimport { useSearch } from \"../../hooks\";\n\nexport type ExampleSuggestionsProps = React.ComponentProps<\n  NonNullable<SuggestionsProps[\"render\"]>\n>;\n\nexport const ExampleSuggestions: React.FC<ExampleSuggestionsProps> = (\n  props\n) => {\n  const { setSearchTerm } = useSearch();\n\n  return (\n    <>\n      <h3>Suggestions</h3>\n      <ul>\n        {props.suggestions.map((suggestion) => (\n          <li onClick={() => setSearchTerm(suggestion.text)}>\n            {suggestion.text}\n          </li>\n        ))}\n      </ul>\n    </>\n  );\n};\n"]}

package/dist/src/components/Example/index.d.ts

@@ -17,6 +17,7 @@ export * from "./ExampleResultPaginationNextPrev";
 export * from "./ExampleSearch";
 export * from "./ExampleSortBy";
 export * from "./ExampleStats";
+export * from "./ExampleSuggestions";
 export * from "./ExampleHookUseFilters";
 export * from "./ExampleHookUseResults";
 export * from "./ExampleHookUseSearch";

package/dist/src/components/Example/index.js

@@ -29,6 +29,7 @@ __exportStar(require("./ExampleResultPaginationNextPrev"), exports);
 __exportStar(require("./ExampleSearch"), exports);
 __exportStar(require("./ExampleSortBy"), exports);
 __exportStar(require("./ExampleStats"), exports);
+__exportStar(require("./ExampleSuggestions"), exports);
 __exportStar(require("./ExampleHookUseFilters"), exports);
 __exportStar(require("./ExampleHookUseResults"), exports);
 __exportStar(require("./ExampleHookUseSearch"), exports);

package/dist/src/components/Example/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/components/Example/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oDAAkC;AAClC,2DAAyC;AACzC,sDAAoC;AACpC,uDAAqC;AACrC,wDAAsC;AACtC,mDAAiC;AACjC,2DAAyC;AACzC,4EAA0D;AAC1D,+EAA6D;AAC7D,wEAAsD;AACtD,6DAA2C;AAC3C,6DAA2C;AAC3C,oEAAkD;AAClD,oEAAkD;AAClD,0EAAwD;AACxD,oEAAkD;AAClD,kDAAgC;AAChC,kDAAgC;AAChC,iDAA+B;AAE/B,0DAAwC;AACxC,0DAAwC;AACxC,yDAAuC;AACvC,yDAAuC","sourcesContent":["export * from \"./ExampleClearAll\";\nexport * from \"./ExampleCustomComponent\";\nexport * from \"./ExampleFilterList\";\nexport * from \"./ExampleFilterRange\";\nexport * from \"./ExampleFilterSlider\";\nexport * from \"./ExampleFilters\";\nexport * from \"./ExampleFiltersSelected\";\nexport * from \"./ExampleReactiveSearchProviderCollection\";\nexport * from \"./ExampleReactiveSearchProviderInstantSearch\";\nexport * from \"./ExampleReactiveSearchProviderSearch\";\nexport * from \"./ExampleResultCardCallout\";\nexport * from \"./ExampleResultCardProduct\";\nexport * from \"./ExampleResultPaginationNumbered\";\nexport * from \"./ExampleResultPaginationLoadMore\";\nexport * from \"./ExampleResultPaginationInfiniteScroll\";\nexport * from \"./ExampleResultPaginationNextPrev\";\nexport * from \"./ExampleSearch\";\nexport * from \"./ExampleSortBy\";\nexport * from \"./ExampleStats\";\n\nexport * from \"./ExampleHookUseFilters\";\nexport * from \"./ExampleHookUseResults\";\nexport * from \"./ExampleHookUseSearch\";\nexport * from \"./ExampleHookUseSortBy\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/components/Example/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oDAAkC;AAClC,2DAAyC;AACzC,sDAAoC;AACpC,uDAAqC;AACrC,wDAAsC;AACtC,mDAAiC;AACjC,2DAAyC;AACzC,4EAA0D;AAC1D,+EAA6D;AAC7D,wEAAsD;AACtD,6DAA2C;AAC3C,6DAA2C;AAC3C,oEAAkD;AAClD,oEAAkD;AAClD,0EAAwD;AACxD,oEAAkD;AAClD,kDAAgC;AAChC,kDAAgC;AAChC,iDAA+B;AAC/B,uDAAqC;AAErC,0DAAwC;AACxC,0DAAwC;AACxC,yDAAuC;AACvC,yDAAuC","sourcesContent":["export * from \"./ExampleClearAll\";\nexport * from \"./ExampleCustomComponent\";\nexport * from \"./ExampleFilterList\";\nexport * from \"./ExampleFilterRange\";\nexport * from \"./ExampleFilterSlider\";\nexport * from \"./ExampleFilters\";\nexport * from \"./ExampleFiltersSelected\";\nexport * from \"./ExampleReactiveSearchProviderCollection\";\nexport * from \"./ExampleReactiveSearchProviderInstantSearch\";\nexport * from \"./ExampleReactiveSearchProviderSearch\";\nexport * from \"./ExampleResultCardCallout\";\nexport * from \"./ExampleResultCardProduct\";\nexport * from \"./ExampleResultPaginationNumbered\";\nexport * from \"./ExampleResultPaginationLoadMore\";\nexport * from \"./ExampleResultPaginationInfiniteScroll\";\nexport * from \"./ExampleResultPaginationNextPrev\";\nexport * from \"./ExampleSearch\";\nexport * from \"./ExampleSortBy\";\nexport * from \"./ExampleStats\";\nexport * from \"./ExampleSuggestions\";\n\nexport * from \"./ExampleHookUseFilters\";\nexport * from \"./ExampleHookUseResults\";\nexport * from \"./ExampleHookUseSearch\";\nexport * from \"./ExampleHookUseSortBy\";\n"]}

package/dist/src/components/Suggestions/Suggestions.d.ts

@@ -0,0 +1,12 @@
+import React from "react";
+export declare type SuggestionsProps = {
+    /** The field which should be used for autocompletion */
+    field: "title";
+    /** Render method */
+    render?: React.FC<{
+        suggestions: Array<{
+            text: string;
+        }>;
+    }>;
+};
+export declare const Suggestions: React.FC<SuggestionsProps>;

package/dist/src/components/Suggestions/Suggestions.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Suggestions = void 0;
+const react_1 = __importDefault(require("react"));
+const components_1 = require("../../components");
+const hooks_1 = require("../../hooks");
+const Suggestions = (props) => {
+    var _a;
+    const RenderComponent = (_a = props.render) !== null && _a !== void 0 ? _a : components_1.ExampleSuggestions;
+    const { searchTerm } = (0, hooks_1.useSearch)();
+    return (react_1.default.createElement(components_1.CustomComponent, { componentId: "SensorSuggestions", defaultQuery: () => {
+            return {
+                suggest: {
+                    suggestions: {
+                        text: searchTerm,
+                        term: {
+                            field: props.field,
+                            sort: "score",
+                            suggest_mode: "always",
+                        },
+                    },
+                },
+            };
+        }, react: {
+            and: components_1.SENSOR_IDS,
+        }, render: (renderProps) => {
+            var _a, _b, _c;
+            const props = {
+                suggestions: [],
+            };
+            if ((_b = (_a = renderProps.rawData) === null || _a === void 0 ? void 0 : _a.suggest) === null || _b === void 0 ? void 0 : _b.suggestions.length) {
+                const options = (_c = renderProps.rawData.suggest.suggestions[renderProps.rawData.suggest.suggestions.length - 1]) === null || _c === void 0 ? void 0 : _c.options;
+                props.suggestions.push(...options.map((option) => ({
+                    text: option.text,
+                })));
+            }
+            return react_1.default.createElement(RenderComponent, Object.assign({}, props));
+        } }));
+};
+exports.Suggestions = Suggestions;
+//# sourceMappingURL=Suggestions.js.map

package/dist/src/components/Suggestions/Suggestions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Suggestions.js","sourceRoot":"","sources":["../../../../src/components/Suggestions/Suggestions.tsx"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAE1B,iDAI0B;AAC1B,uCAAwC;AAajC,MAAM,WAAW,GAA+B,CAAC,KAAK,EAAE,EAAE;;IAC/D,MAAM,eAAe,GAAG,MAAA,KAAK,CAAC,MAAM,mCAAI,+BAAkB,CAAC;IAE3D,MAAM,EAAE,UAAU,EAAE,GAAG,IAAA,iBAAS,GAAE,CAAC;IAEnC,OAAO,CACL,8BAAC,4BAAe,IACd,WAAW,EAAC,mBAAmB,EAC/B,YAAY,EAAE,GAAG,EAAE;YACjB,OAAO;gBACL,OAAO,EAAE;oBACP,WAAW,EAAE;wBACX,IAAI,EAAE,UAAU;wBAChB,IAAI,EAAE;4BACJ,KAAK,EAAE,KAAK,CAAC,KAAK;4BAClB,IAAI,EAAE,OAAO;4BACb,YAAY,EAAE,QAAQ;yBACvB;qBACF;iBACF;aACF,CAAC;QACJ,CAAC,EACD,KAAK,EAAE;YACL,GAAG,EAAE,uBAAU;SAChB,EACD,MAAM,EAAE,CAAC,WAAW,EAAE,EAAE;;YACtB,MAAM,KAAK,GAEP;gBACF,WAAW,EAAE,EAAE;aAChB,CAAC;YAEF,IAAI,MAAA,MAAA,WAAW,CAAC,OAAO,0CAAE,OAAO,0CAAE,WAAW,CAAC,MAAM,EAAE;gBACpD,MAAM,OAAO,GACX,MAAA,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CACrC,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CACnD,0CAAE,OAAO,CAAC;gBACb,KAAK,CAAC,WAAW,CAAC,IAAI,CACpB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAsC,EAAE,EAAE,CAAC,CAAC;oBAC1D,IAAI,EAAE,MAAM,CAAC,IAAI;iBAClB,CAAC,CAAC,CACJ,CAAC;aACH;YAED,OAAO,8BAAC,eAAe,oBAAK,KAAK,EAAI,CAAC;QACxC,CAAC,GACD,CACH,CAAC;AACJ,CAAC,CAAC;AAhDW,QAAA,WAAW,eAgDtB","sourcesContent":["import React from \"react\";\n\nimport {\n  CustomComponent,\n  ExampleSuggestions,\n  SENSOR_IDS,\n} from \"../../components\";\nimport { useSearch } from \"../../hooks\";\n\nexport type SuggestionsProps = {\n  /** The field which should be used for autocompletion */\n  field: \"title\";\n  /** Render method */\n  render?: React.FC<{\n    suggestions: Array<{\n      text: string;\n    }>;\n  }>;\n};\n\nexport const Suggestions: React.FC<SuggestionsProps> = (props) => {\n  const RenderComponent = props.render ?? ExampleSuggestions;\n\n  const { searchTerm } = useSearch();\n\n  return (\n    <CustomComponent\n      componentId=\"SensorSuggestions\"\n      defaultQuery={() => {\n        return {\n          suggest: {\n            suggestions: {\n              text: searchTerm,\n              term: {\n                field: props.field,\n                sort: \"score\",\n                suggest_mode: \"always\",\n              },\n            },\n          },\n        };\n      }}\n      react={{\n        and: SENSOR_IDS,\n      }}\n      render={(renderProps) => {\n        const props: React.ComponentProps<\n          NonNullable<SuggestionsProps[\"render\"]>\n        > = {\n          suggestions: [],\n        };\n\n        if (renderProps.rawData?.suggest?.suggestions.length) {\n          const options =\n            renderProps.rawData.suggest.suggestions[\n              renderProps.rawData.suggest.suggestions.length - 1\n            ]?.options;\n          props.suggestions.push(\n            ...options.map((option: { text: string; freq: number }) => ({\n              text: option.text,\n            }))\n          );\n        }\n\n        return <RenderComponent {...props} />;\n      }}\n    />\n  );\n};\n"]}

package/dist/src/components/Suggestions/index.d.ts

@@ -0,0 +1 @@
+export * from "./Suggestions";

package/dist/src/components/Suggestions/index.js

@@ -0,0 +1,14 @@
+"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("./Suggestions"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/components/Suggestions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/components/Suggestions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,gDAA8B","sourcesContent":["export * from \"./Suggestions\";\n"]}

package/dist/src/components/index.d.ts

@@ -8,4 +8,5 @@ export * from "./Search";
 export * from "./Sensor";
 export * from "./SortBy";
 export * from "./Stats";
+export * from "./Suggestions";
 export * from "./Utility";

package/dist/src/components/index.js

@@ -20,5 +20,6 @@ __exportStar(require("./Search"), exports);
 __exportStar(require("./Sensor"), exports);
 __exportStar(require("./SortBy"), exports);
 __exportStar(require("./Stats"), exports);
+__exportStar(require("./Suggestions"), exports);
 __exportStar(require("./Utility"), exports);
 //# sourceMappingURL=index.js.map

package/dist/src/components/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/components/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAA0B;AAC1B,oDAAkC;AAClC,6CAA2B;AAC3B,2CAAyB;AACzB,2DAAyC;AACzC,2CAAyB;AACzB,2CAAyB;AACzB,2CAAyB;AACzB,2CAAyB;AACzB,0CAAwB;AACxB,4CAA0B","sourcesContent":["export * from \"./Example\";\nexport * from \"./CustomComponent\";\nexport * from \"./ClearAll\";\nexport * from \"./Filter\";\nexport * from \"./ReactifySearchProvider\";\nexport * from \"./Result\";\nexport * from \"./Search\";\nexport * from \"./Sensor\";\nexport * from \"./SortBy\";\nexport * from \"./Stats\";\nexport * from \"./Utility\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/components/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAA0B;AAC1B,oDAAkC;AAClC,6CAA2B;AAC3B,2CAAyB;AACzB,2DAAyC;AACzC,2CAAyB;AACzB,2CAAyB;AACzB,2CAAyB;AACzB,2CAAyB;AACzB,0CAAwB;AACxB,gDAA8B;AAC9B,4CAA0B","sourcesContent":["export * from \"./Example\";\nexport * from \"./CustomComponent\";\nexport * from \"./ClearAll\";\nexport * from \"./Filter\";\nexport * from \"./ReactifySearchProvider\";\nexport * from \"./Result\";\nexport * from \"./Search\";\nexport * from \"./Sensor\";\nexport * from \"./SortBy\";\nexport * from \"./Stats\";\nexport * from \"./Suggestions\";\nexport * from \"./Utility\";\n"]}

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

@@ -27,16 +27,16 @@ export interface ElasticProduct {
     product_type: string;
     handle: string;
     url: string;
-    tags: string[];
-    collection_titles: string[];
+    tags: Array<string>;
+    collection_titles: Array<string>;
     /** tag prefixes defined in tagKeys are split to their own attributes */
-    [key: `tags_${string}`]: string[] | undefined;
+    [key: `tags_${string}`]: Array<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[];
+    options: Array<string>;
     /** @todo it would be better to use ProductStatus directly, which has uppercase */
     status: "active" | "archived" | "draft";
     published: boolean;
@@ -50,22 +50,22 @@ export interface ElasticProduct {
     /** originalSrc URL for featured image */
     image: Maybe<string>;
     /** array of images (undefined if images are disabled in sync settings) */
-    images?: ElasticImage[];
+    images?: Array<ElasticImage>;
     /** array of variants attached to product (undefined if variants are disabled in sync settings) */
-    variants?: ElasticVariant[];
+    variants?: Array<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[];
+        min_variant_price: Array<ElasticPresentmentPrice>;
+        max_variant_price: Array<ElasticPresentmentPrice>;
     };
     /** array of variant skus (undefined if variants are disabled in sync settings) */
-    variant_skus?: string[];
+    variant_skus?: Array<string>;
     /** combined array of option values from all option types (undefined if variants are disabled in sync settings) */
-    variant_options?: string[];
+    variant_options?: Array<string>;
     /** array of collections which this product belongs to (undefined if collections are disabled in sync settings) */
-    collections?: ElasticCollection[];
+    collections?: Array<ElasticCollection>;
     /** array of whitelisted metafields (undefined if metafields are disabled in sync settings) */
-    metafields?: ElasticMetafield[];
+    metafields?: Array<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) */
@@ -73,7 +73,43 @@ export interface ElasticProduct {
     /** number of days since published, null if unpublished */
     published_days: Maybe<number>;
     /** collection of curations that this product is attached to */
-    curations?: ElasticCuration[];
+    curations?: Array<ElasticCuration>;
+    /** related products **/
+    related?: Array<ElasticProductRelated>;
+}
+export interface ElasticProductRelated {
+    createdAt: string;
+    description: string;
+    featuredImage: {
+        originalSrc: "https://cdn.shopify.com/s/files/1/0614/3977/0777/p…71d6-e7fd-4f5f-aa99-c722e2832d01.jpg?v=1660776345";
+    };
+    handle: string;
+    id: string;
+    images: Array<ElasticImage>;
+    legacyResourceId: string;
+    metafields?: Array<ElasticMetafield>;
+    options: Array<{
+        name: string;
+    }>;
+    priceRangeV2: {
+        maxVariantPrice: {
+            amount: string;
+        };
+        minVariantPrice: {
+            amount: string;
+        };
+    };
+    productType: string;
+    publishedAt: string;
+    status: "ACTIVE" | "ARCHIVED" | "DRAFT";
+    storefrontId: string;
+    tags: Array<string>;
+    title: string;
+    tracksInventory: boolean;
+    updatedAt: string;
+    variants: Array<ElasticVariant>;
+    vendor: string;
+    __typename: "Product";
 }
 export interface ElasticVariant {
     /** legacy resource id */
@@ -83,10 +119,10 @@ export interface ElasticVariant {
     sku: Maybe<string>;
     barcode: Maybe<string>;
     /** array of presentment prices (undefined if presentment prices are disabled in sync settings) */
-    presentment_prices?: {
+    presentment_prices?: Array<{
         price: ElasticPresentmentPrice;
         compare_at_price: Maybe<ElasticPresentmentPrice>;
-    }[];
+    }>;
     /** decimal number e.g. 99.95 */
     price: number;
     /** decimal number e.g. 99.95 */
@@ -103,7 +139,7 @@ export interface ElasticVariant {
     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[];
+    images?: Array<ElasticImage>;
 }
 export interface ElasticCollection {
     /** legacy resource id */
@@ -175,7 +211,7 @@ export declare type ElasticBulkOperationIndex = [
 export declare type ElasticBulkOperation = ElasticBulkOperationUpdate | ElasticBulkOperationIndex;
 export declare type ElasticSearchResult<T = ElasticDocument> = {
     hits: {
-        hits: ElasticHit<T>[];
+        hits: Array<ElasticHit<T>>;
     };
 };
 export declare type ElasticHit<T = ElasticDocument> = {

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

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@usereactify/search",
   "description": "React UI library for Reactify Search",
-  "version": "5.17.2",
+  "version": "5.18.0",
   "license": "MIT",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",