@usereactify/search 5.52.0 → 5.53.0-beta.0

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

@@ -1 +1 @@
-{"version":3,"file":"useFilters.js","sourceRoot":"","sources":["../../../src/hooks/useFilters.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,iCAAiC;AACjC,mEAA4E;AAC5E,iCAAiC;AACjC,iEAA+D;AAG/D,oCAAoD;AACpD,wCAAmC;AAE5B,MAAM,UAAU,GAAG,GAmBxB,EAAE;;IACF,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAA,gCAAwB,GAAE,CAAC;IACvD,MAAM,qBAAqB,GAAG,eAAK,CAAC,UAAU,CAAM,yBAAiB,CAAC,CAAC;IAEvE,MAAM,WAAW,GAAG,eAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QACrC,yBAAyB;QACzB,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAC5C,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CACzC,CAAC;QAEF,4CAA4C;QAC5C,IAAI,OAAO,CAAC,aAAa,EAAE;YACzB,MAAM,eAAe,GAAG,gBAAgB,CAAC,IAAI,CAC3C,CAAC,WAAW,EAAE,EAAE,CAAC,OAAO,CAAC,aAAa,KAAK,WAAW,CAAC,MAAM,CAC9D,CAAC;YACF,IAAI,eAAe,EAAE;gBACnB,OAAO,eAAe,CAAC;aACxB;SACF;QAED,gDAAgD;QAChD,IAAI,OAAO,CAAC,IAAI,KAAK,YAAY,IAAI,OAAO,CAAC,gBAAgB,EAAE;YAC7D,MAAM,eAAe,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,WAC5D,OAAA,MAAA,WAAW,CAAC,WAAW,0CAAE,QAAQ,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA,EAAA,CAC5D,CAAC;YACF,IAAI,eAAe,EAAE;gBACnB,OAAO,eAAe,CAAC;aACxB;SACF;QAED,sCAAsC;QACtC,IAAI,eAAe,GAAG,gBAAgB,CAAC,IAAI,CACzC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,KAAK,SAAS,CAClD,CAAC;QACF,IAAI,eAAe,EAAE;YACnB,OAAO,eAAe,CAAC;SACxB;QAED,0CAA0C;QAC1C,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CACnC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,KAAK,SAAS,CAClD,CAAC;QACF,IAAI,eAAe,EAAE;YACnB,OAAO,eAAe,CAAC;SACxB;QAED,+CAA+C;QAC/C,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAEpC,OAAO,eAAe,CAAC;IACzB,CAAC,EAAE;QACD,MAAM;QACN,OAAO,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS;KACrE,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,eAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QACjC,MAAM,aAAa,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACvD,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACjC,CAAC;QAEF,OAAO,aAAa,CAAC;IACvB,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAElB,MAAM,QAAQ,GAAG,eAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QAClC,OAAO,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,cAAc,CAAC;aAChE,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC;aAClE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACd,MAAM,EAAE,IAAI;YACZ,KAAK,EAAE,qBAAqB,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,KAAK;SACnE,CAAC,CAAC,CAAC;IACR,CAAC,EAAE,CAAC,OAAO,EAAE,MAAA,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,UAAU,0CAAE,cAAc,CAAC,CAAC,CAAC;IAEjE,MAAM,cAAc,GAAG,eAAK,CAAC,WAAW,CACtC,CACE,MAAc,EACd,KAAgD,EAC1C,EAAE;QACR,eAAK,CAAC,GAAG,CAAC,YAAY,EAAE,8BAA8B,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;QACvE,qBAAqB,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAA,kBAAQ,EAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IAChE,CAAC,EACD,CAAC,qBAAqB,CAAC,CACxB,CAAC;IAEF,eAAK,CAAC,IAAI,CAAC,YAAY,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;IACrD,eAAK,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC7C,eAAK,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;IAE/C,OAAO;QACL,WAAW,EAAE,WAAW;QACxB,OAAO,EAAE,OAAO;QAChB,QAAQ,EAAE,QAAQ;QAClB,cAAc,EAAE,cAAc;KAC/B,CAAC;AACJ,CAAC,CAAC;AAhHW,QAAA,UAAU,cAgHrB","sourcesContent":["import React from \"react\";\n// @ts-expect-error missing types\nimport { ReactReduxContext } from \"@usereactify/search-internals/lib/utils\";\n// @ts-expect-error missing types\nimport { setValue } from \"@appbaseio/reactivecore/lib/actions\";\n\nimport { ConfigFilter, ConfigFilterOption } from \"../types\";\nimport { useReactifySearchContext } from \"../hooks\";\nimport { debug } from \"../utility\";\n\nexport const useFilters = (): {\n  /** The currently selected filter stack, based on mode, curation and more */\n  filterStack?: ConfigFilter;\n  /** All of the available filters within the filter stack */\n  filters?: Array<ConfigFilterOption>;\n  /** All of the selected filters with their value */\n  selected: Array<{\n    handle: string;\n    value: string | Array<string> | Array<{\n      label: string;\n      start: number;\n      end: number;\n    }>;\n  }>;\n  /** Clear filter by handle */\n  setFilterValue: (\n    handle: string,\n    value: string | Array<string> | [number, number]\n  ) => void;\n} => {\n  const { options, config } = useReactifySearchContext();\n  const reactivesearchContext = React.useContext<any>(ReactReduxContext);\n\n  const filterStack = React.useMemo(() => {\n    // select filters by type\n    const matchingFilterss = config.filters.filter(\n      (filter) => filter.type === options.mode\n    );\n\n    // select filter stack by handle if provided\n    if (options.filtersHandle) {\n      const matchingFilters = matchingFilterss.find(\n        (filterStack) => options.filtersHandle === filterStack.handle\n      );\n      if (matchingFilters) {\n        return matchingFilters;\n      }\n    }\n\n    // select filter stack by collection if provided\n    if (options.mode === \"collection\" && options.collectionHandle) {\n      const matchingFilters = matchingFilterss.find((filterStack) =>\n        filterStack.collections?.includes(options.collectionHandle)\n      );\n      if (matchingFilters) {\n        return matchingFilters;\n      }\n    }\n\n    // select filter with \"default\" handle\n    let matchingFilters = matchingFilterss.find(\n      (filterStack) => filterStack.handle === \"default\"\n    );\n    if (matchingFilters) {\n      return matchingFilters;\n    }\n\n    // select any filter with \"default\" handle\n    matchingFilters = config.filters.find(\n      (filterStack) => filterStack.handle === \"default\"\n    );\n    if (matchingFilters) {\n      return matchingFilters;\n    }\n\n    // select any available filter as a last resort\n    matchingFilters = config.filters[0];\n\n    return matchingFilters;\n  }, [\n    config,\n    options.mode === \"collection\" ? options.collectionHandle : undefined,\n  ]);\n\n  const filters = React.useMemo(() => {\n    const sortedFilters = filterStack?.options.sort((a, b) =>\n      a.position > b.position ? 1 : -1\n    );\n\n    return sortedFilters;\n  }, [filterStack]);\n\n  const selected = React.useMemo(() => {\n    return Object.keys(reactivesearchContext.storeState.selectedValues)\n      .filter((item) => filters.find((filter) => filter.handle === item))\n      .map((item) => ({\n        handle: item,\n        value: reactivesearchContext.storeState.selectedValues[item].value,\n      }));\n  }, [filters, reactivesearchContext?.storeState?.selectedValues]);\n\n  const setFilterValue = React.useCallback(\n    (\n      handle: string,\n      value: string | Array<string> | [number, number]\n    ): void => {\n      debug.log(\"useFilters\", \"setFilterValue[handle,value]\", handle, value);\n      reactivesearchContext.store.dispatch(setValue(handle, value));\n    },\n    [reactivesearchContext]\n  );\n\n  debug.hook(\"useFilters\", \"filterStack\", filterStack);\n  debug.hook(\"useFilters\", \"filters\", filters);\n  debug.hook(\"useFilters\", \"selected\", selected);\n\n  return {\n    filterStack: filterStack,\n    filters: filters,\n    selected: selected,\n    setFilterValue: setFilterValue,\n  };\n};\n"]}
+{"version":3,"file":"useFilters.js","sourceRoot":"","sources":["../../../src/hooks/useFilters.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAC1B,iCAAiC;AACjC,mEAA4E;AAC5E,iCAAiC;AACjC,iEAA+D;AAG/D,oCAAoD;AACpD,wCAAmC;AAE5B,MAAM,UAAU,GAAG,GAmBxB,EAAE;;IACF,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAA,gCAAwB,GAAE,CAAC;IACvD,MAAM,qBAAqB,GAAG,eAAK,CAAC,UAAU,CAAM,yBAAiB,CAAC,CAAC;IAEvE,MAAM,WAAW,GAAG,eAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QACrC,yBAAyB;QACzB,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAC5C,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CACzC,CAAC;QAEF,4CAA4C;QAC5C,IAAI,OAAO,CAAC,aAAa,EAAE;YACzB,MAAM,eAAe,GAAG,gBAAgB,CAAC,IAAI,CAC3C,CAAC,WAAW,EAAE,EAAE,CAAC,OAAO,CAAC,aAAa,KAAK,WAAW,CAAC,MAAM,CAC9D,CAAC;YACF,IAAI,eAAe,EAAE;gBACnB,OAAO,eAAe,CAAC;aACxB;SACF;QAED,gDAAgD;QAChD,IAAI,OAAO,CAAC,IAAI,KAAK,YAAY,IAAI,OAAO,CAAC,gBAAgB,EAAE;YAC7D,MAAM,eAAe,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,WAC5D,OAAA,MAAA,WAAW,CAAC,WAAW,0CAAE,QAAQ,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA,EAAA,CAC5D,CAAC;YACF,IAAI,eAAe,EAAE;gBACnB,OAAO,eAAe,CAAC;aACxB;SACF;QAED,sCAAsC;QACtC,IAAI,eAAe,GAAG,gBAAgB,CAAC,IAAI,CACzC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,KAAK,SAAS,CAClD,CAAC;QACF,IAAI,eAAe,EAAE;YACnB,OAAO,eAAe,CAAC;SACxB;QAED,0CAA0C;QAC1C,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CACnC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,KAAK,SAAS,CAClD,CAAC;QACF,IAAI,eAAe,EAAE;YACnB,OAAO,eAAe,CAAC;SACxB;QAED,+CAA+C;QAC/C,eAAe,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAEpC,OAAO,eAAe,CAAC;IACzB,CAAC,EAAE;QACD,MAAM;QACN,OAAO,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS;KACrE,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,eAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QACjC,MAAM,aAAa,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACvD,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACjC,CAAC;QAEF,OAAO,aAAa,CAAC;IACvB,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAElB,MAAM,QAAQ,GAAG,eAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QAClC,OAAO,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,cAAc,CAAC;aAChE,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,KAAK,IAAI,CAAC,CAAC;aAClE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACd,MAAM,EAAE,IAAI;YACZ,KAAK,EAAE,qBAAqB,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,KAAK;SACnE,CAAC,CAAC,CAAC;IACR,CAAC,EAAE,CAAC,OAAO,EAAE,MAAA,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,UAAU,0CAAE,cAAc,CAAC,CAAC,CAAC;IAEjE,MAAM,cAAc,GAAG,eAAK,CAAC,WAAW,CACtC,CACE,MAAc,EACd,KAAgD,EAC1C,EAAE;QACR,eAAK,CAAC,GAAG,CAAC,YAAY,EAAE,8BAA8B,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;QACvE,qBAAqB,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAA,kBAAQ,EAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;IAChE,CAAC,EACD,CAAC,qBAAqB,CAAC,CACxB,CAAC;IAEF,eAAK,CAAC,IAAI,CAAC,YAAY,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;IACrD,eAAK,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC7C,eAAK,CAAC,IAAI,CAAC,YAAY,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;IAE/C,OAAO;QACL,WAAW,EAAE,WAAW;QACxB,OAAO,EAAE,OAAO;QAChB,QAAQ,EAAE,QAAQ;QAClB,cAAc,EAAE,cAAc;KAC/B,CAAC;AACJ,CAAC,CAAC;AAhHW,QAAA,UAAU,cAgHrB","sourcesContent":["import React from \"react\";\n// @ts-expect-error missing types\nimport { ReactReduxContext } from \"@usereactify/search-internals/lib/utils\";\n// @ts-expect-error missing types\nimport { setValue } from \"@appbaseio/reactivecore/lib/actions\";\n\nimport { ConfigFilter, ConfigFilterFacet } from \"../types\";\nimport { useReactifySearchContext } from \"../hooks\";\nimport { debug } from \"../utility\";\n\nexport const useFilters = (): {\n  /** The currently selected filter stack, based on mode, curation and more */\n  filterStack?: ConfigFilter;\n  /** All of the available filters within the filter stack */\n  filters?: Array<ConfigFilterFacet>;\n  /** All of the selected filters with their value */\n  selected: Array<{\n    handle: string;\n    value: string | Array<string> | Array<{\n      label: string;\n      start: number;\n      end: number;\n    }>;\n  }>;\n  /** Clear filter by handle */\n  setFilterValue: (\n    handle: string,\n    value: string | Array<string> | [number, number]\n  ) => void;\n} => {\n  const { options, config } = useReactifySearchContext();\n  const reactivesearchContext = React.useContext<any>(ReactReduxContext);\n\n  const filterStack = React.useMemo(() => {\n    // select filters by type\n    const matchingFilterss = config.filters.filter(\n      (filter) => filter.type === options.mode\n    );\n\n    // select filter stack by handle if provided\n    if (options.filtersHandle) {\n      const matchingFilters = matchingFilterss.find(\n        (filterStack) => options.filtersHandle === filterStack.handle\n      );\n      if (matchingFilters) {\n        return matchingFilters;\n      }\n    }\n\n    // select filter stack by collection if provided\n    if (options.mode === \"collection\" && options.collectionHandle) {\n      const matchingFilters = matchingFilterss.find((filterStack) =>\n        filterStack.collections?.includes(options.collectionHandle)\n      );\n      if (matchingFilters) {\n        return matchingFilters;\n      }\n    }\n\n    // select filter with \"default\" handle\n    let matchingFilters = matchingFilterss.find(\n      (filterStack) => filterStack.handle === \"default\"\n    );\n    if (matchingFilters) {\n      return matchingFilters;\n    }\n\n    // select any filter with \"default\" handle\n    matchingFilters = config.filters.find(\n      (filterStack) => filterStack.handle === \"default\"\n    );\n    if (matchingFilters) {\n      return matchingFilters;\n    }\n\n    // select any available filter as a last resort\n    matchingFilters = config.filters[0];\n\n    return matchingFilters;\n  }, [\n    config,\n    options.mode === \"collection\" ? options.collectionHandle : undefined,\n  ]);\n\n  const filters = React.useMemo(() => {\n    const sortedFilters = filterStack?.options.sort((a, b) =>\n      a.position > b.position ? 1 : -1\n    );\n\n    return sortedFilters;\n  }, [filterStack]);\n\n  const selected = React.useMemo(() => {\n    return Object.keys(reactivesearchContext.storeState.selectedValues)\n      .filter((item) => filters.find((filter) => filter.handle === item))\n      .map((item) => ({\n        handle: item,\n        value: reactivesearchContext.storeState.selectedValues[item].value,\n      }));\n  }, [filters, reactivesearchContext?.storeState?.selectedValues]);\n\n  const setFilterValue = React.useCallback(\n    (\n      handle: string,\n      value: string | Array<string> | [number, number]\n    ): void => {\n      debug.log(\"useFilters\", \"setFilterValue[handle,value]\", handle, value);\n      reactivesearchContext.store.dispatch(setValue(handle, value));\n    },\n    [reactivesearchContext]\n  );\n\n  debug.hook(\"useFilters\", \"filterStack\", filterStack);\n  debug.hook(\"useFilters\", \"filters\", filters);\n  debug.hook(\"useFilters\", \"selected\", selected);\n\n  return {\n    filterStack: filterStack,\n    filters: filters,\n    selected: selected,\n    setFilterValue: setFilterValue,\n  };\n};\n"]}

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

@@ -1,8 +1,10 @@
-import { Sort, Filter, FilterOption, Redirect, Field, Curation } from "./firestore";
-export interface Config {
+import { Sort, FilterGroup, FilterFacet, Redirect, Relevance, Curation, Market, Antonym, Synonym, Callout } from "./firestore";
+export declare type Config = {
     index: string;
     endpoint: string;
+    cluster: string;
     version: string;
+    key: string;
     cache: {
         enabled: boolean;
         seconds: number;
@@ -12,7 +14,10 @@ export interface Config {
     filters: Array<ConfigFilter>;
     redirects: Array<ConfigRedirect>;
     curations: Array<ConfigCuration>;
-    markets: Array<ConfigMarket>;
+    antonyms: Array<ConfigAntonym>;
+    synonyms: Array<ConfigSynonym>;
+    callouts: Array<ConfigCallout>;
+    markets: Array<Market>;
     suggestions: {
         exclude: Array<string>;
     };
@@ -20,27 +25,24 @@ export interface Config {
         search: Array<unknown>;
         collection: Array<unknown>;
     };
-}
+};
+export declare type ConfigAntonym = Omit<Antonym, "enabled">;
+export declare type ConfigSynonym = Omit<Synonym, "enabled">;
+export declare type ConfigCallout = Omit<Callout, "enabled">;
 export declare type ConfigSort = Omit<Sort, "enabled">;
-export declare type ConfigField = Omit<Field, "enabled">;
+export declare type ConfigField = Omit<Relevance, "enabled">;
 export declare type ConfigRedirect = Omit<Redirect, "enabled" | "keywords">;
-export declare type ConfigFilter = Omit<Filter, "enabled" | "keywords"> & {
-    options: Omit<FilterOption, "enabled">[];
+export declare type ConfigFilter = Omit<FilterGroup, "enabled" | "keywords"> & {
+    options: Omit<FilterFacet, "enabled">[];
 };
-export declare type ConfigFilterOption = Omit<FilterOption, "enabled">;
+export declare type ConfigFilterFacet = Omit<FilterFacet, "enabled">;
 export declare type ConfigCuration = Omit<Curation, "keywords" | "boosting" | "longRunningTask" | "callouts"> & {
     boosting: {
-        groupings: (NonNullable<NonNullable<Curation["boosting"]>["groupings"]>[0] & {
+        groupings: Array<(NonNullable<NonNullable<Curation["boosting"]>["groupings"]>[0] & {
             query: string;
-        })[];
-        sortings: (NonNullable<NonNullable<Curation["boosting"]>["sortings"]>[0] & {
+        })>;
+        sortings: Array<(NonNullable<NonNullable<Curation["boosting"]>["sortings"]>[0] & {
             query: string;
-        })[];
+        })>;
     };
 };
-export declare type ConfigMarket = {
-    id: string;
-    label: string;
-    handle: string;
-    enabled: boolean;
-};

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

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/types/config.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  Sort,\n  Filter,\n  FilterOption,\n  Redirect,\n  Field,\n  Curation,\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\nexport interface Config {\n  index: string;\n  endpoint: string;\n  version: string;\n  cache: {\n    enabled: boolean;\n    seconds: number;\n  };\n  sort: Array<ConfigSort>;\n  fields: Array<ConfigField>;\n  filters: Array<ConfigFilter>;\n  redirects: Array<ConfigRedirect>;\n  curations: Array<ConfigCuration>;\n  markets: Array<ConfigMarket>;\n  suggestions: {\n    exclude: Array<string>;\n  };\n  sensors: {\n    search: Array<unknown>;\n    collection: Array<unknown>;\n  };\n}\n\nexport type ConfigSort = Omit<Sort, \"enabled\">;\nexport type ConfigField = Omit<Field, \"enabled\">;\nexport type ConfigRedirect = Omit<Redirect, \"enabled\" | \"keywords\">;\nexport type ConfigFilter = Omit<Filter, \"enabled\" | \"keywords\"> & {\n  options: Omit<FilterOption, \"enabled\">[];\n};\nexport type ConfigFilterOption = Omit<FilterOption, \"enabled\">;\nexport type ConfigCuration = Omit<\n  Curation,\n  \"keywords\" | \"boosting\" | \"longRunningTask\" | \"callouts\"\n> & {\n  boosting: {\n    groupings: (NonNullable<\n      NonNullable<Curation[\"boosting\"]>[\"groupings\"]\n    >[0] & { query: string })[];\n    sortings: (NonNullable<NonNullable<Curation[\"boosting\"]>[\"sortings\"]>[0] & {\n      query: string;\n    })[];\n  };\n};\nexport type ConfigMarket = {\n  id: string;\n  label: string;\n  handle: string;\n  enabled: boolean;\n}"]}
+{"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 } 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  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};"]}

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

@@ -12,7 +12,7 @@ export interface ElasticCallout {
     /** elastic callouts are always published */
     published: true;
     /** elastic callouts are always attached to one curation */
-    curations: [ElasticCuration];
+    curations: [ElasticCuration] | [];
 }
 export interface ElasticProduct {
     type: ElasticDocumentType.Product;

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;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"]}
+{"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"]}