optimizely-oui/module/js/components/FilterPicker/FilterPicker.js

Optimizely's Component Library.

function _typeof(obj) { if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }

function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }

function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }

function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }

function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }

function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }

function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } return _assertThisInitialized(self); }

function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }

function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }

function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }

function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }

function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }

function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _nonIterableSpread(); }

function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance"); }

function _iterableToArray(iter) { if (Symbol.iterator in Object(iter) || Object.prototype.toString.call(iter) === "[object Arguments]") return Array.from(iter); }

function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) { for (var i = 0, arr2 = new Array(arr.length); i < arr.length; i++) { arr2[i] = arr[i]; } return arr2; } }

import React, { Component } from "react";
import ImmutablePropTypes from "react-immutable-proptypes";
import PropTypes from "prop-types";
import classNames from "classnames";
import { isFilterTermInItem } from "../../utils/filter";
import ListItem from "./FilterPickerListItem";
/**
 * - Using this instead of isImmutable() because OUI does not have immutable,
 *   only react-immutable-proptypes for propType checking
 *
 * @param {Object|Immutable.Map} itemToCheck
 * - item to evaluate
 * @returns {boolean}
 * - very crude check to detect whether we're dealing with an Immutable Map
 *   or a POJO
 */

function isItemImmutable(itemToCheck) {
  return typeof itemToCheck.size === "number";
}
/**
 * Based off isItemImmutable, uses the get() for Immutable.Maps or bracket
 * notation for POJO
 * @param {Object|Immutable.Map} pojoOrMap
 * - POJO or Immutable.Map to get key from
 * @param {string} key
 * - top level key to retrieve from POJO or Immutable.Map
 * @returns {*}
 */


function getKeyFromPojoOrImmutableMap(pojoOrMap, key) {
  return isItemImmutable(pojoOrMap) ? pojoOrMap.get(key) : pojoOrMap[key];
}
/**
 *
 * @param {Array} keysToSearch
 * - top level keys in allEntities to join and search for the filterQuery
 * @param {string} filterQuery
 * - value of search input query
 * @param {Function} filterFn
 * - filter function to execute and return from inner function
 * @param {boolean} isCustomFilterFn
 * - determines what arguments are passed to the provided filterFn
 * @returns {Function}
 * - provided an item from an iterable (Object|Immutable.Map), this function
 *   should return a Boolean from the executed filterFn. if isCustomFilterFn
 *   is falsy, the default filter function will be used and only passed
 *   filterQuery and contentToSearch. Otherwise the item argument will
 *   precede filterQuery and contentToSearch
 */


function filterSetup(keysToSearch, filterQuery, filterFn, isCustomFilterFn) {
  return function (item) {
    var contentToSearch = keysToSearch.map(function (key) {
      return getKeyFromPojoOrImmutableMap(item, key) || "";
    }).join(" "); // If a customFilterFn is used, item should be sent as the first argument
    // before filterQuery and contentToSearch. This is worthwhile since
    // it makes more sense for the component consumer to receive item
    // first in the custom filter function. If not a custom filter function,
    // just send filterQuery and contentToSearch since isFilterTermInItem
    // doesn't need the item argument.

    return filterFn.apply(void 0, _toConsumableArray((isCustomFilterFn ? [item] : []).concat([filterQuery, contentToSearch])));
  };
}

var FilterPicker =
/*#__PURE__*/
function (_Component) {
  _inherits(FilterPicker, _Component);

  function FilterPicker() {
    var _getPrototypeOf2;

    var _this;

    _classCallCheck(this, FilterPicker);

    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
      args[_key] = arguments[_key];
    }

    _this = _possibleConstructorReturn(this, (_getPrototypeOf2 = _getPrototypeOf(FilterPicker)).call.apply(_getPrototypeOf2, [this].concat(args)));

    _defineProperty(_assertThisInitialized(_this), "state", {
      filterQuery: ""
    });

    _defineProperty(_assertThisInitialized(_this), "handleFilterInput", function (event) {
      _this.setState({
        filterQuery: event.target.value
      });
    });

    return _this;
  }

  _createClass(FilterPicker, [{
    key: "render",
    value: function render() {
      var filterQuery = this.state.filterQuery;

      var _this$props = this.props,
          allEntities = _this$props.allEntities,
          children = _this$props.children,
          className = _this$props.className,
          customFilterFn = _this$props.customFilterFn,
          keysToSearch = _this$props.keysToSearch,
          selectedEntityIds = _this$props.selectedEntityIds,
          testSection = _this$props.testSection,
          props = _objectWithoutProperties(_this$props, ["allEntities", "children", "className", "customFilterFn", "keysToSearch", "selectedEntityIds", "testSection"]);

      var isCustomFilterFn = customFilterFn() !== null;
      var filterFn = isCustomFilterFn ? customFilterFn : isFilterTermInItem;
      var availableEntitiesFilter = filterSetup(keysToSearch, filterQuery, filterFn, isCustomFilterFn);
      var availableEntities = allEntities.filter(function (entity) {
        return !selectedEntityIds.includes(getKeyFromPojoOrImmutableMap(entity, "id"));
      }).filter(availableEntitiesFilter);
      var selectedEntities = allEntities.filter(function (entity) {
        return selectedEntityIds.includes(getKeyFromPojoOrImmutableMap(entity, "id"));
      });
      return React.createElement("div", _extends({
        className: classNames("oui-filter-picker", className),
        "data-test-section": testSection
      }, props), children({
        handleFilterInput: this.handleFilterInput.bind(this),
        availableEntities: availableEntities,
        filterQuery: filterQuery,
        selectedEntities: selectedEntities
      }));
    }
  }]);

  return FilterPicker;
}(Component);

_defineProperty(FilterPicker, "propTypes", {
  /**
   * Array of Objects or Immutable.List of Immutable.Maps of all entities,
   * including selected ones
   */
  allEntities: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.object), ImmutablePropTypes.listOf(ImmutablePropTypes.map)]),

  /**
   * Function that should return a child node, passed an object
   * as an argument with the following keys:
   * - availableEntities {Array|Immutable.List}:
   *    The difference of allEntities and entities based on provided
   *    selectedEntityIds. Additionally, filtered via the default filter
   *    function based on the filterQuery value set in handleFilterInput,
   *    or alternatively a provided custom filter function
   * - filterQuery {string}:
   *    Value stored in component state via handleFilterInput
   * - handleFilterInput {Function}:
   *    Function that can be used in an input, that sets the input value
   *    in component state as filterQuery. This can be used for filtering
   *    in the default or custom filter function. If a search Input will
   *    be used with Blocklist and FilterList.ListItem, consider wrapping
   *    Blocklist inside a div with the oui-filter-picker-list class to
   *    remove the Input's bottom border (see story/story source for example)
   * - selectedEntities {Array|Immutable.List}:
   *    Given the optionally provided selectedEntityIds, an array or
   *    Immutable.List of entities, based on ID, from allEntities
   **/
  children: PropTypes.func.isRequired,

  /** CSS class names. */
  className: PropTypes.string,

  /**
   * Optional function that, if provided, can be used in place of the
   * standard filter function.
   * - Function will receive item, filterQuery, and contentToSearch arguments
   *   from a filter iterable, the last two values may be undefined so some
   *   sane defaults aren't a bad idea
   * - Should return a boolean value, if null is returned by customFilterFn,
   *   the default filter function will be used instead
   * - Example of a customFilterFn that behaves similarly to the default
   *   filter function:
   *    <FilterPicker
   *      customFilterFn={ (item, filterQuery = '', contentToSearch = '') => {
   *          return (
   *            !item.get('archived') &&
   *            contentToSearch.includes(filterQuery);
   *          );
   *      } }>
   */
  customFilterFn: PropTypes.func,

  /**
   * Optional array of top level keys in allEntities to join and search for
   * the filterQuery
   */
  keysToSearch: PropTypes.array,

  /**
   * Optional array or Immutable.List of numbers of selected entity IDs.
   * Do not provide if selected entities shouldn't be filtered
   * from availableEntities
   */
  selectedEntityIds: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.number), ImmutablePropTypes.listOf(PropTypes.number)]),

  /**
   * String value for the outermost container's
   * data-test-section attribute
   **/
  testSection: PropTypes.string
});

_defineProperty(FilterPicker, "defaultProps", {
  allEntities: [],
  customFilterFn: function customFilterFn() {
    return null;
  },
  keysToSearch: ["name", "description"],
  selectedEntityIds: [],
  testSection: ""
});

FilterPicker.ListItem = ListItem;
export default FilterPicker;