@elliemae/ds-query-builder 2.3.0-alpha.9 → 2.3.0-next.3

package/cjs/components/helpers/selectors.js

@@ -0,0 +1,101 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var types = require('./types.js');
+
+const QB_DEFAULT_VALUES_OPTIONS = [{
+  label: 'Choose a Field',
+  value: ''
+}];
+const QB_SUBJECT_VALUES_OPTIONS = [{
+  label: 'Condominium',
+  value: 'Condominium'
+}, {
+  label: 'Single Family Home',
+  value: 'Single Family Home'
+}, {
+  label: 'Co-Operative',
+  value: 'Co-Operative'
+}, {
+  label: 'Detached',
+  value: 'Detached'
+}, {
+  label: 'High Rise Condominium',
+  value: 'High Rise Condominium'
+}, {
+  label: 'Manufactured Housing',
+  value: 'Manufactured Housing'
+}, {
+  label: 'Other',
+  value: 'Other'
+}];
+const QB_LOAN_VALUES_OPTIONS = [{
+  label: 'Conventional',
+  value: 'Conventional'
+}, {
+  label: 'VA',
+  value: 'VA'
+}, {
+  label: 'FHA',
+  value: 'FHA'
+}, {
+  label: 'USAD-RHS',
+  value: 'USAD-RHS'
+}, {
+  label: 'HELOC',
+  value: 'HELOC'
+}, {
+  label: 'Other',
+  value: 'Other'
+}];
+const QB_FIELD_OPTIONS = [{
+  label: 'Select',
+  value: ''
+}, {
+  label: 'Loan Type',
+  value: types.QB_FIELD_TYPES.LOAN_VALUES
+}, {
+  label: 'Loan To Value (LTV)',
+  value: types.QB_FIELD_TYPES.LTV_VALUES
+}, {
+  label: 'Subject Property Type',
+  value: types.QB_FIELD_TYPES.SUBJECT_VALUES
+}, {
+  label: 'Last Finished Milestone',
+  value: types.QB_FIELD_TYPES.LAST_VALUES
+}, {
+  label: 'Credit Score',
+  value: types.QB_FIELD_TYPES.CREDIT_VALUES
+}];
+const QB_OPERATOR_OPTIONS = [{
+  label: 'Select',
+  value: ''
+}, {
+  label: 'Is',
+  value: types.QB_OPERATOR_TYPES.EQUAL
+}, {
+  label: 'Is not',
+  value: types.QB_OPERATOR_TYPES.NOT_EQUAL
+}, {
+  label: 'Greater than',
+  value: types.QB_OPERATOR_TYPES.GREATER_THAN
+}, {
+  label: 'Less than',
+  value: types.QB_OPERATOR_TYPES.LESS_THAN
+}, {
+  label: 'Contains',
+  value: types.QB_OPERATOR_TYPES.CONTAINS
+}, {
+  label: "Doesn't Contain",
+  value: types.QB_OPERATOR_TYPES.NOT_CONTAINS
+}, {
+  label: 'Between',
+  value: types.QB_OPERATOR_TYPES.BETWEEN
+}];
+
+exports.QB_DEFAULT_VALUES_OPTIONS = QB_DEFAULT_VALUES_OPTIONS;
+exports.QB_FIELD_OPTIONS = QB_FIELD_OPTIONS;
+exports.QB_LOAN_VALUES_OPTIONS = QB_LOAN_VALUES_OPTIONS;
+exports.QB_OPERATOR_OPTIONS = QB_OPERATOR_OPTIONS;
+exports.QB_SUBJECT_VALUES_OPTIONS = QB_SUBJECT_VALUES_OPTIONS;

package/cjs/components/helpers/store.js

@@ -0,0 +1,177 @@
+'use strict';
+
+var _defineProperty = require('@babel/runtime/helpers/defineProperty');
+require('core-js/modules/esnext.async-iterator.for-each.js');
+require('core-js/modules/esnext.iterator.constructor.js');
+require('core-js/modules/esnext.iterator.for-each.js');
+require('core-js/modules/esnext.async-iterator.filter.js');
+require('core-js/modules/esnext.iterator.filter.js');
+var actions = require('./actions.js');
+var format = require('../format/format.js');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var _defineProperty__default = /*#__PURE__*/_interopDefaultLegacy(_defineProperty);
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty__default["default"](target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+/**
+ * Fluent interface: https://en.wikipedia.org/wiki/Fluent_interface
+ *
+ * @param idGroup
+ * @param parentIdGroup
+ * @param items
+ * @param idFilter
+ * @param value
+ * @param data
+ * @class QueryBuilderStore
+ */
+
+class QueryBuilderStore {
+  constructor(init, _format) {
+    this.items = [];
+    this.step = 0;
+    this.steps = {};
+    this.mapFilters = {};
+    this.mapGroups = {};
+    this.main = null;
+    this.format = null;
+
+    this.createNewFilter = idGroup => actions.createNewFilter.call(this, idGroup);
+
+    this.createNewGroup = parentIdGroup => actions.createNewGroup.call(this, parentIdGroup);
+
+    this.onOrderDragAndDrop = items => {
+      this.items = items;
+      return this.getState();
+    };
+
+    this.addFilterNextToFilterId = (idGroup, idFilter) => {
+      // eslint-disable-line
+      this.addFilter(idGroup);
+      return this.getState();
+    };
+
+    this.addFilter = idGroup => {
+      const newFilter = this.createNewFilter(idGroup);
+      actions.addFilterToMap.call(this, newFilter); // new API
+
+      if (this.main === idGroup) {
+        actions.addFilterToMainItem.call(this, this.items, newFilter);
+      } else {
+        const foundInItems = actions.findItemFilterById.call(this, idGroup);
+
+        if (foundInItems) {
+          actions.addFilterToItem.call(this, foundInItems, newFilter);
+        }
+      }
+
+      return this.getState();
+    };
+
+    this.onRemoveFilter = idFilter => {
+      // new API
+      actions.removeFilterItem.call(this, idFilter);
+      return this.getState();
+    };
+
+    this.addRuleContainerInPlace = (idGroup, idFilter) => {
+      // Create a new group
+      const newGroup = this.createNewGroup(idGroup);
+      actions.addGroupFilterToItem.call(this, idGroup, idFilter, newGroup);
+      return this.getState();
+    };
+
+    this.addRuleContainer = (idGroup, idFilter) => {
+      // eslint-disable-line
+      const newGroup = this.createNewGroup(idGroup);
+      actions.addGroupToMap.call(this, newGroup);
+
+      if (this.main === idGroup) {
+        actions.addFilterToMainItem.call(this, this.items, newGroup);
+      } else {
+        const foundInItems = actions.findItemFilterById.call(this, idGroup);
+
+        if (foundInItems) {
+          actions.addFilterToItem.call(this, foundInItems, newGroup);
+        }
+      }
+
+      return this.getState();
+    };
+
+    this.unGroup = idGroup => {
+      actions.unGroupFilterToItem.call(this, idGroup);
+      return this.getState();
+    };
+
+    this.changeGroupOperator = (idGroup, value) => {
+      this.getGroupById(idGroup).condition = value;
+      actions.changeGroupOperator.call(this, idGroup, value);
+      return this.getState();
+    };
+
+    this.changeFilter = data => {
+      const {
+        idFilter
+      } = data;
+      this.mapFilters[idFilter] = _objectSpread(_objectSpread({}, this.mapFilters[idFilter]), data);
+      actions.changeFilterItem.call(this, data);
+      return this.getState();
+    };
+
+    this.getGroupById = idGroup => this.mapGroups[idGroup] || {};
+
+    this.getFilterById = idFilter => this.mapFilters[idFilter];
+
+    this.getInitialState = () => {
+      const newFilters = {
+        step: this.step,
+        mapFilters: _objectSpread({}, this.mapFilters),
+        mapGroups: _objectSpread({}, this.mapGroups),
+        main: this.main,
+        items: this.items
+      };
+      const format$1 = format.run(newFilters, this.format);
+      return _objectSpread(_objectSpread({}, newFilters), {}, {
+        format: format$1
+      });
+    };
+
+    this.getState = () => {
+      this.step += 1;
+      const newFilters = {
+        step: this.step,
+        mapFilters: _objectSpread({}, this.mapFilters),
+        mapGroups: _objectSpread({}, this.mapGroups),
+        main: this.main,
+        items: this.items
+      };
+      const format$1 = format.run(newFilters, this.format);
+      return _objectSpread(_objectSpread({}, newFilters), {}, {
+        format: format$1
+      });
+    };
+
+    this.firstLoad = true;
+    this.format = _format;
+    if (init) return this.initSetupUp(init);
+    const mainGroup = this.createNewGroup('main');
+    this.mapGroups = {
+      [mainGroup.idGroup]: mainGroup
+    };
+    this.main = mainGroup.idGroup;
+    this.addFilter(mainGroup.idGroup);
+  }
+
+  initSetupUp(init) {
+    this.step = init.step || 1;
+    Object.keys(init).forEach(key => {
+      if (init[key] && this[key] !== undefined) this[key] = init[key];
+    });
+  }
+
+}
+
+module.exports = QueryBuilderStore;

package/cjs/components/helpers/types.js

@@ -0,0 +1,64 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const QB_FIELD_TYPES = {
+  LOAN_VALUES: 'loanValues',
+  LTV_VALUES: 'ltvValues',
+  SUBJECT_VALUES: 'subjectValues',
+  LAST_VALUES: 'lastValues',
+  CREDIT_VALUES: 'creditValues'
+};
+const QB_OPERATOR_TYPES = {
+  EQUAL: 'equal',
+  NOT_EQUAL: 'notEqual',
+  GREATER_THAN: 'greaterThan',
+  LESS_THAN: 'lessThan',
+  CONTAINS: 'contains',
+  NOT_CONTAINS: 'notNontains',
+  BETWEEN: 'between',
+  GREATER_THAN_OR_EQUAL: 'greaterThanOrEquals',
+  LESS_THAN_OR_EQUAL: 'lessThanOrEquals',
+  START_WITH: 'startsWith'
+};
+const QB_GROUP_CONDITION_TYPES = {
+  AND: true,
+  OR: false
+};
+const QB_DRAG_TYPES = {
+  FILTER: 'filter',
+  GROUP: 'group'
+};
+const QB_DRAG_LOCATIONS = {
+  ABOVE: 'above',
+  BELOW: 'below'
+};
+const QB_EXPORT_FORMAT_TYPES = {
+  DEFAULT: 'defaultFormat',
+  XML: 'xmlFormat',
+  SQL: 'sqlFormat',
+  SAFESQL: 'sqlSafeFormat'
+};
+const QB_ADD_FILTER_METHOD_TYPES = {
+  IN_PLACE: 'inplace',
+  APPEND: 'append'
+};
+const QB_GROUP_FILTER_METHOD_TYPES = {
+  IN_PLACE: 'inplace',
+  APPEND: 'append'
+};
+const QB_FIELD_SHARED_ACTIONS = {
+  RESET_FIELD: 'resetField',
+  RESET_OPERATOR: 'resetOperator',
+  RESET_VALUE: 'resetValue'
+};
+
+exports.QB_ADD_FILTER_METHOD_TYPES = QB_ADD_FILTER_METHOD_TYPES;
+exports.QB_DRAG_LOCATIONS = QB_DRAG_LOCATIONS;
+exports.QB_DRAG_TYPES = QB_DRAG_TYPES;
+exports.QB_EXPORT_FORMAT_TYPES = QB_EXPORT_FORMAT_TYPES;
+exports.QB_FIELD_SHARED_ACTIONS = QB_FIELD_SHARED_ACTIONS;
+exports.QB_FIELD_TYPES = QB_FIELD_TYPES;
+exports.QB_GROUP_CONDITION_TYPES = QB_GROUP_CONDITION_TYPES;
+exports.QB_GROUP_FILTER_METHOD_TYPES = QB_GROUP_FILTER_METHOD_TYPES;
+exports.QB_OPERATOR_TYPES = QB_OPERATOR_TYPES;

package/cjs/index.js

@@ -0,0 +1,29 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var DSQueryBuilder = require('./DSQueryBuilder.js');
+var types = require('./components/helpers/types.js');
+var selectors = require('./components/helpers/selectors.js');
+var format = require('./components/format/format.js');
+
+
+
+exports.DSQueryBuilder = DSQueryBuilder.DSQueryBuilder;
+exports.DSQueryBuilderWithSchema = DSQueryBuilder.DSQueryBuilderWithSchema;
+exports["default"] = DSQueryBuilder.DSQueryBuilder;
+exports.QB_ADD_FILTER_METHOD_TYPES = types.QB_ADD_FILTER_METHOD_TYPES;
+exports.QB_DRAG_LOCATIONS = types.QB_DRAG_LOCATIONS;
+exports.QB_DRAG_TYPES = types.QB_DRAG_TYPES;
+exports.QB_EXPORT_FORMAT_TYPES = types.QB_EXPORT_FORMAT_TYPES;
+exports.QB_FIELD_SHARED_ACTIONS = types.QB_FIELD_SHARED_ACTIONS;
+exports.QB_FIELD_TYPES = types.QB_FIELD_TYPES;
+exports.QB_GROUP_CONDITION_TYPES = types.QB_GROUP_CONDITION_TYPES;
+exports.QB_GROUP_FILTER_METHOD_TYPES = types.QB_GROUP_FILTER_METHOD_TYPES;
+exports.QB_OPERATOR_TYPES = types.QB_OPERATOR_TYPES;
+exports.QB_DEFAULT_VALUES_OPTIONS = selectors.QB_DEFAULT_VALUES_OPTIONS;
+exports.QB_FIELD_OPTIONS = selectors.QB_FIELD_OPTIONS;
+exports.QB_LOAN_VALUES_OPTIONS = selectors.QB_LOAN_VALUES_OPTIONS;
+exports.QB_OPERATOR_OPTIONS = selectors.QB_OPERATOR_OPTIONS;
+exports.QB_SUBJECT_VALUES_OPTIONS = selectors.QB_SUBJECT_VALUES_OPTIONS;
+exports.QueryBuilderFormat = format;

package/cjs/propTypes.js

@@ -0,0 +1,97 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var reactDesc = require('react-desc');
+var types = require('./components/helpers/types.js');
+
+const props = {
+  /** inpect props to component wrapper */
+  containerProps: reactDesc.PropTypes.object.description('inject props to component wrapper'),
+
+  /** add filter strategy */
+  addFilterMethod: reactDesc.PropTypes.oneOf([types.QB_ADD_FILTER_METHOD_TYPES.APPEND, types.QB_ADD_FILTER_METHOD_TYPES.IN_PLACE]).description('add filter strategy'),
+
+  /** group filter strategy */
+  groupFilterMethod: reactDesc.PropTypes.oneOf([types.QB_ADD_FILTER_METHOD_TYPES.APPEND, types.QB_ADD_FILTER_METHOD_TYPES.IN_PLACE]).description('group filter strategy'),
+
+  /** change callback */
+  onChange: reactDesc.PropTypes.func.description('change callback'),
+
+  /** fields to query */
+  fields: reactDesc.PropTypes.arrayOf(reactDesc.PropTypes.shape({
+    target: reactDesc.PropTypes.oneOf(['operator', 'field', 'value']),
+    component: reactDesc.PropTypes.element,
+    condition: reactDesc.PropTypes.arrayOf(reactDesc.PropTypes.shape({
+      source: reactDesc.PropTypes.oneOf(['operator', 'field', 'value']),
+      operator: reactDesc.PropTypes.oneOf(['checkNotEmpty', 'greaterThan', 'greaterThanOrEquals', 'lessThanOrEquals', 'startsWith', 'contains', 'validDate', 'equal', 'notEqual', 'isNull', 'isNotNull', 'isIn', 'isNotIn']),
+      value: reactDesc.PropTypes.oneOfType([reactDesc.PropTypes.string, reactDesc.PropTypes.number])
+    }))
+  })).description('fields to query'),
+
+  /** fields actions */
+  fieldsSharedActions: reactDesc.PropTypes.shape({
+    onFieldChange: reactDesc.PropTypes.arrayOf(reactDesc.PropTypes.func),
+    onOperatorChange: reactDesc.PropTypes.arrayOf(reactDesc.PropTypes.func),
+    onValueChange: reactDesc.PropTypes.arrayOf(reactDesc.PropTypes.func)
+  }).description('fields actions'),
+
+  /** query builder format */
+  format: reactDesc.PropTypes.string.description('query builder format'),
+
+  /** initial values */
+  init: reactDesc.PropTypes.shape({
+    step: reactDesc.PropTypes.number,
+    mapFilters: reactDesc.PropTypes.object,
+    mapGroups: reactDesc.PropTypes.object,
+    main: reactDesc.PropTypes.string,
+    items: reactDesc.PropTypes.arrayOf(reactDesc.PropTypes.object)
+  }).description('initial values'),
+
+  /** class for rule container */
+  ruleContainerClassName: reactDesc.PropTypes.string.description('class for rule container'),
+
+  /** handle field change */
+  handleDrop: reactDesc.PropTypes.func.description('handle field change'),
+
+  /** handle field change drop */
+  handleDropFilter: reactDesc.PropTypes.func.description('handle field change drop'),
+
+  /** handle field group change */
+  handleDropGroup: reactDesc.PropTypes.func.description('handle field group change'),
+
+  /** handle field change */
+  handleFieldChange: reactDesc.PropTypes.func.description('handle field change'),
+
+  /** handle rule container operator change */
+  handleRuleContainerOperator: reactDesc.PropTypes.func.description('handle rule container operator change'),
+
+  /** handle rule container grouping change */
+  handleRuleContainerUnGroup: reactDesc.PropTypes.func.description('handle rule container grouping change'),
+
+  /** filter add callback */
+  onAddFilter: reactDesc.PropTypes.func.description('filter add callback'),
+
+  /** rule container add callback */
+  onAddRuleContainer: reactDesc.PropTypes.func.description('rule container add callback'),
+
+  /** remove filter callback */
+  onRemoveFilter: reactDesc.PropTypes.func.description('remove filter callback'),
+  displayFixedOutput: reactDesc.PropTypes.string.description("Label for fixed output.Using this props it will ignore 'displayOutput' and 'displayOutputLabel' \n  and it will always render the output without the ability to close it. \n  ").defaultValue(''),
+
+  /** show output */
+  displayOutput: reactDesc.PropTypes.bool.description('show output'),
+
+  /** show output label */
+  displayOutputLabel: reactDesc.PropTypes.shape({
+    show: reactDesc.PropTypes.string,
+    hide: reactDesc.PropTypes.string,
+    open: reactDesc.PropTypes.bool
+  }).description('show output label'),
+
+  /** one or multiple rows for query */
+  singleRow: reactDesc.PropTypes.bool.description('one or multiple rows for query'),
+  toolTipZIndex: reactDesc.PropTypes.number.description('ZIndex for action controls').defaultValue(110)
+};
+
+exports.props = props;

package/esm/DSQueryBuilder.js

@@ -0,0 +1,74 @@
+import _jsx from '@babel/runtime/helpers/esm/jsx';
+import 'react';
+import { describe } from 'react-desc';
+import QueryBuilderImpl from './components/QueryBuilderImpl.js';
+import { QB_ADD_FILTER_METHOD_TYPES, QB_GROUP_FILTER_METHOD_TYPES, QB_EXPORT_FORMAT_TYPES } from './components/helpers/types.js';
+export { QB_ADD_FILTER_METHOD_TYPES, QB_DRAG_LOCATIONS, QB_DRAG_TYPES, QB_EXPORT_FORMAT_TYPES, QB_FIELD_SHARED_ACTIONS, QB_FIELD_TYPES, QB_GROUP_CONDITION_TYPES, QB_GROUP_FILTER_METHOD_TYPES, QB_OPERATOR_TYPES } from './components/helpers/types.js';
+export { QB_DEFAULT_VALUES_OPTIONS, QB_FIELD_OPTIONS, QB_LOAN_VALUES_OPTIONS, QB_OPERATOR_OPTIONS, QB_SUBJECT_VALUES_OPTIONS } from './components/helpers/selectors.js';
+export { default as QueryBuilderFormat } from './components/format/format.js';
+import { props } from './propTypes.js';
+
+const DSQueryBuilder = _ref => {
+  let {
+    containerProps = {},
+    addFilterMethod = QB_ADD_FILTER_METHOD_TYPES.IN_PLACE,
+    groupFilterMethod = QB_GROUP_FILTER_METHOD_TYPES.IN_PLACE,
+    onChange = () => null,
+    fields = [],
+    fieldsSharedActions = {
+      onFieldChange: [],
+      onOperatorChange: [],
+      onValueChange: []
+    },
+    format = QB_EXPORT_FORMAT_TYPES.DEFAULT,
+    init = null,
+    ruleContainerClassName = '',
+    handleDrop = () => null,
+    handleDropFilter = () => null,
+    handleDropGroup = () => null,
+    handleFieldChange = () => null,
+    handleRuleContainerOperator = () => null,
+    handleRuleContainerUnGroup = () => null,
+    onAddFilter = () => null,
+    onAddRuleContainer = () => null,
+    onRemoveFilter = () => null,
+    displayFixedOutput,
+    displayOutput = false,
+    displayOutputLabel = {
+      show: 'Show output',
+      hide: 'Hide output'
+    },
+    singleRow = false,
+    toolTipZIndex = 110
+  } = _ref;
+  return /*#__PURE__*/_jsx(QueryBuilderImpl, {
+    addFilterMethod: addFilterMethod,
+    containerProps: containerProps,
+    displayFixedOutput: displayFixedOutput,
+    displayOutput: displayOutput,
+    displayOutputLabel: displayOutputLabel,
+    fields: fields,
+    fieldsSharedActions: fieldsSharedActions,
+    format: format,
+    groupFilterMethod: groupFilterMethod,
+    handleDrop: handleDrop,
+    handleDropFilter: handleDropFilter,
+    handleDropGroup: handleDropGroup,
+    handleFieldChange: handleFieldChange,
+    handleRuleContainerOperator: handleRuleContainerOperator,
+    handleRuleContainerUnGroup: handleRuleContainerUnGroup,
+    init: init,
+    onAddFilter: onAddFilter,
+    onAddRuleContainer: onAddRuleContainer,
+    onChange: onChange,
+    onRemoveFilter: onRemoveFilter,
+    ruleContainerClassName: ruleContainerClassName,
+    singleRow: singleRow,
+    toolTipZIndex: toolTipZIndex
+  });
+};
+
+const DSQueryBuilderWithSchema = describe(DSQueryBuilder);
+DSQueryBuilderWithSchema.propTypes = props;
+
+export { DSQueryBuilder, DSQueryBuilderWithSchema, DSQueryBuilder as default };