@usereactify/search 5.0.0-beta.8 → 5.0.1

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

@@ -1,14 +1,24 @@
 import React from "react";
 import { ReactivesearchPaginationProps } from "../types";
 export declare const usePagination: (input: ReactivesearchPaginationProps) => {
+    /** The current page number, indexed from 0 */
     currentPage: number;
+    /** The total amount of pages */
     totalPages: number;
+    /** The total amount of pages to show within pagination components */
     pagesToShow: Array<number>;
+    /** If there is a next page */
     hasNextPage: boolean;
+    /** If there is a previous page */
     hasPreviousPage: boolean;
+    /** The _actual_ current page number, indexed from 1 */
     actualCurrentPage: number;
+    /** Function to build a URL for a specific page number, useful for Href links */
     buildPagePath: (page: number) => string;
+    /** Function to change to the next page, if an event is provided the preventDefault() method will be called */
     handleNextPage: (event?: React.SyntheticEvent<Element, Event> | undefined) => void;
+    /** Function to change to the previous page, if an event is provided the preventDefault() method will be called */
     handlePreviousPage: (event?: React.SyntheticEvent<Element, Event> | undefined) => void;
+    /** Function to change to any page, if an event is provided the preventDefault() method will be called */
     handlePageChange: (pageNumber: number, event?: React.SyntheticEvent<Element, Event> | undefined) => void;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"usePagination.js","sourceRoot":"","sources":["../../../src/hooks/usePagination.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAG1B,oCAAwC;AACxC,wCAAmC;AAE5B,MAAM,aAAa,GAAG,CAC3B,KAAoC,EAYpC,EAAE;IACF,MAAM,EAAE,KAAK,EAAE,GAAG,IAAA,oBAAY,GAAE,CAAC;IAEjC,MAAM,aAAa,GAAG,eAAK,CAAC,WAAW,CAAC,CAAC,IAAY,EAAE,EAAE;QACvD,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAE7C,OAAO,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC;YAClC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,WAAW,EAAE,QAAQ,IAAI,EAAE,CAAC;YAClD,CAAC,CAAC,GAAG,WAAW,GAAG,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,IAAI,EAAE,CAAC;IAC3E,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,WAAW,GAAG,eAAK,CAAC,OAAO,CAC/B,GAAG,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,WAAW,CAAC,EAChE,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,WAAW,CAAC,CACnD,CAAC;IAEF,8EAA8E;IAC9E,MAAM,iBAAiB,GAAG,eAAK,CAAC,OAAO,CACrC,GAAG,EAAE,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,EAC3B,CAAC,KAAK,CAAC,WAAW,CAAC,CACpB,CAAC;IAEF,MAAM,WAAW,GAAG,eAAK,CAAC,OAAO,CAC/B,GAAG,EAAE,CAAC,iBAAiB,GAAG,KAAK,CAAC,UAAU,EAC1C,CAAC,iBAAiB,EAAE,KAAK,CAAC,UAAU,CAAC,CACtC,CAAC;IAEF,MAAM,eAAe,GAAG,eAAK,CAAC,OAAO,CACnC,GAAG,EAAE,CAAC,iBAAiB,GAAG,CAAC,EAC3B,CAAC,iBAAiB,CAAC,CACpB,CAAC;IAEF,MAAM,OAAO,GAAG,eAAK,CAAC,WAAW,CAC/B,CAAC,UAAkB,EAAE,EAAE;QACrB,OAAO,UAAU,IAAI,CAAC,IAAI,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;IAC1D,CAAC,EACD,CAAC,KAAK,CAAC,UAAU,CAAC,CACnB,CAAC;IAEF,MAAM,gBAAgB,GAAG,eAAK,CAAC,WAAW,CAGxC,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE;QACpB,eAAK,CAAC,GAAG,CAAC,eAAe,EAAE,8BAA8B,EAAE,UAAU,CAAC,CAAC;QACvE,eAAK,CAAC,UAAU,CAAC;YACf,QAAQ,EAAE,YAAY;YACtB,OAAO,EAAE,oBAAoB;YAC7B,IAAI,EAAE;gBACJ,UAAU,EAAE,UAAU;aACvB;SACF,CAAC,CAAC;QACH,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,cAAc,EAAE,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YACxB,OAAO;SACR;QACD,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC1B,KAAK,CAAC;YACJ,SAAS,EAAE,kBAAkB;YAC7B,OAAO,EAAE;gBACP,IAAI,EAAE,UAAU;gBAChB,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC;oBAClD,CAAC,CAAC,QAAQ;oBACV,CAAC,CAAC,YAAY;aACjB;SACF,CAAC,CAAC;IACL,CAAC,EACD,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CACvB,CAAC;IAEF,MAAM,cAAc,GAAG,eAAK,CAAC,WAAW,CAGtC,CAAC,KAAK,EAAE,EAAE;QACR,eAAK,CAAC,GAAG,CAAC,eAAe,EAAE,gBAAgB,EAAE,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;QACpE,gBAAgB,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC,EACD,CAAC,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,gBAAgB,CAAC,CACnD,CAAC;IAEF,MAAM,kBAAkB,GAAG,eAAK,CAAC,WAAW,CAG1C,CAAC,KAAK,EAAE,EAAE;QACR,eAAK,CAAC,GAAG,CAAC,eAAe,EAAE,oBAAoB,EAAE,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;QACxE,gBAAgB,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC,EACD,CAAC,eAAe,EAAE,KAAK,CAAC,WAAW,EAAE,gBAAgB,CAAC,CACvD,CAAC;IAEF,OAAO,eAAK,CAAC,OAAO,CAClB,GAAG,EAAE,CAAC,CAAC;QACL,WAAW,EAAE,KAAK,CAAC,WAAW;QAC9B,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,WAAW;QACX,WAAW;QACX,aAAa;QACb,eAAe;QACf,iBAAiB;QACjB,cAAc;QACd,kBAAkB;QAClB,gBAAgB;KACjB,CAAC,EACF;QACE,KAAK,CAAC,WAAW;QACjB,KAAK,CAAC,UAAU;QAChB,WAAW;QACX,WAAW;QACX,aAAa;QACb,eAAe;QACf,iBAAiB;QACjB,cAAc;QACd,kBAAkB;QAClB,gBAAgB;KACjB,CACF,CAAC;AACJ,CAAC,CAAC;AAhIW,QAAA,aAAa,iBAgIxB;AAEF,6CAA6C;AAC7C,uDAAuD;AACvD,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAE,UAAkB,EAAE,WAAmB,EAAE,EAAE;IAC1E,MAAM,WAAW,GAAG,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC;IAC5D,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;IAC3C,IAAI,IAAI,GAAa,EAAE,CAAC;IACxB,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,UAAU,IAAI,CAAC,IAAI,WAAW,GAAG,MAAM,GAAG,CAAC,EAAE;QAC/C,KAAK,GAAG,CAAC,CAAC;KACX;SAAM;QACL,IAAI,UAAU,GAAG,MAAM,IAAI,WAAW,EAAE;YACtC,KAAK;gBACH,WAAW,GAAG,CAAC,KAAK,UAAU;oBAC5B,CAAC,CAAC,WAAW,GAAG,CAAC,WAAW,GAAG,CAAC,CAAC;oBACjC,CAAC,CAAC,WAAW,GAAG,CAAC,MAAM,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC;SAC3C;aAAM;YACL,KAAK,GAAG,WAAW,GAAG,MAAM,CAAC;SAC9B;KACF;IACD,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QACxD,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC;AACd,CAAC,CAAC","sourcesContent":["import React from \"react\";\n\nimport { ReactivesearchPaginationProps } from \"../types\";\nimport { useAnalytics } from \"../hooks\";\nimport { debug } from \"../utility\";\n\nexport const usePagination = (\n  input: ReactivesearchPaginationProps\n): {\n  currentPage: number;\n  totalPages: number;\n  pagesToShow: Array<number>;\n  hasNextPage: boolean;\n  hasPreviousPage: boolean;\n  actualCurrentPage: number;\n  buildPagePath: (page: number) => string;\n  handleNextPage: (event?: React.SyntheticEvent) => void;\n  handlePreviousPage: (event?: React.SyntheticEvent) => void;\n  handlePageChange: (pageNumber: number, event?: React.SyntheticEvent) => void;\n} => {\n  const { track } = useAnalytics();\n\n  const buildPagePath = React.useCallback((page: number) => {\n    const currentPath = window.location.pathname;\n\n    return currentPath.includes(\"page=\")\n      ? currentPath.replace(/page=\\d+/g, `page=${page}`)\n      : `${currentPath}${currentPath.includes(\"?\") ? \"&\" : \"?\"}page=${page}`;\n  }, []);\n\n  const pagesToShow = React.useMemo(\n    () => getPages(input.pages, input.totalPages, input.currentPage),\n    [input.pages, input.totalPages, input.currentPage]\n  );\n\n  // default input.currentPage is zero-indexed, actualCurrentPage is one-indexed\n  const actualCurrentPage = React.useMemo(\n    () => input.currentPage + 1,\n    [input.currentPage]\n  );\n\n  const hasNextPage = React.useMemo(\n    () => actualCurrentPage < input.totalPages,\n    [actualCurrentPage, input.totalPages]\n  );\n\n  const hasPreviousPage = React.useMemo(\n    () => actualCurrentPage > 1,\n    [actualCurrentPage]\n  );\n\n  const hasPage = React.useCallback(\n    (pageNumber: number) => {\n      return pageNumber >= 0 && pageNumber < input.totalPages;\n    },\n    [input.totalPages]\n  );\n\n  const handlePageChange = React.useCallback<\n    ReturnType<typeof usePagination>[\"handlePageChange\"]\n  >(\n    (pageNumber, event) => {\n      debug.log(\"usePagination\", \"handlePageChange[pageNumber]\", pageNumber);\n      debug.breadcrumb({\n        category: \"pagination\",\n        message: \"change page number\",\n        data: {\n          pageNumber: pageNumber,\n        },\n      });\n      event?.preventDefault();\n      if (!hasPage(pageNumber)) {\n        return;\n      }\n      input.setPage(pageNumber);\n      track({\n        eventName: \"paginationChange\",\n        payload: {\n          page: pageNumber,\n          source: window.location.pathname.includes(\"/search\")\n            ? \"search\"\n            : \"collection\",\n        },\n      });\n    },\n    [input.setPage, track]\n  );\n\n  const handleNextPage = React.useCallback<\n    ReturnType<typeof usePagination>[\"handleNextPage\"]\n  >(\n    (event) => {\n      debug.log(\"usePagination\", \"handleNextPage\", input.currentPage + 1);\n      handlePageChange(input.currentPage + 1, event);\n    },\n    [hasNextPage, input.currentPage, handlePageChange]\n  );\n\n  const handlePreviousPage = React.useCallback<\n    ReturnType<typeof usePagination>[\"handlePreviousPage\"]\n  >(\n    (event) => {\n      debug.log(\"usePagination\", \"handlePreviousPage\", input.currentPage - 1);\n      handlePageChange(input.currentPage - 1, event);\n    },\n    [hasPreviousPage, input.currentPage, handlePageChange]\n  );\n\n  return React.useMemo(\n    () => ({\n      currentPage: input.currentPage,\n      totalPages: input.totalPages,\n      pagesToShow,\n      hasNextPage,\n      buildPagePath,\n      hasPreviousPage,\n      actualCurrentPage,\n      handleNextPage,\n      handlePreviousPage,\n      handlePageChange,\n    }),\n    [\n      input.currentPage,\n      input.totalPages,\n      pagesToShow,\n      hasNextPage,\n      buildPagePath,\n      hasPreviousPage,\n      actualCurrentPage,\n      handleNextPage,\n      handlePreviousPage,\n      handlePageChange,\n    ]\n  );\n};\n\n// get a list of pages to display buttons for\n// @todo this is super hacky and needs to be cleaned up\nconst getPages = (pages: number, totalPages: number, currentPage: number) => {\n  const pagesToShow = pages > totalPages ? totalPages : pages;\n  const buffer = Math.floor(pagesToShow / 2);\n  let list: number[] = [];\n  let start = 0;\n  if (totalPages <= 5 || currentPage < buffer + 1) {\n    start = 0;\n  } else {\n    if (totalPages - buffer <= currentPage) {\n      start =\n        currentPage + 1 === totalPages\n          ? currentPage - (pagesToShow - 1)\n          : currentPage - (buffer + buffer / 2);\n    } else {\n      start = currentPage - buffer;\n    }\n  }\n  Array.apply(null, Array(pagesToShow)).map((item, index) => {\n    list.push(start + index);\n  });\n  return list;\n};\n"]}
+{"version":3,"file":"usePagination.js","sourceRoot":"","sources":["../../../src/hooks/usePagination.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAG1B,oCAAwC;AACxC,wCAAmC;AAE5B,MAAM,aAAa,GAAG,CAC3B,KAAoC,EAsBpC,EAAE;IACF,MAAM,EAAE,KAAK,EAAE,GAAG,IAAA,oBAAY,GAAE,CAAC;IAEjC,MAAM,aAAa,GAAG,eAAK,CAAC,WAAW,CAAC,CAAC,IAAY,EAAE,EAAE;QACvD,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAE7C,OAAO,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC;YAClC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,WAAW,EAAE,QAAQ,IAAI,EAAE,CAAC;YAClD,CAAC,CAAC,GAAG,WAAW,GAAG,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,IAAI,EAAE,CAAC;IAC3E,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,WAAW,GAAG,eAAK,CAAC,OAAO,CAC/B,GAAG,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,WAAW,CAAC,EAChE,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,WAAW,CAAC,CACnD,CAAC;IAEF,8EAA8E;IAC9E,MAAM,iBAAiB,GAAG,eAAK,CAAC,OAAO,CACrC,GAAG,EAAE,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,EAC3B,CAAC,KAAK,CAAC,WAAW,CAAC,CACpB,CAAC;IAEF,MAAM,WAAW,GAAG,eAAK,CAAC,OAAO,CAC/B,GAAG,EAAE,CAAC,iBAAiB,GAAG,KAAK,CAAC,UAAU,EAC1C,CAAC,iBAAiB,EAAE,KAAK,CAAC,UAAU,CAAC,CACtC,CAAC;IAEF,MAAM,eAAe,GAAG,eAAK,CAAC,OAAO,CACnC,GAAG,EAAE,CAAC,iBAAiB,GAAG,CAAC,EAC3B,CAAC,iBAAiB,CAAC,CACpB,CAAC;IAEF,MAAM,OAAO,GAAG,eAAK,CAAC,WAAW,CAC/B,CAAC,UAAkB,EAAE,EAAE;QACrB,OAAO,UAAU,IAAI,CAAC,IAAI,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;IAC1D,CAAC,EACD,CAAC,KAAK,CAAC,UAAU,CAAC,CACnB,CAAC;IAEF,MAAM,gBAAgB,GAAG,eAAK,CAAC,WAAW,CAGxC,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE;QACpB,eAAK,CAAC,GAAG,CAAC,eAAe,EAAE,8BAA8B,EAAE,UAAU,CAAC,CAAC;QACvE,eAAK,CAAC,UAAU,CAAC;YACf,QAAQ,EAAE,YAAY;YACtB,OAAO,EAAE,oBAAoB;YAC7B,IAAI,EAAE;gBACJ,UAAU,EAAE,UAAU;aACvB;SACF,CAAC,CAAC;QACH,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,cAAc,EAAE,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YACxB,OAAO;SACR;QACD,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC1B,KAAK,CAAC;YACJ,SAAS,EAAE,kBAAkB;YAC7B,OAAO,EAAE;gBACP,IAAI,EAAE,UAAU;gBAChB,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC;oBAClD,CAAC,CAAC,QAAQ;oBACV,CAAC,CAAC,YAAY;aACjB;SACF,CAAC,CAAC;IACL,CAAC,EACD,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CACvB,CAAC;IAEF,MAAM,cAAc,GAAG,eAAK,CAAC,WAAW,CAGtC,CAAC,KAAK,EAAE,EAAE;QACR,eAAK,CAAC,GAAG,CAAC,eAAe,EAAE,gBAAgB,EAAE,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;QACpE,gBAAgB,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC,EACD,CAAC,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,gBAAgB,CAAC,CACnD,CAAC;IAEF,MAAM,kBAAkB,GAAG,eAAK,CAAC,WAAW,CAG1C,CAAC,KAAK,EAAE,EAAE;QACR,eAAK,CAAC,GAAG,CAAC,eAAe,EAAE,oBAAoB,EAAE,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;QACxE,gBAAgB,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;IACjD,CAAC,EACD,CAAC,eAAe,EAAE,KAAK,CAAC,WAAW,EAAE,gBAAgB,CAAC,CACvD,CAAC;IAEF,OAAO,eAAK,CAAC,OAAO,CAClB,GAAG,EAAE,CAAC,CAAC;QACL,WAAW,EAAE,KAAK,CAAC,WAAW;QAC9B,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,WAAW;QACX,WAAW;QACX,aAAa;QACb,eAAe;QACf,iBAAiB;QACjB,cAAc;QACd,kBAAkB;QAClB,gBAAgB;KACjB,CAAC,EACF;QACE,KAAK,CAAC,WAAW;QACjB,KAAK,CAAC,UAAU;QAChB,WAAW;QACX,WAAW;QACX,aAAa;QACb,eAAe;QACf,iBAAiB;QACjB,cAAc;QACd,kBAAkB;QAClB,gBAAgB;KACjB,CACF,CAAC;AACJ,CAAC,CAAC;AA1IW,QAAA,aAAa,iBA0IxB;AAEF,6CAA6C;AAC7C,uDAAuD;AACvD,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAE,UAAkB,EAAE,WAAmB,EAAE,EAAE;IAC1E,MAAM,WAAW,GAAG,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC;IAC5D,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;IAC3C,IAAI,IAAI,GAAa,EAAE,CAAC;IACxB,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,UAAU,IAAI,CAAC,IAAI,WAAW,GAAG,MAAM,GAAG,CAAC,EAAE;QAC/C,KAAK,GAAG,CAAC,CAAC;KACX;SAAM;QACL,IAAI,UAAU,GAAG,MAAM,IAAI,WAAW,EAAE;YACtC,KAAK;gBACH,WAAW,GAAG,CAAC,KAAK,UAAU;oBAC5B,CAAC,CAAC,WAAW,GAAG,CAAC,WAAW,GAAG,CAAC,CAAC;oBACjC,CAAC,CAAC,WAAW,GAAG,CAAC,MAAM,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC;SAC3C;aAAM;YACL,KAAK,GAAG,WAAW,GAAG,MAAM,CAAC;SAC9B;KACF;IACD,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QACxD,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC;AACd,CAAC,CAAC","sourcesContent":["import React from \"react\";\n\nimport { ReactivesearchPaginationProps } from \"../types\";\nimport { useAnalytics } from \"../hooks\";\nimport { debug } from \"../utility\";\n\nexport const usePagination = (\n  input: ReactivesearchPaginationProps\n): {\n  /** The current page number, indexed from 0 */\n  currentPage: number;\n  /** The total amount of pages */\n  totalPages: number;\n  /** The total amount of pages to show within pagination components */\n  pagesToShow: Array<number>;\n  /** If there is a next page */\n  hasNextPage: boolean;\n  /** If there is a previous page */\n  hasPreviousPage: boolean;\n  /** The _actual_ current page number, indexed from 1 */\n  actualCurrentPage: number;\n  /** Function to build a URL for a specific page number, useful for Href links */\n  buildPagePath: (page: number) => string;\n  /** Function to change to the next page, if an event is provided the preventDefault() method will be called */\n  handleNextPage: (event?: React.SyntheticEvent) => void;\n  /** Function to change to the previous page, if an event is provided the preventDefault() method will be called */\n  handlePreviousPage: (event?: React.SyntheticEvent) => void;\n  /** Function to change to any page, if an event is provided the preventDefault() method will be called */\n  handlePageChange: (pageNumber: number, event?: React.SyntheticEvent) => void;\n} => {\n  const { track } = useAnalytics();\n\n  const buildPagePath = React.useCallback((page: number) => {\n    const currentPath = window.location.pathname;\n\n    return currentPath.includes(\"page=\")\n      ? currentPath.replace(/page=\\d+/g, `page=${page}`)\n      : `${currentPath}${currentPath.includes(\"?\") ? \"&\" : \"?\"}page=${page}`;\n  }, []);\n\n  const pagesToShow = React.useMemo(\n    () => getPages(input.pages, input.totalPages, input.currentPage),\n    [input.pages, input.totalPages, input.currentPage]\n  );\n\n  // default input.currentPage is zero-indexed, actualCurrentPage is one-indexed\n  const actualCurrentPage = React.useMemo(\n    () => input.currentPage + 1,\n    [input.currentPage]\n  );\n\n  const hasNextPage = React.useMemo(\n    () => actualCurrentPage < input.totalPages,\n    [actualCurrentPage, input.totalPages]\n  );\n\n  const hasPreviousPage = React.useMemo(\n    () => actualCurrentPage > 1,\n    [actualCurrentPage]\n  );\n\n  const hasPage = React.useCallback(\n    (pageNumber: number) => {\n      return pageNumber >= 0 && pageNumber < input.totalPages;\n    },\n    [input.totalPages]\n  );\n\n  const handlePageChange = React.useCallback<\n    ReturnType<typeof usePagination>[\"handlePageChange\"]\n  >(\n    (pageNumber, event) => {\n      debug.log(\"usePagination\", \"handlePageChange[pageNumber]\", pageNumber);\n      debug.breadcrumb({\n        category: \"pagination\",\n        message: \"change page number\",\n        data: {\n          pageNumber: pageNumber,\n        },\n      });\n      event?.preventDefault();\n      if (!hasPage(pageNumber)) {\n        return;\n      }\n      input.setPage(pageNumber);\n      track({\n        eventName: \"paginationChange\",\n        payload: {\n          page: pageNumber,\n          source: window.location.pathname.includes(\"/search\")\n            ? \"search\"\n            : \"collection\",\n        },\n      });\n    },\n    [input.setPage, track]\n  );\n\n  const handleNextPage = React.useCallback<\n    ReturnType<typeof usePagination>[\"handleNextPage\"]\n  >(\n    (event) => {\n      debug.log(\"usePagination\", \"handleNextPage\", input.currentPage + 1);\n      handlePageChange(input.currentPage + 1, event);\n    },\n    [hasNextPage, input.currentPage, handlePageChange]\n  );\n\n  const handlePreviousPage = React.useCallback<\n    ReturnType<typeof usePagination>[\"handlePreviousPage\"]\n  >(\n    (event) => {\n      debug.log(\"usePagination\", \"handlePreviousPage\", input.currentPage - 1);\n      handlePageChange(input.currentPage - 1, event);\n    },\n    [hasPreviousPage, input.currentPage, handlePageChange]\n  );\n\n  return React.useMemo(\n    () => ({\n      currentPage: input.currentPage,\n      totalPages: input.totalPages,\n      pagesToShow,\n      hasNextPage,\n      buildPagePath,\n      hasPreviousPage,\n      actualCurrentPage,\n      handleNextPage,\n      handlePreviousPage,\n      handlePageChange,\n    }),\n    [\n      input.currentPage,\n      input.totalPages,\n      pagesToShow,\n      hasNextPage,\n      buildPagePath,\n      hasPreviousPage,\n      actualCurrentPage,\n      handleNextPage,\n      handlePreviousPage,\n      handlePageChange,\n    ]\n  );\n};\n\n// get a list of pages to display buttons for\n// @todo this is super hacky and needs to be cleaned up\nconst getPages = (pages: number, totalPages: number, currentPage: number) => {\n  const pagesToShow = pages > totalPages ? totalPages : pages;\n  const buffer = Math.floor(pagesToShow / 2);\n  let list: number[] = [];\n  let start = 0;\n  if (totalPages <= 5 || currentPage < buffer + 1) {\n    start = 0;\n  } else {\n    if (totalPages - buffer <= currentPage) {\n      start =\n        currentPage + 1 === totalPages\n          ? currentPage - (pagesToShow - 1)\n          : currentPage - (buffer + buffer / 2);\n    } else {\n      start = currentPage - buffer;\n    }\n  }\n  Array.apply(null, Array(pagesToShow)).map((item, index) => {\n    list.push(start + index);\n  });\n  return list;\n};\n"]}

package/dist/src/hooks/usePaginationLoadMore.js

@@ -9,7 +9,7 @@ const hooks_1 = require("../hooks");
 const utility_1 = require("../utility");
 const usePaginationLoadMore = (input) => {
     const analyticsHook = (0, hooks_1.useAnalytics)();
-    const { filterStack } = (0, hooks_1.useFilterStack)();
+    const { filterStack } = (0, hooks_1.useFilters)();
     const hasMore = input.resultStats.displayedResults !== input.resultStats.numberOfResults;
     const handleLoadMore = react_1.default.useCallback(() => {
         utility_1.debug.log("usePaginationLoadMore", "handleLoadMore");

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

@@ -1 +1 @@
-{"version":3,"file":"usePaginationLoadMore.js","sourceRoot":"","sources":["../../../src/hooks/usePaginationLoadMore.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAG1B,oCAAwD;AACxD,wCAAmC;AAE5B,MAAM,qBAAqB,GAAG,CACnC,KAAgC,EAchC,EAAE;IACF,MAAM,aAAa,GAAG,IAAA,oBAAY,GAAE,CAAC;IACrC,MAAM,EAAE,WAAW,EAAE,GAAG,IAAA,sBAAc,GAAE,CAAC;IAEzC,MAAM,OAAO,GACX,KAAK,CAAC,WAAW,CAAC,gBAAgB,KAAK,KAAK,CAAC,WAAW,CAAC,eAAe,CAAC;IAE3E,MAAM,cAAc,GAAG,eAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QAC5C,eAAK,CAAC,GAAG,CAAC,uBAAuB,EAAE,gBAAgB,CAAC,CAAC;QAErD,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO;SACR;QAED,KAAK,CAAC,QAAQ,EAAE,CAAC;QACjB,aAAa,CAAC,KAAK,CAAC;YAClB,SAAS,EAAE,kBAAkB;YAC7B,OAAO,EAAE;gBACP,IAAI,EACF,IAAI,CAAC,IAAI,CACP,KAAK,CAAC,WAAW,CAAC,gBAAgB,GAAG,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,QAAQ,KAAI,EAAE,CAAC,CACnE,GAAG,CAAC;gBACP,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC;oBAClD,CAAC,CAAC,QAAQ;oBACV,CAAC,CAAC,YAAY;aACjB;SACF,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;IAE1E,OAAO,eAAK,CAAC,OAAO,CAClB,GAAG,EAAE,CAAC,CAAC;QACL,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,OAAO;QACP,cAAc;QACd,WAAW,EAAE,KAAK,CAAC,WAAW;KAC/B,CAAC,EACF,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,KAAK,CAAC,WAAW,CAAC,CAC5D,CAAC;AACJ,CAAC,CAAC;AArDW,QAAA,qBAAqB,yBAqDhC","sourcesContent":["import React from \"react\";\n\nimport { ReactivesearchResultProps } from \"../types\";\nimport { useAnalytics, useFilterStack } from \"../hooks\";\nimport { debug } from \"../utility\";\n\nexport const usePaginationLoadMore = (\n  input: ReactivesearchResultProps\n): {\n  loading: boolean;\n  hasMore: boolean;\n  handleLoadMore: () => void;\n  resultStats: {\n    time: number;\n    hidden: number;\n    promoted: number;\n    currentPage: number;\n    numberOfPages: number;\n    numberOfResults?: number;\n    displayedResults: number;\n  };\n} => {\n  const analyticsHook = useAnalytics();\n  const { filterStack } = useFilterStack();\n\n  const hasMore =\n    input.resultStats.displayedResults !== input.resultStats.numberOfResults;\n\n  const handleLoadMore = React.useCallback(() => {\n    debug.log(\"usePaginationLoadMore\", \"handleLoadMore\");\n\n    if (!hasMore) {\n      return;\n    }\n\n    input.loadMore();\n    analyticsHook.track({\n      eventName: \"paginationChange\",\n      payload: {\n        page:\n          Math.ceil(\n            input.resultStats.displayedResults / (filterStack?.pageSize || 20)\n          ) + 1,\n        source: window.location.pathname.includes(\"/search\")\n          ? \"search\"\n          : \"collection\",\n      },\n    });\n  }, [input.loadMore, analyticsHook.track, input.resultStats, filterStack]);\n\n  return React.useMemo(\n    () => ({\n      loading: input.loading,\n      hasMore,\n      handleLoadMore,\n      resultStats: input.resultStats,\n    }),\n    [input.loading, hasMore, handleLoadMore, input.resultStats]\n  );\n};\n"]}
+{"version":3,"file":"usePaginationLoadMore.js","sourceRoot":"","sources":["../../../src/hooks/usePaginationLoadMore.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAG1B,oCAAoD;AACpD,wCAAmC;AAE5B,MAAM,qBAAqB,GAAG,CACnC,KAAgC,EAchC,EAAE;IACF,MAAM,aAAa,GAAG,IAAA,oBAAY,GAAE,CAAC;IACrC,MAAM,EAAE,WAAW,EAAE,GAAG,IAAA,kBAAU,GAAE,CAAC;IAErC,MAAM,OAAO,GACX,KAAK,CAAC,WAAW,CAAC,gBAAgB,KAAK,KAAK,CAAC,WAAW,CAAC,eAAe,CAAC;IAE3E,MAAM,cAAc,GAAG,eAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QAC5C,eAAK,CAAC,GAAG,CAAC,uBAAuB,EAAE,gBAAgB,CAAC,CAAC;QAErD,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO;SACR;QAED,KAAK,CAAC,QAAQ,EAAE,CAAC;QACjB,aAAa,CAAC,KAAK,CAAC;YAClB,SAAS,EAAE,kBAAkB;YAC7B,OAAO,EAAE;gBACP,IAAI,EACF,IAAI,CAAC,IAAI,CACP,KAAK,CAAC,WAAW,CAAC,gBAAgB,GAAG,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,QAAQ,KAAI,EAAE,CAAC,CACnE,GAAG,CAAC;gBACP,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC;oBAClD,CAAC,CAAC,QAAQ;oBACV,CAAC,CAAC,YAAY;aACjB;SACF,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;IAE1E,OAAO,eAAK,CAAC,OAAO,CAClB,GAAG,EAAE,CAAC,CAAC;QACL,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,OAAO;QACP,cAAc;QACd,WAAW,EAAE,KAAK,CAAC,WAAW;KAC/B,CAAC,EACF,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,KAAK,CAAC,WAAW,CAAC,CAC5D,CAAC;AACJ,CAAC,CAAC;AArDW,QAAA,qBAAqB,yBAqDhC","sourcesContent":["import React from \"react\";\n\nimport { ReactivesearchResultProps } from \"../types\";\nimport { useAnalytics, useFilters } from \"../hooks\";\nimport { debug } from \"../utility\";\n\nexport const usePaginationLoadMore = (\n  input: ReactivesearchResultProps\n): {\n  loading: boolean;\n  hasMore: boolean;\n  handleLoadMore: () => void;\n  resultStats: {\n    time: number;\n    hidden: number;\n    promoted: number;\n    currentPage: number;\n    numberOfPages: number;\n    numberOfResults?: number;\n    displayedResults: number;\n  };\n} => {\n  const analyticsHook = useAnalytics();\n  const { filterStack } = useFilters();\n\n  const hasMore =\n    input.resultStats.displayedResults !== input.resultStats.numberOfResults;\n\n  const handleLoadMore = React.useCallback(() => {\n    debug.log(\"usePaginationLoadMore\", \"handleLoadMore\");\n\n    if (!hasMore) {\n      return;\n    }\n\n    input.loadMore();\n    analyticsHook.track({\n      eventName: \"paginationChange\",\n      payload: {\n        page:\n          Math.ceil(\n            input.resultStats.displayedResults / (filterStack?.pageSize || 20)\n          ) + 1,\n        source: window.location.pathname.includes(\"/search\")\n          ? \"search\"\n          : \"collection\",\n      },\n    });\n  }, [input.loadMore, analyticsHook.track, input.resultStats, filterStack]);\n\n  return React.useMemo(\n    () => ({\n      loading: input.loading,\n      hasMore,\n      handleLoadMore,\n      resultStats: input.resultStats,\n    }),\n    [input.loading, hasMore, handleLoadMore, input.resultStats]\n  );\n};\n"]}

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

@@ -6,7 +6,7 @@ export declare const ReactifySearchContext: React.Context<{
         mode: "search" | "collection" | "instant-search";
         index: string;
         shopifyPermanentDomain: string;
-        filterStackHandle?: string | undefined;
+        filtersHandle?: string | undefined;
         credentials: {
             username: string;
             password: string;
@@ -19,19 +19,15 @@ export declare const ReactifySearchContext: React.Context<{
         mode: "search";
     } | {
         mode: "collection";
-        collection: {
-            id: number;
-            handle: string;
-            title: string;
-        };
+        collectionHandle: string;
     } | {
         mode: "instant-search";
     });
     search: {
-        searchQuery: string;
-        setSearchQuery: React.Dispatch<React.SetStateAction<string>>;
-        instantSearchVisible: boolean;
-        setInstantSearchVisible: React.Dispatch<React.SetStateAction<boolean>>;
+        searchTerm: string;
+        setSearchTerm: React.Dispatch<React.SetStateAction<string>>;
+        showInstantSearchResults: boolean;
+        setShowInstantSearchResults: React.Dispatch<React.SetStateAction<boolean>>;
     };
     sortby: {
         sortOption: string;
@@ -44,7 +40,7 @@ export declare const useReactifySearchContext: () => {
         mode: "search" | "collection" | "instant-search";
         index: string;
         shopifyPermanentDomain: string;
-        filterStackHandle?: string | undefined;
+        filtersHandle?: string | undefined;
         credentials: {
             username: string;
             password: string;
@@ -57,19 +53,15 @@ export declare const useReactifySearchContext: () => {
         mode: "search";
     } | {
         mode: "collection";
-        collection: {
-            id: number;
-            handle: string;
-            title: string;
-        };
+        collectionHandle: string;
     } | {
         mode: "instant-search";
     });
     search: {
-        searchQuery: string;
-        setSearchQuery: React.Dispatch<React.SetStateAction<string>>;
-        instantSearchVisible: boolean;
-        setInstantSearchVisible: React.Dispatch<React.SetStateAction<boolean>>;
+        searchTerm: string;
+        setSearchTerm: React.Dispatch<React.SetStateAction<string>>;
+        showInstantSearchResults: boolean;
+        setShowInstantSearchResults: React.Dispatch<React.SetStateAction<boolean>>;
     };
     sortby: {
         sortOption: string;

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

@@ -1 +1 @@
-{"version":3,"file":"useReactifySearchContext.js","sourceRoot":"","sources":["../../../src/hooks/useReactifySearchContext.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAIb,QAAA,qBAAqB,GAAG,eAAK,CAAC,aAAa,CAqCzC,SAAS,CAAC,CAAC;AAEnB,MAAM,wBAAwB,GAAG,GAAG,EAAE,CAAC,eAAK,CAAC,UAAU,CAAC,6BAAqB,CAAE,CAAC;AAA1E,QAAA,wBAAwB,4BAAkD","sourcesContent":["import React from \"react\";\n\nimport { Config } from \"../types\";\n\nexport const ReactifySearchContext = React.createContext<{\n\tconfig: Config,\n\toptions: {\n\t\tmode: \"search\" | \"collection\" | \"instant-search\";\n\t\tindex: string;\n\t\tshopifyPermanentDomain: string;\n\t\tfilterStackHandle?: string;\n\t\tcredentials: {\n\t\t  username: string;\n\t\t  password: string;\n\t\t  endpoint: string;\n\t\t};\n\t\tonRedirect?: (type: \"redirect\" | \"search\", url: string) => void;\n\t\ttheme: Record<string, unknown>;\n\t  additionalComponentHandles?: Array<string>;\n\t} & ({\n\t  mode: \"search\";\n\t} | {\n\t  mode: \"collection\";\n\t  collection: {\n\t\t  id: number;\n\t\t  handle: string;\n\t\t  title: string;\n\t  };\n\t} | {\n\t  mode: \"instant-search\";\n\t}),\n\tsearch: {\n\t\tsearchQuery: string;\n\t\tsetSearchQuery: React.Dispatch<React.SetStateAction<string>>;\n\t\tinstantSearchVisible: boolean;\n\t\tsetInstantSearchVisible: React.Dispatch<React.SetStateAction<boolean>>;\n\t},\n\tsortby: {\n\t\tsortOption: string;\n\t\tsetSortOption: React.Dispatch<React.SetStateAction<string>>;\n\t},\n} | undefined>(undefined);\n\nexport const useReactifySearchContext = () => React.useContext(ReactifySearchContext)!;"]}
+{"version":3,"file":"useReactifySearchContext.js","sourceRoot":"","sources":["../../../src/hooks/useReactifySearchContext.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAIb,QAAA,qBAAqB,GAAG,eAAK,CAAC,aAAa,CA0CtD,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 } from \"../types\";\n\nexport const ReactifySearchContext = React.createContext<\n  | {\n      config: Config;\n      options: {\n        mode: \"search\" | \"collection\" | \"instant-search\";\n        index: string;\n        shopifyPermanentDomain: string;\n        filtersHandle?: string;\n        credentials: {\n          username: string;\n          password: string;\n          endpoint: string;\n        };\n        onRedirect?: (type: \"redirect\" | \"search\", url: string) => void;\n        theme: Record<string, unknown>;\n        additionalComponentHandles?: Array<string>;\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      };\n      sortby: {\n        sortOption: string;\n        setSortOption: React.Dispatch<React.SetStateAction<string>>;\n      };\n    }\n  | undefined\n>(undefined);\n\nexport const useReactifySearchContext = () =>\n  React.useContext(ReactifySearchContext)!;\n"]}

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

@@ -1,8 +1,13 @@
 import React from "react";
 export declare const useSearch: () => {
-    searchQuery: string;
-    setSearchQuery: React.Dispatch<React.SetStateAction<string>>;
-    submitSearch: (searchQuery?: string | undefined) => void;
+    /** The current search term */
+    searchTerm: string;
+    /** Function for changing the current search term */
+    setSearchTerm: (searchTerm?: string | undefined) => void;
+    /** Function for navigating to the search page, includes logic for redirects */
+    submitSearchTerm: (searchTerm?: string | undefined) => void;
+    /** Used to determine if instant search results should be displayed */
     showInstantSearchResults: boolean;
+    /** Used to manually set the "showInstantSearchResults" value */
     setShowInstantSearchResults: React.Dispatch<React.SetStateAction<boolean>>;
 };

package/dist/src/hooks/useSearch.js

@@ -4,46 +4,68 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useSearch = void 0;
+const ahooks_1 = require("ahooks");
 const react_1 = __importDefault(require("react"));
 const hooks_1 = require("../hooks");
 const utility_1 = require("../utility");
 const useSearch = () => {
     const { options, config, search } = (0, hooks_1.useReactifySearchContext)();
-    const handleSubmitSearch = react_1.default.useCallback((searchQuery = search.searchQuery) => {
+    const handleSubmitSearchTerm = react_1.default.useCallback((searchTerm = search.searchTerm) => {
         utility_1.debug.breadcrumb({
             category: "search",
-            message: "search submitted",
+            message: "search submit",
             data: {
-                searchQuery: searchQuery,
+                searchTerm: searchTerm,
             },
         });
-        utility_1.debug.log("useSearch", "submitSearch[query]", searchQuery);
-        if (!searchQuery) {
+        utility_1.debug.log("useSearch", "submitSearchTerm[query]", searchTerm);
+        if (!searchTerm) {
             return;
         }
         const redirect = config.redirects.find((redirect) => redirect.query.trim().toLowerCase() ===
-            searchQuery.trim().toLowerCase());
+            searchTerm.trim().toLowerCase());
         if (redirect) {
-            utility_1.debug.log("useSearch", "submitSearch[redirect]", redirect);
+            utility_1.debug.log("useSearch", "submitSearchTerm[redirect]", redirect);
         }
-        search.setInstantSearchVisible(false);
+        search.setShowInstantSearchResults(false);
         if (options.onRedirect) {
-            options.onRedirect(redirect ? "redirect" : "search", redirect ? redirect.url : `/search?q=${searchQuery}`);
+            options.onRedirect(redirect ? "redirect" : "search", redirect ? redirect.url : `/search?q=${searchTerm}`);
         }
         else if (redirect) {
             window.location.href = redirect.url;
         }
         else {
-            window.location.href = `/search?q=${searchQuery}`;
+            window.location.href = `/search?q=${searchTerm}`;
         }
-    }, [search.searchQuery]);
-    utility_1.debug.hook("useSearch", "searchQuery", search.searchQuery);
+    }, [search.searchTerm]);
+    const { run: runDebouncedBreadcrumb, cancel: cancelDebouncedBreadcrumb } = (0, ahooks_1.useDebounceFn)((searchTerm = search.searchTerm) => {
+        utility_1.debug.log("useSearch", "setSearchTerm[searchTerm]", searchTerm);
+        utility_1.debug.breadcrumb({
+            category: "search",
+            message: "search query",
+            data: {
+                searchTerm: searchTerm,
+            },
+        });
+    }, {
+        wait: 300,
+    });
+    const handleSetSearchTerm = react_1.default.useCallback((searchTerm = "") => {
+        utility_1.debug.log("useSearch", "setSearchTerm[searchTerm]", searchTerm);
+        if (searchTerm) {
+            runDebouncedBreadcrumb(searchTerm);
+        }
+        else {
+            cancelDebouncedBreadcrumb();
+        }
+        search.setSearchTerm(searchTerm);
+    }, [search.searchTerm]);
     return {
-        searchQuery: search.searchQuery,
-        setSearchQuery: search.setSearchQuery,
-        submitSearch: handleSubmitSearch,
-        showInstantSearchResults: !!search.instantSearchVisible && !!search.searchQuery,
-        setShowInstantSearchResults: search.setInstantSearchVisible,
+        searchTerm: search.searchTerm,
+        setSearchTerm: handleSetSearchTerm,
+        submitSearchTerm: handleSubmitSearchTerm,
+        showInstantSearchResults: !!search.showInstantSearchResults && !!search.searchTerm,
+        setShowInstantSearchResults: search.setShowInstantSearchResults,
     };
 };
 exports.useSearch = useSearch;

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

@@ -1 +1 @@
-{"version":3,"file":"useSearch.js","sourceRoot":"","sources":["../../../src/hooks/useSearch.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAE1B,oCAAoD;AACpD,wCAAmC;AAE5B,MAAM,SAAS,GAAG,GAMvB,EAAE;IACF,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAA,gCAAwB,GAAE,CAAC;IAE/D,MAAM,kBAAkB,GAAG,eAAK,CAAC,WAAW,CAC1C,CAAC,cAAsB,MAAM,CAAC,WAAW,EAAE,EAAE;QAC3C,eAAK,CAAC,UAAU,CAAC;YACf,QAAQ,EAAE,QAAQ;YAClB,OAAO,EAAE,kBAAkB;YAC3B,IAAI,EAAE;gBACJ,WAAW,EAAE,WAAW;aACzB;SACF,CAAC,CAAC;QAEH,eAAK,CAAC,GAAG,CAAC,WAAW,EAAE,qBAAqB,EAAE,WAAW,CAAC,CAAC;QAE3D,IAAI,CAAC,WAAW,EAAE;YAChB,OAAO;SACR;QAED,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,CACpC,CAAC,QAAQ,EAAE,EAAE,CACX,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,WAAW,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CACnC,CAAC;QAEF,IAAI,QAAQ,EAAE;YACZ,eAAK,CAAC,GAAG,CAAC,WAAW,EAAE,wBAAwB,EAAE,QAAQ,CAAC,CAAC;SAC5D;QAED,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,WAAW,EAAE,CACrD,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,WAAW,EAAE,CAAC;SACnD;IACH,CAAC,EACD,CAAC,MAAM,CAAC,WAAW,CAAC,CACrB,CAAC;IAEF,eAAK,CAAC,IAAI,CAAC,WAAW,EAAE,aAAa,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;IAE3D,OAAO;QACL,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,YAAY,EAAE,kBAAkB;QAChC,wBAAwB,EACtB,CAAC,CAAC,MAAM,CAAC,oBAAoB,IAAI,CAAC,CAAC,MAAM,CAAC,WAAW;QACvD,2BAA2B,EAAE,MAAM,CAAC,uBAAuB;KAC5D,CAAC;AACJ,CAAC,CAAC;AA7DW,QAAA,SAAS,aA6DpB","sourcesContent":["import React from \"react\";\n\nimport { useReactifySearchContext } from \"../hooks\";\nimport { debug } from \"../utility\";\n\nexport const useSearch = (): {\n  searchQuery: string;\n  setSearchQuery: React.Dispatch<React.SetStateAction<string>>;\n  submitSearch: (searchQuery?: string) => void;\n  showInstantSearchResults: boolean;\n  setShowInstantSearchResults: React.Dispatch<React.SetStateAction<boolean>>;\n} => {\n  const { options, config, search } = useReactifySearchContext();\n\n  const handleSubmitSearch = React.useCallback(\n    (searchQuery: string = search.searchQuery) => {\n      debug.breadcrumb({\n        category: \"search\",\n        message: \"search submitted\",\n        data: {\n          searchQuery: searchQuery,\n        },\n      });\n\n      debug.log(\"useSearch\", \"submitSearch[query]\", searchQuery);\n\n      if (!searchQuery) {\n        return;\n      }\n\n      const redirect = config.redirects.find(\n        (redirect) =>\n          redirect.query.trim().toLowerCase() ===\n          searchQuery.trim().toLowerCase()\n      );\n\n      if (redirect) {\n        debug.log(\"useSearch\", \"submitSearch[redirect]\", redirect);\n      }\n\n      search.setInstantSearchVisible(false);\n\n      if (options.onRedirect) {\n        options.onRedirect(\n          redirect ? \"redirect\" : \"search\",\n          redirect ? redirect.url : `/search?q=${searchQuery}`\n        );\n      } else if (redirect) {\n        window.location.href = redirect.url;\n      } else {\n        window.location.href = `/search?q=${searchQuery}`;\n      }\n    },\n    [search.searchQuery]\n  );\n\n  debug.hook(\"useSearch\", \"searchQuery\", search.searchQuery);\n\n  return {\n    searchQuery: search.searchQuery,\n    setSearchQuery: search.setSearchQuery,\n    submitSearch: handleSubmitSearch,\n    showInstantSearchResults:\n      !!search.instantSearchVisible && !!search.searchQuery,\n    setShowInstantSearchResults: search.setInstantSearchVisible,\n  };\n};\n"]}
+{"version":3,"file":"useSearch.js","sourceRoot":"","sources":["../../../src/hooks/useSearch.ts"],"names":[],"mappings":";;;;;;AAAA,mCAAuC;AACvC,kDAA0B;AAE1B,oCAAoD;AACpD,wCAAmC;AAE5B,MAAM,SAAS,GAAG,GAWvB,EAAE;IACF,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAA,gCAAwB,GAAE,CAAC;IAE/D,MAAM,sBAAsB,GAAG,eAAK,CAAC,WAAW,CAC9C,CAAC,aAAqB,MAAM,CAAC,UAAU,EAAE,EAAE;QACzC,eAAK,CAAC,UAAU,CAAC;YACf,QAAQ,EAAE,QAAQ;YAClB,OAAO,EAAE,eAAe;YACxB,IAAI,EAAE;gBACJ,UAAU,EAAE,UAAU;aACvB;SACF,CAAC,CAAC;QAEH,eAAK,CAAC,GAAG,CAAC,WAAW,EAAE,yBAAyB,EAAE,UAAU,CAAC,CAAC;QAE9D,IAAI,CAAC,UAAU,EAAE;YACf,OAAO;SACR;QAED,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,CACpC,CAAC,QAAQ,EAAE,EAAE,CACX,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,UAAU,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAClC,CAAC;QAEF,IAAI,QAAQ,EAAE;YACZ,eAAK,CAAC,GAAG,CAAC,WAAW,EAAE,4BAA4B,EAAE,QAAQ,CAAC,CAAC;SAChE;QAED,MAAM,CAAC,2BAA2B,CAAC,KAAK,CAAC,CAAC;QAE1C,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,UAAU,EAAE,CACpD,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,UAAU,EAAE,CAAC;SAClD;IACH,CAAC,EACD,CAAC,MAAM,CAAC,UAAU,CAAC,CACpB,CAAC;IAEF,MAAM,EAAE,GAAG,EAAE,sBAAsB,EAAE,MAAM,EAAE,yBAAyB,EAAE,GACtE,IAAA,sBAAa,EACX,CAAC,aAAqB,MAAM,CAAC,UAAU,EAAE,EAAE;QACzC,eAAK,CAAC,GAAG,CAAC,WAAW,EAAE,2BAA2B,EAAE,UAAU,CAAC,CAAC;QAChE,eAAK,CAAC,UAAU,CAAC;YACf,QAAQ,EAAE,QAAQ;YAClB,OAAO,EAAE,cAAc;YACvB,IAAI,EAAE;gBACJ,UAAU,EAAE,UAAU;aACvB;SACF,CAAC,CAAC;IACL,CAAC,EACD;QACE,IAAI,EAAE,GAAG;KACV,CACF,CAAC;IAEJ,MAAM,mBAAmB,GAAG,eAAK,CAAC,WAAW,CAC3C,CAAC,aAAqB,EAAE,EAAE,EAAE;QAC1B,eAAK,CAAC,GAAG,CAAC,WAAW,EAAE,2BAA2B,EAAE,UAAU,CAAC,CAAC;QAChE,IAAI,UAAU,EAAE;YACd,sBAAsB,CAAC,UAAU,CAAC,CAAC;SACpC;aAAM;YACL,yBAAyB,EAAE,CAAC;SAC7B;QAED,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IACnC,CAAC,EACD,CAAC,MAAM,CAAC,UAAU,CAAC,CACpB,CAAC;IAEF,OAAO;QACL,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,aAAa,EAAE,mBAAmB;QAClC,gBAAgB,EAAE,sBAAsB;QACxC,wBAAwB,EACtB,CAAC,CAAC,MAAM,CAAC,wBAAwB,IAAI,CAAC,CAAC,MAAM,CAAC,UAAU;QAC1D,2BAA2B,EAAE,MAAM,CAAC,2BAA2B;KAChE,CAAC;AACJ,CAAC,CAAC;AA/FW,QAAA,SAAS,aA+FpB","sourcesContent":["import { useDebounceFn } from \"ahooks\";\nimport React from \"react\";\n\nimport { useReactifySearchContext } from \"../hooks\";\nimport { debug } from \"../utility\";\n\nexport const useSearch = (): {\n  /** The current search term */\n  searchTerm: string;\n  /** Function for changing the current search term */\n  setSearchTerm: (searchTerm?: string) => void;\n  /** Function for navigating to the search page, includes logic for redirects */\n  submitSearchTerm: (searchTerm?: string) => void;\n  /** Used to determine if instant search results should be displayed */\n  showInstantSearchResults: boolean;\n  /** Used to manually set the \"showInstantSearchResults\" value */\n  setShowInstantSearchResults: React.Dispatch<React.SetStateAction<boolean>>;\n} => {\n  const { options, config, search } = useReactifySearchContext();\n\n  const handleSubmitSearchTerm = React.useCallback(\n    (searchTerm: string = search.searchTerm) => {\n      debug.breadcrumb({\n        category: \"search\",\n        message: \"search submit\",\n        data: {\n          searchTerm: searchTerm,\n        },\n      });\n\n      debug.log(\"useSearch\", \"submitSearchTerm[query]\", searchTerm);\n\n      if (!searchTerm) {\n        return;\n      }\n\n      const redirect = config.redirects.find(\n        (redirect) =>\n          redirect.query.trim().toLowerCase() ===\n          searchTerm.trim().toLowerCase()\n      );\n\n      if (redirect) {\n        debug.log(\"useSearch\", \"submitSearchTerm[redirect]\", redirect);\n      }\n\n      search.setShowInstantSearchResults(false);\n\n      if (options.onRedirect) {\n        options.onRedirect(\n          redirect ? \"redirect\" : \"search\",\n          redirect ? redirect.url : `/search?q=${searchTerm}`\n        );\n      } else if (redirect) {\n        window.location.href = redirect.url;\n      } else {\n        window.location.href = `/search?q=${searchTerm}`;\n      }\n    },\n    [search.searchTerm]\n  );\n\n  const { run: runDebouncedBreadcrumb, cancel: cancelDebouncedBreadcrumb } =\n    useDebounceFn(\n      (searchTerm: string = search.searchTerm) => {\n        debug.log(\"useSearch\", \"setSearchTerm[searchTerm]\", searchTerm);\n        debug.breadcrumb({\n          category: \"search\",\n          message: \"search query\",\n          data: {\n            searchTerm: searchTerm,\n          },\n        });\n      },\n      {\n        wait: 300,\n      }\n    );\n\n  const handleSetSearchTerm = React.useCallback(\n    (searchTerm: string = \"\") => {\n      debug.log(\"useSearch\", \"setSearchTerm[searchTerm]\", searchTerm);\n      if (searchTerm) {\n        runDebouncedBreadcrumb(searchTerm);\n      } else {\n        cancelDebouncedBreadcrumb();\n      }\n\n      search.setSearchTerm(searchTerm);\n    },\n    [search.searchTerm]\n  );\n\n  return {\n    searchTerm: search.searchTerm,\n    setSearchTerm: handleSetSearchTerm,\n    submitSearchTerm: handleSubmitSearchTerm,\n    showInstantSearchResults:\n      !!search.showInstantSearchResults && !!search.searchTerm,\n    setShowInstantSearchResults: search.setShowInstantSearchResults,\n  };\n};\n"]}

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

@@ -0,0 +1,9 @@
+import { ConfigSort } from "../types";
+export declare const useSortBy: () => {
+    /** The currently selected sort option */
+    sortOption?: ConfigSort | undefined;
+    /** All of the available sort options */
+    sortOptions: Array<ConfigSort>;
+    /** Function for changing the current sort option */
+    setSortOption: (sortOptionHandle: string, ignoreHistoryState?: boolean | undefined) => void;
+};

package/dist/src/hooks/{useSortby.js → useSortBy.js}

@@ -3,11 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useSortby = void 0;
+exports.useSortBy = void 0;
 const react_1 = __importDefault(require("react"));
 const hooks_1 = require("../hooks");
 const utility_1 = require("../utility");
-const useSortby = () => {
+const useSortBy = () => {
     const { options, config, sortby } = (0, hooks_1.useReactifySearchContext)();
     const { track } = (0, hooks_1.useAnalytics)();
     const sortOptions = react_1.default.useMemo(() => {
@@ -27,7 +27,7 @@ const useSortby = () => {
                 sortOptionHandle: sortOptionHandle,
             },
         });
-        utility_1.debug.log("useSortby", "setSortOption[sortOptionHandle]", sortOptionHandle);
+        utility_1.debug.log("useSortBy", "setSortOption[sortOptionHandle]", sortOptionHandle);
         sortby.setSortOption(sortOptionHandle);
         if (!ignoreHistoryState) {
             const url = new URL(window.location.href);
@@ -54,5 +54,5 @@ const useSortby = () => {
         setSortOption,
     };
 };
-exports.useSortby = useSortby;
-//# sourceMappingURL=useSortby.js.map
+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;AAClE,wCAAmC;AAE5B,MAAM,SAAS,GAAG,GAUvB,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,CAAC,GAAG,EAAE;QACpC,OAAO,CACL,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,KAAK,MAAM,CAAC,UAAU,CAAC;YAC9D,WAAW,CAAC,CAAC,CAAC,CACf,CAAC;IACJ,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;IAErC,MAAM,aAAa,GAAG,eAAK,CAAC,WAAW,CACrC,CAAC,gBAAwB,EAAE,kBAAkB,GAAG,KAAK,EAAE,EAAE;QACvD,eAAK,CAAC,UAAU,CAAC;YACf,QAAQ,EAAE,MAAM;YAChB,OAAO,EAAE,qBAAqB;YAC9B,IAAI,EAAE;gBACJ,gBAAgB,EAAE,gBAAgB;aACnC;SACF,CAAC,CAAC;QAEH,eAAK,CAAC,GAAG,CACP,WAAW,EACX,iCAAiC,EACjC,gBAAgB,CACjB,CAAC;QAEF,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC;QAEvC,IAAI,CAAC,kBAAkB,EAAE;YACvB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC1C,IAAI,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;gBAChC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;aAChD;iBAAM;gBACL,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;aACnD;YACD,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,eAAK,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;IAClD,eAAK,CAAC,IAAI,CAAC,WAAW,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;IAEpD,OAAO;QACL,WAAW;QACX,UAAU;QACV,aAAa;KACd,CAAC;AACJ,CAAC,CAAC;AAzEW,QAAA,SAAS,aAyEpB","sourcesContent":["import React from \"react\";\n\nimport { ConfigSort } from \"../types\";\nimport { useAnalytics, useReactifySearchContext } from \"../hooks\";\nimport { debug } from \"../utility\";\n\nexport const useSortBy = (): {\n  /** The currently selected sort option */\n  sortOption?: ConfigSort;\n  /** All of the available sort options */\n  sortOptions: Array<ConfigSort>;\n  /** Function for changing the current sort option */\n  setSortOption: (\n    sortOptionHandle: string,\n    ignoreHistoryState?: boolean\n  ) => void;\n} => {\n  const { options, config, sortby } = useReactifySearchContext();\n  const { track } = useAnalytics();\n\n  const sortOptions = React.useMemo(() => {\n    return config.sort\n      .sort((a, b) => `${a.position}`.localeCompare(`${b.position}`))\n      .filter(({ visibility }) => [\"all\", options.mode].includes(visibility));\n  }, [options.mode, config]);\n\n  const sortOption = React.useMemo(() => {\n    return (\n      sortOptions.find(({ handle }) => handle === sortby.sortOption) ||\n      sortOptions[0]\n    );\n  }, [sortOptions, sortby.sortOption]);\n\n  const setSortOption = React.useCallback(\n    (sortOptionHandle: string, ignoreHistoryState = false) => {\n      debug.breadcrumb({\n        category: \"sort\",\n        message: \"sort option changed\",\n        data: {\n          sortOptionHandle: sortOptionHandle,\n        },\n      });\n\n      debug.log(\n        \"useSortBy\",\n        \"setSortOption[sortOptionHandle]\",\n        sortOptionHandle\n      );\n\n      sortby.setSortOption(sortOptionHandle);\n\n      if (!ignoreHistoryState) {\n        const url = new URL(window.location.href);\n        if (url.searchParams.has(\"sort\")) {\n          url.searchParams.set(\"sort\", sortOptionHandle);\n        } else {\n          url.searchParams.append(\"sort\", sortOptionHandle);\n        }\n        window.history.pushState({}, \"\", url.toString());\n      }\n\n      track({\n        eventName: \"sortChange\",\n        payload: {\n          type: sortOptionHandle,\n        },\n      });\n    },\n    [window.location.href]\n  );\n\n  debug.hook(\"useSortBy\", \"sortOption\", sortOption);\n  debug.hook(\"useSortBy\", \"sortOptions\", sortOptions);\n\n  return {\n    sortOptions,\n    sortOption,\n    setSortOption,\n  };\n};\n"]}

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

@@ -131,6 +131,9 @@ export interface FilterOption {
     displaySize: string;
     displaySliderInterval: string;
     displaySliderStep: string;
+    displaySliderPrefix?: string;
+    displaySliderSuffix?: string;
+    displayRangeOptions?: Array<string>;
     displayType: "multi" | "single" | "range" | "slider";
     displayView: "list" | "check" | "swatch" | "box";
     enabled: boolean;

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

@@ -1 +1 @@
-{"version":3,"file":"firestore.js","sourceRoot":"","sources":["../../../src/types/firestore.ts"],"names":[],"mappings":";;;AA+NA,IAAY,cAQX;AARD,WAAY,cAAc;IACxB,iCAAe,CAAA;IACf,2CAAyB,CAAA;IACzB,yCAAuB,CAAA;IACvB,+CAA6B,CAAA;IAC7B,yCAAuB,CAAA;IACvB,qCAAmB,CAAA;IACnB,qCAAmB,CAAA;AACrB,CAAC,EARW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAQzB;AAyBD,IAAY,OAGX;AAHD,WAAY,OAAO;IACjB,8BAAmB,CAAA;IACnB,8BAAmB,CAAA;AACrB,CAAC,EAHW,OAAO,GAAP,eAAO,KAAP,eAAO,QAGlB","sourcesContent":["// @todo this is so we don't need to import firebase\ntype Timestamp = string;\n\nimport { ShopifyProduct } from \"./shopify\";\nimport { ElasticDataType } from \"./elastic\";\n\nexport interface Log {\n  id: string;\n  keywords: string[];\n  message: string;\n  platform: \"reactify\" | \"shopify\" | \"elastic\";\n  percentCompleted: number;\n  action?: {\n    type: \"retry\";\n    label: string;\n    task: Task[\"taskId\"];\n  };\n  step:\n    | \"download\"\n    | \"transform\"\n    | \"merge\"\n    | \"upload\"\n    | \"cleanup\"\n    | \"complete\"\n    | \"sync\";\n  title: string;\n  type: \"bulk\";\n  data?: string; // JSON sringified data\n  progress: \"new\" | \"error\" | \"complete\" | \"partiallyComplete\";\n  status: \"success\" | \"info\" | \"warning\" | \"critical\"; // polaris banner status\n  createdAt: Timestamp;\n  updatedAt?: Timestamp;\n  finishedAt?: Timestamp;\n}\n\nexport interface Task {\n  logId: string;\n  taskId:\n    | \"download\"\n    | \"transform\"\n    | \"merge\"\n    | \"upload\"\n    | \"cleanup\"\n    | \"refreshDefinedFields\"\n    | \"install\";\n  firstRun: boolean;\n  createdAt: Timestamp;\n  updatedAt?: Timestamp;\n}\n\nexport interface TaskDownload extends Task {\n  taskId: \"download\";\n  type: \"collection\" | \"product\";\n  productUrl?: string;\n  collectionUrl?: string;\n}\n\nexport interface TaskTransform extends Task {\n  taskId: \"transform\";\n  productUrl: string;\n  collectionUrl: string;\n}\n\nexport interface TaskMerge extends Task {\n  taskId: \"merge\";\n  productCount: number;\n  collectionCount: number;\n  startAfterId?: string;\n}\n\nexport interface TaskUpload extends Task {\n  taskId: \"upload\";\n  productCount: number;\n  collectionCount: number;\n  startAfterId?: string;\n}\n\nexport interface TaskCleanup extends Task {\n  taskId: \"cleanup\";\n}\n\nexport interface TaskRefreshDefinedFields extends Task {\n  taskId: \"refreshDefinedFields\";\n}\n\nexport interface TaskInstall extends Task {\n  taskId: \"install\";\n}\n\nexport interface Lock {\n  logId: string;\n  taskType: \"sync\";\n  createdAt: Timestamp;\n}\n\nexport interface SettingsInstance {\n  index: string;\n  cloudId: string;\n  endpoint: string;\n  password: string;\n  username: string;\n  syncFrequency: string;\n  syncThreshold: number;\n  provider: \"elastic\" | \"aws\";\n  storefrontAccessToken: string;\n  customMappings: string; // JSON sringified data\n}\n\nexport interface SettingsProduct {\n  tagChild?: string;\n  tagKeys?: string[];\n  tagParent?: string;\n  syncObjects: string[];\n  tagExclude?: string[];\n  tagSeparator?: string;\n  metafieldWhitelist?: string[];\n}\n\nexport interface SettingsCurations {\n  moreInfo?: boolean;\n  pageSize?: number;\n  gridColumns?: number;\n}\n\nexport interface Field {\n  id: string;\n  field: string;\n  enabled: boolean;\n  importance: number;\n  searchType: \"always_search\" | \"search_page\" | \"instant_search\";\n}\n\nexport interface DefinedField {\n  label: string;\n  value: string;\n  type: ElasticDataType;\n}\n\nexport interface Sort {\n  id: string;\n  name: string;\n  handle: string;\n  field: string;\n  position: number;\n  enabled: boolean;\n  direction: \"desc\" | \"asc\";\n  visibility: \"all\" | \"search\" | \"collection\";\n}\n\nexport interface Filter {\n  id: string;\n  name: string;\n  handle: string;\n  enabled: boolean;\n  pageSize: number;\n  keywords: string[];\n  defaultSort: string;\n  collections: string[];\n  type: \"search\" | \"collection\";\n  paginationType: \"pagination\" | \"load_more\" | \"next_prev\" | \"infinite_scroll\";\n  inventoryVisibility:\n    | \"show_all\"\n    | \"hide_products\"\n    | \"hide_variants\"\n    | \"hide_all\";\n}\n\nexport interface FilterOption {\n  displaySize: string;\n  displaySliderInterval: string;\n  displaySliderStep: string;\n  displayType: \"multi\" | \"single\" | \"range\" | \"slider\";\n  displayView: \"list\" | \"check\" | \"swatch\" | \"box\";\n  enabled: boolean;\n  field: string;\n  id: string;\n  name: string;\n  handle: string;\n  position: number;\n  settingsCollapsedDesktop: boolean;\n  settingsCollapsedMobile: boolean;\n  settingsShowFilter: boolean;\n  settingsShowMore: boolean;\n  settingsShowSearch: boolean;\n  settingsUppercase: boolean;\n  settingsHideUnavailable: boolean;\n  valuesExclude: Array<string>;\n  valuesManual: Array<string>;\n  valuesShow: \"all\" | \"manual\";\n}\n\nexport interface Redirect {\n  id: string;\n  url: string;\n  query: string;\n  enabled: boolean;\n  keywords: string[];\n}\n\nexport interface Curation {\n  id: string;\n  title: string;\n  status: CurationStatus;\n  published: boolean;\n  keywords: string[];\n  searchTerm?: string;\n  longRunningTask?: boolean;\n  collectionHandle?: string;\n  type: \"collection\" | \"search\";\n  boosting?: {\n    groupings?: BoostGrouping[];\n    sortings?: BoostSorting[];\n  };\n  sort?: CurationSort;\n}\n\nexport interface CurationSort {\n  sortTag?: string;\n  sortOption: string;\n  sortDirection: \"asc\" | \"desc\";\n  sortVariantOption?: \"option1\" | \"option2\" | \"option3\";\n}\n\nexport enum CurationStatus {\n  Draft = \"draft\",\n  Publishing = \"publishing\",\n  Published = \"published\",\n  Unpublishing = \"unpublishing\",\n  Resetting = \"resetting\",\n  Pinning = \"pinning\",\n  Sorting = \"sorting\",\n}\n\nexport interface CurationHiding {\n  productId: number;\n  productHandle: string;\n}\n\nexport interface BoostGrouping {\n  key: string;\n  value: string;\n  field: string;\n  position: number;\n  operation: string;\n}\n\nexport interface BoostSorting {\n  key: string;\n  field: string;\n  query?: string;\n  position: number;\n  direction: \"asc\" | \"desc\";\n}\n\nexport type Pin = PinProduct | PinCallout;\n\nexport enum PinType {\n  Product = \"product\",\n  Callout = \"callout\",\n}\n\nexport interface PinProduct {\n  key: string;\n  type: PinType.Product;\n  position: number;\n  productId: number;\n  productHandle: string;\n}\n\nexport interface PinCallout {\n  key: string;\n  type: PinType.Callout;\n  position: number;\n  calloutId: string;\n}\n\nexport interface Callout {\n  id: string;\n  link: string;\n  title: string;\n  content: string;\n  enabled: boolean;\n  textColor: string;\n  keywords: string[];\n  mobileImage: string;\n  mobileVideo: string;\n  desktopVideo: string;\n  desktopImage: string;\n  backgroundColor: string;\n  visibility: \"desktop\" | \"mobile\" | \"all\";\n  displayColumns: string; // @todo this should be a number\n  displayRows: string; // @todo this should be a number\n  selectedDates?: {\n    end: Timestamp;\n    start: Timestamp;\n  };\n}\n\nexport interface Synonym {\n  id: string;\n  name: string;\n  enabled: boolean;\n  keywords: string[];\n  synonyms: string[];\n  type: \"group\" | \"oneway\";\n}\n\nexport interface MergedValue {\n  id: string;\n  name: string;\n  field: string;\n  keywords: string[];\n  values: string[];\n}\n\nexport interface Collection {\n  title: string;\n  handle: string;\n  shopifyId: string;\n  productIds: string[];\n  storefrontId: string;\n  legacyResourceId: number;\n}\n\n// product is the shopify product with edges and nodes normalised\nexport type Product = Omit<\n  ShopifyProduct,\n  \"variants\" | \"images\" | \"media\" | \"metafields\"\n> & {\n  variants: (Omit<\n    ShopifyProduct[\"variants\"][\"edges\"][0][\"node\"],\n    \"presentmentPrices\"\n  > & {\n    images?: ShopifyProduct[\"images\"][\"edges\"][0][\"node\"][]; // from child product if this variant is from a child\n    presentmentPrices: ShopifyProduct[\"variants\"][\"edges\"][0][\"node\"][\"presentmentPrices\"][\"edges\"][0][\"node\"][];\n  })[];\n  images: ShopifyProduct[\"images\"][\"edges\"][0][\"node\"][];\n  media: ShopifyProduct[\"media\"][\"edges\"][0][\"node\"][];\n  metafields: ShopifyProduct[\"metafields\"][\"edges\"][0][\"node\"][];\n};\n"]}
+{"version":3,"file":"firestore.js","sourceRoot":"","sources":["../../../src/types/firestore.ts"],"names":[],"mappings":";;;AAkOA,IAAY,cAQX;AARD,WAAY,cAAc;IACxB,iCAAe,CAAA;IACf,2CAAyB,CAAA;IACzB,yCAAuB,CAAA;IACvB,+CAA6B,CAAA;IAC7B,yCAAuB,CAAA;IACvB,qCAAmB,CAAA;IACnB,qCAAmB,CAAA;AACrB,CAAC,EARW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAQzB;AAyBD,IAAY,OAGX;AAHD,WAAY,OAAO;IACjB,8BAAmB,CAAA;IACnB,8BAAmB,CAAA;AACrB,CAAC,EAHW,OAAO,GAAP,eAAO,KAAP,eAAO,QAGlB","sourcesContent":["// @todo this is so we don't need to import firebase\ntype Timestamp = string;\n\nimport { ShopifyProduct } from \"./shopify\";\nimport { ElasticDataType } from \"./elastic\";\n\nexport interface Log {\n  id: string;\n  keywords: string[];\n  message: string;\n  platform: \"reactify\" | \"shopify\" | \"elastic\";\n  percentCompleted: number;\n  action?: {\n    type: \"retry\";\n    label: string;\n    task: Task[\"taskId\"];\n  };\n  step:\n    | \"download\"\n    | \"transform\"\n    | \"merge\"\n    | \"upload\"\n    | \"cleanup\"\n    | \"complete\"\n    | \"sync\";\n  title: string;\n  type: \"bulk\";\n  data?: string; // JSON sringified data\n  progress: \"new\" | \"error\" | \"complete\" | \"partiallyComplete\";\n  status: \"success\" | \"info\" | \"warning\" | \"critical\"; // polaris banner status\n  createdAt: Timestamp;\n  updatedAt?: Timestamp;\n  finishedAt?: Timestamp;\n}\n\nexport interface Task {\n  logId: string;\n  taskId:\n    | \"download\"\n    | \"transform\"\n    | \"merge\"\n    | \"upload\"\n    | \"cleanup\"\n    | \"refreshDefinedFields\"\n    | \"install\";\n  firstRun: boolean;\n  createdAt: Timestamp;\n  updatedAt?: Timestamp;\n}\n\nexport interface TaskDownload extends Task {\n  taskId: \"download\";\n  type: \"collection\" | \"product\";\n  productUrl?: string;\n  collectionUrl?: string;\n}\n\nexport interface TaskTransform extends Task {\n  taskId: \"transform\";\n  productUrl: string;\n  collectionUrl: string;\n}\n\nexport interface TaskMerge extends Task {\n  taskId: \"merge\";\n  productCount: number;\n  collectionCount: number;\n  startAfterId?: string;\n}\n\nexport interface TaskUpload extends Task {\n  taskId: \"upload\";\n  productCount: number;\n  collectionCount: number;\n  startAfterId?: string;\n}\n\nexport interface TaskCleanup extends Task {\n  taskId: \"cleanup\";\n}\n\nexport interface TaskRefreshDefinedFields extends Task {\n  taskId: \"refreshDefinedFields\";\n}\n\nexport interface TaskInstall extends Task {\n  taskId: \"install\";\n}\n\nexport interface Lock {\n  logId: string;\n  taskType: \"sync\";\n  createdAt: Timestamp;\n}\n\nexport interface SettingsInstance {\n  index: string;\n  cloudId: string;\n  endpoint: string;\n  password: string;\n  username: string;\n  syncFrequency: string;\n  syncThreshold: number;\n  provider: \"elastic\" | \"aws\";\n  storefrontAccessToken: string;\n  customMappings: string; // JSON sringified data\n}\n\nexport interface SettingsProduct {\n  tagChild?: string;\n  tagKeys?: string[];\n  tagParent?: string;\n  syncObjects: string[];\n  tagExclude?: string[];\n  tagSeparator?: string;\n  metafieldWhitelist?: string[];\n}\n\nexport interface SettingsCurations {\n  moreInfo?: boolean;\n  pageSize?: number;\n  gridColumns?: number;\n}\n\nexport interface Field {\n  id: string;\n  field: string;\n  enabled: boolean;\n  importance: number;\n  searchType: \"always_search\" | \"search_page\" | \"instant_search\";\n}\n\nexport interface DefinedField {\n  label: string;\n  value: string;\n  type: ElasticDataType;\n}\n\nexport interface Sort {\n  id: string;\n  name: string;\n  handle: string;\n  field: string;\n  position: number;\n  enabled: boolean;\n  direction: \"desc\" | \"asc\";\n  visibility: \"all\" | \"search\" | \"collection\";\n}\n\nexport interface Filter {\n  id: string;\n  name: string;\n  handle: string;\n  enabled: boolean;\n  pageSize: number;\n  keywords: string[];\n  defaultSort: string;\n  collections: string[];\n  type: \"search\" | \"collection\";\n  paginationType: \"pagination\" | \"load_more\" | \"next_prev\" | \"infinite_scroll\";\n  inventoryVisibility:\n    | \"show_all\"\n    | \"hide_products\"\n    | \"hide_variants\"\n    | \"hide_all\";\n}\n\nexport interface FilterOption {\n  displaySize: string;\n  displaySliderInterval: string;\n  displaySliderStep: string;\n  displaySliderPrefix?: string;\n  displaySliderSuffix?: string;\n  displayRangeOptions?: Array<string>; // formatted like \"<label>:<start>:<end>\"\n  displayType: \"multi\" | \"single\" | \"range\" | \"slider\";\n  displayView: \"list\" | \"check\" | \"swatch\" | \"box\";\n  enabled: boolean;\n  field: string;\n  id: string;\n  name: string;\n  handle: string;\n  position: number;\n  settingsCollapsedDesktop: boolean;\n  settingsCollapsedMobile: boolean;\n  settingsShowFilter: boolean;\n  settingsShowMore: boolean;\n  settingsShowSearch: boolean;\n  settingsUppercase: boolean;\n  settingsHideUnavailable: boolean;\n  valuesExclude: Array<string>;\n  valuesManual: Array<string>;\n  valuesShow: \"all\" | \"manual\";\n}\n\nexport interface Redirect {\n  id: string;\n  url: string;\n  query: string;\n  enabled: boolean;\n  keywords: string[];\n}\n\nexport interface Curation {\n  id: string;\n  title: string;\n  status: CurationStatus;\n  published: boolean;\n  keywords: string[];\n  searchTerm?: string;\n  longRunningTask?: boolean;\n  collectionHandle?: string;\n  type: \"collection\" | \"search\";\n  boosting?: {\n    groupings?: BoostGrouping[];\n    sortings?: BoostSorting[];\n  };\n  sort?: CurationSort;\n}\n\nexport interface CurationSort {\n  sortTag?: string;\n  sortOption: string;\n  sortDirection: \"asc\" | \"desc\";\n  sortVariantOption?: \"option1\" | \"option2\" | \"option3\";\n}\n\nexport enum CurationStatus {\n  Draft = \"draft\",\n  Publishing = \"publishing\",\n  Published = \"published\",\n  Unpublishing = \"unpublishing\",\n  Resetting = \"resetting\",\n  Pinning = \"pinning\",\n  Sorting = \"sorting\",\n}\n\nexport interface CurationHiding {\n  productId: number;\n  productHandle: string;\n}\n\nexport interface BoostGrouping {\n  key: string;\n  value: string;\n  field: string;\n  position: number;\n  operation: string;\n}\n\nexport interface BoostSorting {\n  key: string;\n  field: string;\n  query?: string;\n  position: number;\n  direction: \"asc\" | \"desc\";\n}\n\nexport type Pin = PinProduct | PinCallout;\n\nexport enum PinType {\n  Product = \"product\",\n  Callout = \"callout\",\n}\n\nexport interface PinProduct {\n  key: string;\n  type: PinType.Product;\n  position: number;\n  productId: number;\n  productHandle: string;\n}\n\nexport interface PinCallout {\n  key: string;\n  type: PinType.Callout;\n  position: number;\n  calloutId: string;\n}\n\nexport interface Callout {\n  id: string;\n  link: string;\n  title: string;\n  content: string;\n  enabled: boolean;\n  textColor: string;\n  keywords: string[];\n  mobileImage: string;\n  mobileVideo: string;\n  desktopVideo: string;\n  desktopImage: string;\n  backgroundColor: string;\n  visibility: \"desktop\" | \"mobile\" | \"all\";\n  displayColumns: string; // @todo this should be a number\n  displayRows: string; // @todo this should be a number\n  selectedDates?: {\n    end: Timestamp;\n    start: Timestamp;\n  };\n}\n\nexport interface Synonym {\n  id: string;\n  name: string;\n  enabled: boolean;\n  keywords: string[];\n  synonyms: string[];\n  type: \"group\" | \"oneway\";\n}\n\nexport interface MergedValue {\n  id: string;\n  name: string;\n  field: string;\n  keywords: string[];\n  values: string[];\n}\n\nexport interface Collection {\n  title: string;\n  handle: string;\n  shopifyId: string;\n  productIds: string[];\n  storefrontId: string;\n  legacyResourceId: number;\n}\n\n// product is the shopify product with edges and nodes normalised\nexport type Product = Omit<\n  ShopifyProduct,\n  \"variants\" | \"images\" | \"media\" | \"metafields\"\n> & {\n  variants: (Omit<\n    ShopifyProduct[\"variants\"][\"edges\"][0][\"node\"],\n    \"presentmentPrices\"\n  > & {\n    images?: ShopifyProduct[\"images\"][\"edges\"][0][\"node\"][]; // from child product if this variant is from a child\n    presentmentPrices: ShopifyProduct[\"variants\"][\"edges\"][0][\"node\"][\"presentmentPrices\"][\"edges\"][0][\"node\"][];\n  })[];\n  images: ShopifyProduct[\"images\"][\"edges\"][0][\"node\"][];\n  media: ShopifyProduct[\"media\"][\"edges\"][0][\"node\"][];\n  metafields: ShopifyProduct[\"metafields\"][\"edges\"][0][\"node\"][];\n};\n"]}

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

@@ -1,8 +1,8 @@
 import { ElasticDocument, ElasticHit } from "./elastic";
-export interface ReactivesearchFilterProps {
+export interface ReactivesearchFilterListProps {
     loading: boolean;
     error: Error | null;
-    handleChange: (value: string) => void;
+    handleChange: (key: string) => void;
     data: {
         doc_count: number;
         key: string;

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

@@ -1 +1 @@
-{"version":3,"file":"reactivesearch.js","sourceRoot":"","sources":["../../../src/types/reactivesearch.ts"],"names":[],"mappings":"","sourcesContent":["import { ElasticDocument, ElasticHit } from \"./elastic\";\n\n// props passed to SingleList/MultiList.render\nexport interface ReactivesearchFilterProps {\n  loading: boolean;\n  error: Error | null;\n  handleChange: (value: string) => void;\n  data: { doc_count: number; key: string }[];\n  value: string | { [key: string]: boolean };\n}\n\n// props passed to ReactiveList.renderPagination\nexport interface ReactivesearchPaginationProps {\n  pages: number;\n  showEndPage: false;\n  totalPages: number;\n  currentPage: number;\n  setPage: (page: number) => void;\n}\n\n// props passed to ReactiveList.render\n// @todo complete missing types\nexport interface ReactivesearchResultProps {\n  error?: ReactivesearchError;\n  loading: boolean;\n  data: (Omit<ElasticHit, \"_source\"> & ElasticDocument)[];\n  loadMore: () => void;\n  customData: unknown;\n  promotedData: unknown;\n  aggregationData: unknown;\n  rawData?: {\n    _shards: {\n      failed: number;\n      skipped: number;\n      successful: number;\n      total: number;\n    };\n    took: number;\n    status: number;\n    timed_out: boolean;\n    hits: ElasticHit[];\n  };\n  resultStats: {\n    time: number;\n    hidden: number;\n    promoted: number;\n    currentPage: number;\n    numberOfPages: number;\n    numberOfResults?: number;\n    displayedResults: number;\n  };\n  streamData: unknown;\n  triggerAnalytics: unknown;\n  triggerClickAnalytics: unknown;\n}\n\n// state for the \"page\" component returned by StateProvider when given the keys: [\"isLoading\", \"hits\", \"resultStats\", \"error\"]\nexport interface ReactivesearchSearchStatePage {\n  isLoading: boolean;\n  hits: {\n    hidden: number;\n    time: number;\n    total: number;\n    hits: ElasticHit[];\n  };\n  resultStats: {\n    hidden: number;\n    numberOfResults?: number;\n    promoted: number;\n    time: number;\n  };\n  error?: ReactivesearchError;\n}\n\nexport interface ReactivesearchError {\n  status: number;\n  statusText: string;\n}\n"]}
+{"version":3,"file":"reactivesearch.js","sourceRoot":"","sources":["../../../src/types/reactivesearch.ts"],"names":[],"mappings":"","sourcesContent":["import { ElasticDocument, ElasticHit } from \"./elastic\";\n\n// props passed to SingleList/MultiList.render\nexport interface ReactivesearchFilterListProps {\n  loading: boolean;\n  error: Error | null;\n  handleChange: (key: string) => void;\n  data: { doc_count: number; key: string }[];\n  value: string | { [key: string]: boolean };\n}\n\n// props passed to ReactiveList.renderPagination\nexport interface ReactivesearchPaginationProps {\n  pages: number;\n  showEndPage: false;\n  totalPages: number;\n  currentPage: number;\n  setPage: (page: number) => void;\n}\n\n// props passed to ReactiveList.render\n// @todo complete missing types\nexport interface ReactivesearchResultProps {\n  error?: ReactivesearchError;\n  loading: boolean;\n  data: (Omit<ElasticHit, \"_source\"> & ElasticDocument)[];\n  loadMore: () => void;\n  customData: unknown;\n  promotedData: unknown;\n  aggregationData: unknown;\n  rawData?: {\n    _shards: {\n      failed: number;\n      skipped: number;\n      successful: number;\n      total: number;\n    };\n    took: number;\n    status: number;\n    timed_out: boolean;\n    hits: ElasticHit[];\n  };\n  resultStats: {\n    time: number;\n    hidden: number;\n    promoted: number;\n    currentPage: number;\n    numberOfPages: number;\n    numberOfResults?: number;\n    displayedResults: number;\n  };\n  streamData: unknown;\n  triggerAnalytics: unknown;\n  triggerClickAnalytics: unknown;\n}\n\n// state for the \"page\" component returned by StateProvider when given the keys: [\"isLoading\", \"hits\", \"resultStats\", \"error\"]\nexport interface ReactivesearchSearchStatePage {\n  isLoading: boolean;\n  hits: {\n    hidden: number;\n    time: number;\n    total: number;\n    hits: ElasticHit[];\n  };\n  resultStats: {\n    hidden: number;\n    numberOfResults?: number;\n    promoted: number;\n    time: number;\n  };\n  error?: ReactivesearchError;\n}\n\nexport interface ReactivesearchError {\n  status: number;\n  statusText: string;\n}\n"]}

package/dist/src/utility/debug.d.ts

@@ -1,10 +1,12 @@
+import Debug from "debug";
 import * as Sentry from "@sentry/react";
+export declare const debuggers: Record<string, Debug.Debugger>;
 export declare const debug: {
     namespace: string;
     log: (namespace: string, formatter?: string | undefined, ...args: Array<any>) => void;
     breadcrumb: (breadcrumb: Partial<Sentry.Breadcrumb> & {
         message: string;
-        category: "search" | "sort" | "pagination" | "filter" | "curation";
+        category: "result" | "search" | "sort" | "pagination" | "filter" | "curation";
     }) => void;
     hook: (namespace: string, message: string, value: unknown) => void;
 };

package/dist/src/utility/debug.js

@@ -22,14 +22,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.debug = void 0;
+exports.debug = exports.debuggers = void 0;
 const debug_1 = __importDefault(require("debug"));
 const Sentry = __importStar(require("@sentry/react"));
 const hooks_1 = require("../hooks");
+exports.debuggers = {};
 exports.debug = {
     namespace: "reactify-search",
     log: (namespace, formatter, ...args) => {
-        (0, debug_1.default)(`${exports.debug.namespace}:${namespace}`)(formatter, ...args);
+        if (!exports.debuggers[namespace]) {
+            exports.debuggers[namespace] = (0, debug_1.default)(`${exports.debug.namespace}:${namespace}`);
+        }
+        exports.debuggers[namespace](formatter, ...args);
     },
     breadcrumb: (breadcrumb) => {
         Sentry.addBreadcrumb(Object.assign(Object.assign({ level: "debug", type: "query" }, breadcrumb), { category: `${exports.debug.namespace}:${breadcrumb.category}` }));

package/dist/src/utility/debug.js.map

@@ -1 +1 @@
-{"version":3,"file":"debug.js","sourceRoot":"","sources":["../../../src/utility/debug.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAA0B;AAC1B,sDAAwC;AAExC,oCAAuC;AAE1B,QAAA,KAAK,GAAG;IACnB,SAAS,EAAE,iBAAiB;IAC5B,GAAG,EAAE,CAAC,SAAiB,EAAE,SAAkB,EAAE,GAAG,IAAgB,EAAE,EAAE;QAClE,IAAA,eAAK,EAAC,GAAG,aAAK,CAAC,SAAS,IAAI,SAAS,EAAE,CAAC,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC;IAC/D,CAAC;IACD,UAAU,EAAE,CACV,UAGC,EACD,EAAE;QACF,MAAM,CAAC,aAAa,+BAClB,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,OAAO,IACV,UAAU,KACb,QAAQ,EAAE,GAAG,aAAK,CAAC,SAAS,IAAI,UAAU,CAAC,QAAQ,EAAE,IACrD,CAAC;IACL,CAAC;IACD,IAAI,EAAE,mBAAW;CAClB,CAAC","sourcesContent":["import Debug from \"debug\";\nimport * as Sentry from \"@sentry/react\";\n\nimport { useDebugger } from \"../hooks\";\n\nexport const debug = {\n  namespace: \"reactify-search\",\n  log: (namespace: string, formatter?: string, ...args: Array<any>) => {\n    Debug(`${debug.namespace}:${namespace}`)(formatter, ...args);\n  },\n  breadcrumb: (\n    breadcrumb: Partial<Sentry.Breadcrumb> & {\n      message: string;\n      category: \"search\" | \"sort\" | \"pagination\" | \"filter\" | \"curation\";\n    }\n  ) => {\n    Sentry.addBreadcrumb({\n      level: \"debug\",\n      type: \"query\",\n      ...breadcrumb,\n      category: `${debug.namespace}:${breadcrumb.category}`,\n    });\n  },\n  hook: useDebugger,\n};\n"]}
+{"version":3,"file":"debug.js","sourceRoot":"","sources":["../../../src/utility/debug.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAA0B;AAC1B,sDAAwC;AAExC,oCAAuC;AAE1B,QAAA,SAAS,GAAmC,EAAE,CAAC;AAE/C,QAAA,KAAK,GAAG;IACnB,SAAS,EAAE,iBAAiB;IAC5B,GAAG,EAAE,CAAC,SAAiB,EAAE,SAAkB,EAAE,GAAG,IAAgB,EAAE,EAAE;QAClE,IAAI,CAAC,iBAAS,CAAC,SAAS,CAAC,EAAE;YACzB,iBAAS,CAAC,SAAS,CAAC,GAAG,IAAA,eAAK,EAAC,GAAG,aAAK,CAAC,SAAS,IAAI,SAAS,EAAE,CAAC,CAAC;SACjE;QAED,iBAAS,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC;IAC3C,CAAC;IACD,UAAU,EAAE,CACV,UASC,EACD,EAAE;QACF,MAAM,CAAC,aAAa,+BAClB,KAAK,EAAE,OAAO,EACd,IAAI,EAAE,OAAO,IACV,UAAU,KACb,QAAQ,EAAE,GAAG,aAAK,CAAC,SAAS,IAAI,UAAU,CAAC,QAAQ,EAAE,IACrD,CAAC;IACL,CAAC;IACD,IAAI,EAAE,mBAAW;CAClB,CAAC","sourcesContent":["import Debug from \"debug\";\nimport * as Sentry from \"@sentry/react\";\n\nimport { useDebugger } from \"../hooks\";\n\nexport const debuggers: Record<string, Debug.Debugger> = {};\n\nexport const debug = {\n  namespace: \"reactify-search\",\n  log: (namespace: string, formatter?: string, ...args: Array<any>) => {\n    if (!debuggers[namespace]) {\n      debuggers[namespace] = Debug(`${debug.namespace}:${namespace}`);\n    }\n\n    debuggers[namespace](formatter, ...args);\n  },\n  breadcrumb: (\n    breadcrumb: Partial<Sentry.Breadcrumb> & {\n      message: string;\n      category:\n        | \"result\"\n        | \"search\"\n        | \"sort\"\n        | \"pagination\"\n        | \"filter\"\n        | \"curation\";\n    }\n  ) => {\n    Sentry.addBreadcrumb({\n      level: \"debug\",\n      type: \"query\",\n      ...breadcrumb,\n      category: `${debug.namespace}:${breadcrumb.category}`,\n    });\n  },\n  hook: useDebugger,\n};\n"]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@usereactify/search",
   "description": "React UI library for Reactify Search",
-  "version": "5.0.0-beta.8",
+  "version": "5.0.1",
   "license": "MIT",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -12,8 +12,8 @@
   ],
   "scripts": {
     "watch": "tsc --watch",
-    "release": "standard-version --prerelease rc",
-    "release:beta": "standard-version --prerelease beta",
+    "release": "standard-version --tag-prefix release-v",
+    "release:beta": "standard-version --tag-prefix beta-v --prerelease beta",
     "prebuild": "rimraf dist",
     "build": "tsc",
     "prettier": "prettier --write .",

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

@@ -1,4 +0,0 @@
-import React from "react";
-import { FilterStackProps } from "../../components";
-export declare type ExampleFilterStackProps = React.ComponentProps<NonNullable<FilterStackProps["renderFilters"]>>;
-export declare const ExampleFilterStack: React.FC<ExampleFilterStackProps>;

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

@@ -1 +0,0 @@
-{"version":3,"file":"ExampleFilterStack.js","sourceRoot":"","sources":["../../../../src/components/Example/ExampleFilterStack.tsx"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAE1B,iDAA4D;AAMrD,MAAM,kBAAkB,GAAsC,CACnE,KAAK,EACL,EAAE;IACF,OAAO,CACL,8DACG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAC7B,8BAAC,mBAAM,kBAAC,GAAG,EAAE,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,IAAM,KAAK,EAAI,CACtD,CAAC,CACD,CACJ,CAAC;AACJ,CAAC,CAAC;AAVW,QAAA,kBAAkB,sBAU7B","sourcesContent":["import React from \"react\";\n\nimport { Filter, FilterStackProps } from \"../../components\";\n\nexport type ExampleFilterStackProps = React.ComponentProps<\n  NonNullable<FilterStackProps[\"renderFilters\"]>\n>;\n\nexport const ExampleFilterStack: React.FC<ExampleFilterStackProps> = (\n  props\n) => {\n  return (\n    <>\n      {props.filters.map((filter) => (\n        <Filter key={filter.id} filter={filter} {...props} />\n      ))}\n    </>\n  );\n};\n"]}

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

@@ -1,4 +0,0 @@
-import React from "react";
-import { SortbyProps } from "../../components";
-export declare type ExampleSortbyProps = React.ComponentProps<NonNullable<SortbyProps["renderSortOptions"]>>;
-export declare const ExampleSortby: React.FC<ExampleSortbyProps>;

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

@@ -1,13 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExampleSortby = void 0;
-const react_1 = __importDefault(require("react"));
-const ExampleSortby = (props) => {
-    var _a;
-    return (react_1.default.createElement("select", { value: (_a = props.sortOption) === null || _a === void 0 ? void 0 : _a.handle, onChange: (event) => props.setSortOption(event.target.value) }, props.sortOptions.map((sortOption) => (react_1.default.createElement("option", { key: sortOption.handle, value: sortOption.handle }, sortOption.name)))));
-};
-exports.ExampleSortby = ExampleSortby;
-//# sourceMappingURL=ExampleSortby.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"ExampleSortby.js","sourceRoot":"","sources":["../../../../src/components/Example/ExampleSortby.tsx"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAQnB,MAAM,aAAa,GAAiC,CAAC,KAAK,EAAE,EAAE;;IACnE,OAAO,CACL,0CACE,KAAK,EAAE,MAAA,KAAK,CAAC,UAAU,0CAAE,MAAM,EAC/B,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,IAE3D,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CACrC,0CAAQ,GAAG,EAAE,UAAU,CAAC,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,MAAM,IACrD,UAAU,CAAC,IAAI,CACT,CACV,CAAC,CACK,CACV,CAAC;AACJ,CAAC,CAAC;AAbW,QAAA,aAAa,iBAaxB","sourcesContent":["import React from \"react\";\n\nimport { SortbyProps } from \"../../components\";\n\nexport type ExampleSortbyProps = React.ComponentProps<\n  NonNullable<SortbyProps[\"renderSortOptions\"]>\n>;\n\nexport const ExampleSortby: React.FC<ExampleSortbyProps> = (props) => {\n  return (\n    <select\n      value={props.sortOption?.handle}\n      onChange={(event) => props.setSortOption(event.target.value)}\n    >\n      {props.sortOptions.map((sortOption) => (\n        <option key={sortOption.handle} value={sortOption.handle}>\n          {sortOption.name}\n        </option>\n      ))}\n    </select>\n  );\n};\n"]}

package/dist/src/components/Filter/FilterStack.d.ts

@@ -1,7 +0,0 @@
-import React from "react";
-import { useFilters } from "../../hooks";
-export declare type FilterStackProps = {
-    /** Render method called once for all filters */
-    renderFilters?: React.FC<ReturnType<typeof useFilters>>;
-};
-export declare const FilterStack: React.FC<FilterStackProps>;

package/dist/src/components/Filter/FilterStack.js

@@ -1,17 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FilterStack = void 0;
-const react_1 = __importDefault(require("react"));
-const hooks_1 = require("../../hooks");
-const components_1 = require("../../components");
-const FilterStack = (props) => {
-    var _a;
-    const filtersHook = (0, hooks_1.useFilters)();
-    const RenderFiltersComponent = (_a = props.renderFilters) !== null && _a !== void 0 ? _a : components_1.ExampleFilterStack;
-    return (react_1.default.createElement(RenderFiltersComponent, Object.assign({}, filtersHook)));
-};
-exports.FilterStack = FilterStack;
-//# sourceMappingURL=FilterStack.js.map

package/dist/src/components/Filter/FilterStack.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FilterStack.js","sourceRoot":"","sources":["../../../../src/components/Filter/FilterStack.tsx"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAE1B,uCAAyC;AACzC,iDAAsD;AAO/C,MAAM,WAAW,GAA+B,CAAC,KAAK,EAAE,EAAE;;IAC/D,MAAM,WAAW,GAAG,IAAA,kBAAU,GAAE,CAAC;IAEjC,MAAM,sBAAsB,GAAG,MAAA,KAAK,CAAC,aAAa,mCAAI,+BAAkB,CAAC;IAEzE,OAAO,CACL,8BAAC,sBAAsB,oBACjB,WAAW,EACf,CACH,CAAA;AACH,CAAC,CAAC;AAVW,QAAA,WAAW,eAUtB","sourcesContent":["import React from \"react\";\n\nimport { useFilters } from \"../../hooks\";\nimport { ExampleFilterStack } from \"../../components\";\n\nexport type FilterStackProps = {\n  /** Render method called once for all filters */\n  renderFilters?: React.FC<ReturnType<typeof useFilters>>\n};\n\nexport const FilterStack: React.FC<FilterStackProps> = (props) => {\n  const filtersHook = useFilters();\n\n  const RenderFiltersComponent = props.renderFilters ?? ExampleFilterStack;\n\n  return (\n    <RenderFiltersComponent\n      {...filtersHook}\n    />\n  )\n};\n"]}