@promoboxx/use-filter 1.9.0 → 1.10.0

package/dist/store/urlParamStore.d.ts

@@ -0,0 +1,2 @@
+import { FilterStore } from './index';
+export declare const createUrlParamStore: () => FilterStore;

package/dist/store/urlParamStore.js

@@ -0,0 +1,86 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createUrlParamStore = void 0;
+var qs_1 = __importDefault(require("qs"));
+var createUrlParamStore = function () {
+    var urlParamStore = {
+        getFilter: function (namespace) {
+            var parsed = naivelyParseExistingParams();
+            var parsedInfo = parsed["info." + namespace];
+            var parsedFilter = parsed["filter." + namespace];
+            // useFilter doesn't really support returning a partial FilterInfo, so both
+            // need to be present,
+            if (parsedInfo && parsedFilter) {
+                if (parsedInfo.page != null) {
+                    parsedInfo.page = Number(parsedInfo.page);
+                }
+                if (parsedInfo.pageSize != null) {
+                    parsedInfo.pageSize = Number(parsedInfo.pageSize);
+                }
+                if (parsedInfo.offset != null) {
+                    parsedInfo.offset = Number(parsedInfo.offset);
+                }
+                return __assign(__assign({}, parsedInfo), { filter: parsedFilter });
+            }
+        },
+        saveFilter: function (namespace, filterInfo) {
+            var parsed = naivelyParseExistingParams();
+            // Setting the params to the equivalent of { [namespace]: filterInfo }
+            // takes up more room. The idea is that this ...
+            //     'filter.filterName%5BfilterValueKey%5D=filterValueValue'
+            // ... is smaller than ...
+            //     filterName%5Bfilter%5D%5BfilterValueKey%5D=filterValueValue
+            // ... by 5 characters per value in a filter. So excuse us for a second ...
+            var clonedInfo = __assign({}, filterInfo);
+            var clonedFilter = filterInfo.filter;
+            delete clonedInfo.filter;
+            delete clonedInfo.lastRefreshAt;
+            delete clonedInfo.shouldRunImmediately;
+            delete clonedInfo.totalResults;
+            delete clonedInfo.totalPages;
+            delete clonedInfo.nextCursor;
+            parsed["filter." + namespace] = clonedFilter;
+            parsed["info." + namespace] = clonedInfo;
+            replaceQueryParams(qs_1.default.stringify(parsed));
+        },
+        clear: function () {
+            var parsed = naivelyParseExistingParams();
+            for (var key in parsed) {
+                if (key.startsWith('filter.') || key.startsWith('info.')) {
+                    delete parsed[key];
+                }
+            }
+            replaceQueryParams(qs_1.default.stringify(parsed));
+        },
+        getData: function () {
+            return undefined;
+        },
+        saveData: function () { },
+    };
+    return urlParamStore;
+};
+exports.createUrlParamStore = createUrlParamStore;
+function replaceQueryParams(newParams) {
+    var nextUrl = new URL(window.location.toString());
+    nextUrl.search = newParams;
+    window.history.replaceState(undefined, '', nextUrl.toString());
+}
+function naivelyParseExistingParams() {
+    // Don't really want to do any casting, especially not to `any`, but the type
+    // of `qs.parse` is so wide we'd have to litter checks all over the place.
+    return qs_1.default.parse(window.location.search.substring(1));
+}

package/dist/useFilter.d.ts

@@ -69,7 +69,7 @@ export interface FilterApi<TFilter, TResult> {
     /**
      * Changes the cursor.
      */
-    setCursor: (cursor: string | null | undefined) => void;
+    setCursor: (cursor: string | null | undefined, shouldRunImmediately?: boolean) => void;
     /**
      * Forces a refresh of the filter.
      */

package/dist/useFilter.js

@@ -114,11 +114,17 @@ function useFilter(namespace, options) {
                             extra.offset = offsetNumber;
                             extra.page = getPageFromOffset_1.default(offsetNumber, pageSizeNumber);
                         }
-                        if (totalResults) {
-                            extra.totalResults = Number(totalResults);
+                        // `null` / `undefined` are valid here, it means there is zero
+                        // results, so we can't just check if it's truthy, we need to check
+                        // for presence.
+                        if ('totalResults' in response.filterInfo) {
+                            extra.totalResults = Number(totalResults || 0);
                             extra.totalPages = Math.ceil(extra.totalResults / pageSizeNumber);
                         }
-                        if (nextCursor) {
+                        // `null` / `undefined` are valid here, it means there is no next
+                        // cursor, so we can't just check if it's truthy, we need to check
+                        // for presence.
+                        if ('nextCursor' in response.filterInfo) {
                             extra.nextCursor = nextCursor;
                         }
                         return __assign(__assign(__assign({}, previous), filterInfoFromResponse), extra);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@promoboxx/use-filter",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "",
   "main": "dist/useFilter.js",
   "keywords": [],
@@ -10,6 +10,7 @@
     "@promoboxx/eslint-config": "^2.3.0",
     "@testing-library/react": "^12.0.0",
     "@types/jest": "^26.0.24",
+    "@types/qs": "^6.9.7",
     "@types/react": "^17.0.14",
     "@types/redux": "^3.6.0",
     "eslint": "^7.30.0",
@@ -43,7 +44,12 @@
     "dist/store/index.d.ts",
     "dist/store/index.js",
     "dist/store/localStorageStore.js",
+    "dist/store/urlParamStore.d.ts",
+    "dist/store/urlParamStore.js",
     "dist/store/memoryStore.js",
     "dist/store/reduxStore.js"
-  ]
+  ],
+  "dependencies": {
+    "qs": "^6.11.2"
+  }
 }