UNPKG

@future-widget-lab/ui-filters

Version:

A set of primitives for handling filters through search parameters in React applications.

761 lines (746 loc) 27.1 kB
'use strict'; var flatted = require('flatted'); /** * @description * Use this helper to add a new filter value for the specified filter name while ensuring no duplicates are added. * * Comparison checks are performed as follows: * - Object values are serialized into strings for accurate comparison. * - Primitives values (strings, numbers, etc.) are compared directly without serialization. */ var addFilterValue = function addFilterValue(options) { var _filters$name; var filters = options.filters, name = options.name, value = options.value, onBeforeAdd = options.onBeforeAdd, onAfterAdd = options.onAfterAdd; var filterValues = (_filters$name = filters[name]) != null ? _filters$name : []; if (typeof value === 'object') { var serializedfilterValues = filterValues.map(function (previousFilterValue) { return flatted.stringify(previousFilterValue); }); var serializedValue = flatted.stringify(value); var _updatedFilterValues = serializedfilterValues.includes(serializedValue) ? filterValues : [].concat(filterValues, [value]); onBeforeAdd == null || onBeforeAdd({ name: name, value: value }); filters[options.name] = _updatedFilterValues; onAfterAdd == null || onAfterAdd({ name: name, value: value }); return filters; } var updatedFilterValues = filterValues.includes(value) ? filterValues : [].concat(filterValues, [value]); onBeforeAdd == null || onBeforeAdd({ name: name, value: value }); filters[options.name] = updatedFilterValues; onAfterAdd == null || onAfterAdd({ name: name, value: value }); return filters; }; function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; } function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); } function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; } function _createForOfIteratorHelperLoose(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (t) return (t = t.call(r)).next.bind(t); if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var o = 0; return function () { return o >= r.length ? { done: !0 } : { done: !1, value: r[o++] }; }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); } function _regeneratorRuntime() { _regeneratorRuntime = function () { return e; }; var t, e = {}, r = Object.prototype, n = r.hasOwnProperty, o = Object.defineProperty || function (t, e, r) { t[e] = r.value; }, i = "function" == typeof Symbol ? Symbol : {}, a = i.iterator || "@@iterator", c = i.asyncIterator || "@@asyncIterator", u = i.toStringTag || "@@toStringTag"; function define(t, e, r) { return Object.defineProperty(t, e, { value: r, enumerable: !0, configurable: !0, writable: !0 }), t[e]; } try { define({}, ""); } catch (t) { define = function (t, e, r) { return t[e] = r; }; } function wrap(t, e, r, n) { var i = e && e.prototype instanceof Generator ? e : Generator, a = Object.create(i.prototype), c = new Context(n || []); return o(a, "_invoke", { value: makeInvokeMethod(t, r, c) }), a; } function tryCatch(t, e, r) { try { return { type: "normal", arg: t.call(e, r) }; } catch (t) { return { type: "throw", arg: t }; } } e.wrap = wrap; var h = "suspendedStart", l = "suspendedYield", f = "executing", s = "completed", y = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var p = {}; define(p, a, function () { return this; }); var d = Object.getPrototypeOf, v = d && d(d(values([]))); v && v !== r && n.call(v, a) && (p = v); var g = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(p); function defineIteratorMethods(t) { ["next", "throw", "return"].forEach(function (e) { define(t, e, function (t) { return this._invoke(e, t); }); }); } function AsyncIterator(t, e) { function invoke(r, o, i, a) { var c = tryCatch(t[r], t, o); if ("throw" !== c.type) { var u = c.arg, h = u.value; return h && "object" == typeof h && n.call(h, "__await") ? e.resolve(h.__await).then(function (t) { invoke("next", t, i, a); }, function (t) { invoke("throw", t, i, a); }) : e.resolve(h).then(function (t) { u.value = t, i(u); }, function (t) { return invoke("throw", t, i, a); }); } a(c.arg); } var r; o(this, "_invoke", { value: function (t, n) { function callInvokeWithMethodAndArg() { return new e(function (e, r) { invoke(t, n, e, r); }); } return r = r ? r.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(e, r, n) { var o = h; return function (i, a) { if (o === f) throw Error("Generator is already running"); if (o === s) { if ("throw" === i) throw a; return { value: t, done: !0 }; } for (n.method = i, n.arg = a;;) { var c = n.delegate; if (c) { var u = maybeInvokeDelegate(c, n); if (u) { if (u === y) continue; return u; } } if ("next" === n.method) n.sent = n._sent = n.arg;else if ("throw" === n.method) { if (o === h) throw o = s, n.arg; n.dispatchException(n.arg); } else "return" === n.method && n.abrupt("return", n.arg); o = f; var p = tryCatch(e, r, n); if ("normal" === p.type) { if (o = n.done ? s : l, p.arg === y) continue; return { value: p.arg, done: n.done }; } "throw" === p.type && (o = s, n.method = "throw", n.arg = p.arg); } }; } function maybeInvokeDelegate(e, r) { var n = r.method, o = e.iterator[n]; if (o === t) return r.delegate = null, "throw" === n && e.iterator.return && (r.method = "return", r.arg = t, maybeInvokeDelegate(e, r), "throw" === r.method) || "return" !== n && (r.method = "throw", r.arg = new TypeError("The iterator does not provide a '" + n + "' method")), y; var i = tryCatch(o, e.iterator, r.arg); if ("throw" === i.type) return r.method = "throw", r.arg = i.arg, r.delegate = null, y; var a = i.arg; return a ? a.done ? (r[e.resultName] = a.value, r.next = e.nextLoc, "return" !== r.method && (r.method = "next", r.arg = t), r.delegate = null, y) : a : (r.method = "throw", r.arg = new TypeError("iterator result is not an object"), r.delegate = null, y); } function pushTryEntry(t) { var e = { tryLoc: t[0] }; 1 in t && (e.catchLoc = t[1]), 2 in t && (e.finallyLoc = t[2], e.afterLoc = t[3]), this.tryEntries.push(e); } function resetTryEntry(t) { var e = t.completion || {}; e.type = "normal", delete e.arg, t.completion = e; } function Context(t) { this.tryEntries = [{ tryLoc: "root" }], t.forEach(pushTryEntry, this), this.reset(!0); } function values(e) { if (e || "" === e) { var r = e[a]; if (r) return r.call(e); if ("function" == typeof e.next) return e; if (!isNaN(e.length)) { var o = -1, i = function next() { for (; ++o < e.length;) if (n.call(e, o)) return next.value = e[o], next.done = !1, next; return next.value = t, next.done = !0, next; }; return i.next = i; } } throw new TypeError(typeof e + " is not iterable"); } return GeneratorFunction.prototype = GeneratorFunctionPrototype, o(g, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), o(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, u, "GeneratorFunction"), e.isGeneratorFunction = function (t) { var e = "function" == typeof t && t.constructor; return !!e && (e === GeneratorFunction || "GeneratorFunction" === (e.displayName || e.name)); }, e.mark = function (t) { return Object.setPrototypeOf ? Object.setPrototypeOf(t, GeneratorFunctionPrototype) : (t.__proto__ = GeneratorFunctionPrototype, define(t, u, "GeneratorFunction")), t.prototype = Object.create(g), t; }, e.awrap = function (t) { return { __await: t }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, c, function () { return this; }), e.AsyncIterator = AsyncIterator, e.async = function (t, r, n, o, i) { void 0 === i && (i = Promise); var a = new AsyncIterator(wrap(t, r, n, o), i); return e.isGeneratorFunction(r) ? a : a.next().then(function (t) { return t.done ? t.value : a.next(); }); }, defineIteratorMethods(g), define(g, u, "Generator"), define(g, a, function () { return this; }), define(g, "toString", function () { return "[object Generator]"; }), e.keys = function (t) { var e = Object(t), r = []; for (var n in e) r.push(n); return r.reverse(), function next() { for (; r.length;) { var t = r.pop(); if (t in e) return next.value = t, next.done = !1, next; } return next.done = !0, next; }; }, e.values = values, Context.prototype = { constructor: Context, reset: function (e) { if (this.prev = 0, this.next = 0, this.sent = this._sent = t, this.done = !1, this.delegate = null, this.method = "next", this.arg = t, this.tryEntries.forEach(resetTryEntry), !e) for (var r in this) "t" === r.charAt(0) && n.call(this, r) && !isNaN(+r.slice(1)) && (this[r] = t); }, stop: function () { this.done = !0; var t = this.tryEntries[0].completion; if ("throw" === t.type) throw t.arg; return this.rval; }, dispatchException: function (e) { if (this.done) throw e; var r = this; function handle(n, o) { return a.type = "throw", a.arg = e, r.next = n, o && (r.method = "next", r.arg = t), !!o; } for (var o = this.tryEntries.length - 1; o >= 0; --o) { var i = this.tryEntries[o], a = i.completion; if ("root" === i.tryLoc) return handle("end"); if (i.tryLoc <= this.prev) { var c = n.call(i, "catchLoc"), u = n.call(i, "finallyLoc"); if (c && u) { if (this.prev < i.catchLoc) return handle(i.catchLoc, !0); if (this.prev < i.finallyLoc) return handle(i.finallyLoc); } else if (c) { if (this.prev < i.catchLoc) return handle(i.catchLoc, !0); } else { if (!u) throw Error("try statement without catch or finally"); if (this.prev < i.finallyLoc) return handle(i.finallyLoc); } } } }, abrupt: function (t, e) { for (var r = this.tryEntries.length - 1; r >= 0; --r) { var o = this.tryEntries[r]; if (o.tryLoc <= this.prev && n.call(o, "finallyLoc") && this.prev < o.finallyLoc) { var i = o; break; } } i && ("break" === t || "continue" === t) && i.tryLoc <= e && e <= i.finallyLoc && (i = null); var a = i ? i.completion : {}; return a.type = t, a.arg = e, i ? (this.method = "next", this.next = i.finallyLoc, y) : this.complete(a); }, complete: function (t, e) { if ("throw" === t.type) throw t.arg; return "break" === t.type || "continue" === t.type ? this.next = t.arg : "return" === t.type ? (this.rval = this.arg = t.arg, this.method = "return", this.next = "end") : "normal" === t.type && e && (this.next = e), y; }, finish: function (t) { for (var e = this.tryEntries.length - 1; e >= 0; --e) { var r = this.tryEntries[e]; if (r.finallyLoc === t) return this.complete(r.completion, r.afterLoc), resetTryEntry(r), y; } }, catch: function (t) { for (var e = this.tryEntries.length - 1; e >= 0; --e) { var r = this.tryEntries[e]; if (r.tryLoc === t) { var n = r.completion; if ("throw" === n.type) { var o = n.arg; resetTryEntry(r); } return o; } } throw Error("illegal catch attempt"); }, delegateYield: function (e, r, n) { return this.delegate = { iterator: values(e), resultName: r, nextLoc: n }, "next" === this.method && (this.arg = t), y; } }, e; } function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } } /** * @description * Use this helper to add multiple filter values across different filters while preventing duplicates. * * - Accepts a single filter input or an array of filter inputs, each containing a filter name and one or more values. * - Processes multiple values for a single filter individually. * * Comparison checks are performed as follows: * - Object values are serialized into strings for accurate comparison. * - Primitive values (strings, numbers, etc.) are compared directly without serialization. * * This helper functions as a batch processor, applying `addFilterValue` efficiently to multiple filters. * * This helper ensures immutability by creating a shallow copy of the filters collection. */ var addMultipleFilterValues = function addMultipleFilterValues(options) { var filters = options.filters, oInput = options.input, onBeforeAdd = options.onBeforeAdd, onAfterAdd = options.onAfterAdd; var updatedFilters = _extends({}, filters); var input = Array.isArray(oInput) ? oInput : [oInput]; for (var _iterator = _createForOfIteratorHelperLoose(input), _step; !(_step = _iterator()).done;) { var filterInput = _step.value; if (Array.isArray(filterInput.value)) { for (var _iterator2 = _createForOfIteratorHelperLoose(filterInput.value), _step2; !(_step2 = _iterator2()).done;) { var value = _step2.value; updatedFilters = addFilterValue({ filters: updatedFilters, name: filterInput.name, value: value, onBeforeAdd: onBeforeAdd, onAfterAdd: onAfterAdd }); } } else { updatedFilters = addFilterValue({ filters: filters, name: filterInput.name, value: filterInput.value, onBeforeAdd: onBeforeAdd, onAfterAdd: onAfterAdd }); } } return updatedFilters; }; /** * @description * Use this helper to perform the filters deserialization. * * Return a filters collection given a search params set and a search param name. * * Returns an empty collection if no search parameter is found or an error occurs. */ var deserializeFilters = function deserializeFilters(options) { var serializedFilters = options.serializedFilters, _options$deserializer = options.deserializer, deserializer = _options$deserializer === void 0 ? flatted.parse : _options$deserializer, onBeforeDeserializer = options.onBeforeDeserializer, onAfterDeserializer = options.onAfterDeserializer, onDeserializerError = options.onDeserializerError; onBeforeDeserializer == null || onBeforeDeserializer(); try { if (!serializedFilters) { return {}; } var parsedFilters = deserializer(serializedFilters); onAfterDeserializer == null || onAfterDeserializer(parsedFilters); return parsedFilters; } catch (error) { onDeserializerError == null || onDeserializerError(error); return {}; } }; /** * @description * Use this helper to retrieve the current values of a given filter. */ var peekFilter = function peekFilter(options) { var _filters$name; var filters = options.filters, name = options.name; return (_filters$name = filters[name]) != null ? _filters$name : []; }; /** * @description * Use this helper to remove an filter and its associated values from the filters collection. */ var removeFilter = function removeFilter(options) { var filters = options.filters, name = options.name; delete filters[name]; return filters; }; /** * @description * Use this helper to remove an existing filter value from the specified filter name. * * Comparison checks are performed as follows: * - Object values are serialized into strings for accurate comparison. * - Primitives values (strings, numbers, etc.) are compared directly without serialization. */ var removeFilterValue = function removeFilterValue(options) { var _filters$name; var filters = options.filters, name = options.name, value = options.value; var filterValues = (_filters$name = filters[name]) != null ? _filters$name : []; if (filterValues.length === 0) { return filters; } if (typeof value === 'object') { var _updatedFilterValues = filterValues.filter(function (previousFilterValue) { if (typeof previousFilterValue === 'object') { return flatted.stringify(previousFilterValue) !== flatted.stringify(value); } return previousFilterValue !== flatted.stringify(value); }); if (_updatedFilterValues.length === 0) { return removeFilter({ filters: filters, name: options.name }); } filters[options.name] = _updatedFilterValues; return filters; } var updatedFilterValues = filterValues.filter(function (previousFilterValue) { if (typeof previousFilterValue === 'object') { return flatted.stringify(previousFilterValue) !== value; } return previousFilterValue !== value; }); if (updatedFilterValues.length === 0) { return removeFilter({ filters: filters, name: options.name }); } filters[options.name] = updatedFilterValues; return filters; }; /** * @description * Use this helper to remove multiple filter values across different filters. * * - Accepts a single filter input or an array of filter inputs, each containing a filter name and one or more values. * - Processes multiple values for a single filter individually. * * Comparison checks are performed as follows: * - Object values are serialized into strings for accurate comparison. * - Primitive values (strings, numbers, etc.) are compared directly without serialization. * * This helper functions as a batch processor, applying `removeFilterValue` efficiently to multiple filters. * * This helper ensures immutability by creating a shallow copy of the filters collection. */ var removeMultipleFilterValues = function removeMultipleFilterValues(options) { var filters = options.filters, oInput = options.input; var updatedFilters = _extends({}, filters); var input = Array.isArray(oInput) ? oInput : [oInput]; for (var _iterator = _createForOfIteratorHelperLoose(input), _step; !(_step = _iterator()).done;) { var filterInput = _step.value; if (Array.isArray(filterInput.value)) { for (var _iterator2 = _createForOfIteratorHelperLoose(filterInput.value), _step2; !(_step2 = _iterator2()).done;) { var value = _step2.value; updatedFilters = removeFilterValue({ filters: updatedFilters, name: filterInput.name, value: value }); } } else { updatedFilters = removeFilterValue({ filters: filters, name: filterInput.name, value: filterInput.value }); } } return updatedFilters; }; /** * @description * Use this helper to remove multiple filters from the given filters collection. * * - Accepts a single filter name or an array of filter names. * - Each filter is removed sequentially. * * This helper functions as a batch processor, applying `removeFilter` efficiently to multiple filters. * * This helper ensures immutability by creating a shallow copy of the filters collection. */ var removeMultipleFilters = function removeMultipleFilters(options) { var filters = options.filters, oInput = options.input; var updatedFilters = _extends({}, filters); var input = Array.isArray(oInput) ? oInput : [oInput]; for (var _iterator = _createForOfIteratorHelperLoose(input), _step; !(_step = _iterator()).done;) { var name = _step.value; updatedFilters = removeFilter({ filters: filters, name: name }); } return updatedFilters; }; /** * @description * Use this helper to set the value(s) of a given filter. * * - If `value` is `null`, `undefined`, or an empty array, the filter is removed. * - If `value` is a single item, it replaces the existing filter values. * - If `value` is an array, all existing filter values are cleared before adding the new ones. * * This ensures that each filter is updated in a controlled manner: * - Existing filter values are first removed using `removeFilterValue`. * - New filter values are then added using `addFilterValue`. * - If no values remain, `removeFilter` is used to delete the filter entirely. * * Comparison checks are performed as follows: * - Object values are serialized into strings for accurate comparison. * - Primitive values (strings, numbers, etc.) are compared directly without serialization. * * This function maintains immutability by returning a new filters object. */ var setFilterValue = function setFilterValue(options) { var filters = options.filters, name = options.name, inputValue = options.value; var shouldFilterBeRemoved = !inputValue || Array.isArray(inputValue) && inputValue.length === 0; if (shouldFilterBeRemoved) { return removeFilter({ filters: filters, name: name }); } filters = removeFilter({ filters: filters, name: name }); if (Array.isArray(inputValue)) { for (var _iterator = _createForOfIteratorHelperLoose(inputValue), _step; !(_step = _iterator()).done;) { var value = _step.value; filters = addFilterValue({ filters: filters, name: name, value: value }); } } else { filters = addFilterValue({ filters: filters, name: name, value: inputValue }); } return filters; }; /** * @description * Use this helper to set multiple filter values across different filters while preventing duplicates. * * - Accepts a single filter input or an array of filter inputs, each containing a filter name and one or more values. * - Processes multiple values for a single filter individually. * * - If `value` is `null`, `undefined`, or an empty array, the filter is removed. * - If `value` is a single item, it replaces the existing filter values. * - If `value` is an array, all existing filter values are cleared before adding the new ones. * * Comparison checks are performed as follows: * - Object values are serialized into strings for accurate comparison. * - Primitive values (strings, numbers, etc.) are compared directly without serialization. * * This helper functions as a batch processor, applying `setFilterValue` efficiently to multiple filters. * * This helper ensures immutability by creating a shallow copy of the filters collection. */ var setMultipleFilterValues = function setMultipleFilterValues(options) { var filters = options.filters, oInput = options.input; var updatedFilters = _extends({}, filters); var input = Array.isArray(oInput) ? oInput : [oInput]; for (var _iterator = _createForOfIteratorHelperLoose(input), _step; !(_step = _iterator()).done;) { var filterInput = _step.value; updatedFilters = setFilterValue({ filters: filters, name: filterInput.name, value: filterInput.value }); } return updatedFilters; }; /** * @description * Use this helper to notify the current filters collection state with the consumers. * * - If filters exist, they are serialized and committed. * - If no filters exist, the commit function is given an `undefined` value for the filters. */ var syncState = /*#__PURE__*/function () { var _ref = /*#__PURE__*/_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(options) { var filters, commit, _options$serializer, serializer, onBeforeCommit, onAfterCommit, q; return _regeneratorRuntime().wrap(function _callee$(_context) { while (1) switch (_context.prev = _context.next) { case 0: filters = options.filters, commit = options.commit, _options$serializer = options.serializer, serializer = _options$serializer === void 0 ? flatted.stringify : _options$serializer, onBeforeCommit = options.onBeforeCommit, onAfterCommit = options.onAfterCommit; onBeforeCommit == null || onBeforeCommit(); q = Object.keys(filters).length === 0 ? undefined : serializer(filters); commit(q); onAfterCommit == null || onAfterCommit(); case 5: case "end": return _context.stop(); } }, _callee); })); return function syncState(_x) { return _ref.apply(this, arguments); }; }(); exports.addFilterValue = addFilterValue; exports.addMultipleFilterValues = addMultipleFilterValues; exports.deserializeFilters = deserializeFilters; exports.peekFilter = peekFilter; exports.removeFilter = removeFilter; exports.removeFilterValue = removeFilterValue; exports.removeMultipleFilterValues = removeMultipleFilterValues; exports.removeMultipleFilters = removeMultipleFilters; exports.setFilterValue = setFilterValue; exports.setMultipleFilterValues = setMultipleFilterValues; exports.syncState = syncState; //# sourceMappingURL=ui-filters.cjs.development.js.map