@pareto-engineering/design-system 4.0.0-alpha.62 → 4.0.0-alpha.63

package/dist/cjs/f/fields/V2/QueryCombobox/QueryCombobox.js

@@ -0,0 +1,229 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireWildcard(require("react"));
+var React = _react;
+var _formik = require("formik");
+var _reactRelay = require("react-relay");
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _common = require("./common");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; } /* @pareto-engineering/generator-front 1.0.12 */ // Local Definitions
+/**
+ * This is the component description.
+ */
+const QueryCombobox = _ref => {
+  let {
+    id,
+    style,
+    className,
+    query,
+    multiple,
+    name,
+    label,
+    labelColor,
+    color,
+    optional,
+    description,
+    disabled,
+    debounceMs,
+    searchVariable,
+    extraVariables,
+    optionsKeyMap,
+    minLength,
+    transformSearch,
+    validate,
+    placeholder,
+    promptCreateNewOption
+    // ...otherProps
+  } = _ref;
+  (0, _react.useInsertionEffect)(() => {
+    Promise.resolve().then(() => _interopRequireWildcard(require("./styles.scss")));
+  }, []);
+  const [, meta, helpers] = (0, _formik.useField)({
+    name,
+    validate
+  });
+  const {
+    setValue,
+    setError
+  } = helpers;
+  const {
+    value
+  } = meta;
+  const environment = (0, _reactRelay.useRelayEnvironment)();
+  const [isFetching, setIsFetching] = (0, _react.useState)(false);
+  const [options, setOptions] = (0, _react.useState)([]);
+  const {
+    graphql,
+    accessor
+  } = query;
+  const getOptions = inputValue => {
+    if (isFetching) return;
+    let variables = {
+      [searchVariable]: inputValue
+    };
+    if (extraVariables) {
+      variables = {
+        ...variables,
+        ...extraVariables
+      };
+    }
+    (0, _reactRelay.fetchQuery)(environment, graphql, variables).subscribe({
+      start: () => {
+        setIsFetching(true);
+      },
+      complete: () => {
+        setIsFetching(false);
+      },
+      error: fetchError => {
+        setIsFetching(false);
+        if (setError) setError(fetchError.message);
+      },
+      next: data => {
+        setOptions(data[accessor].edges.map(_ref2 => {
+          let {
+            node
+          } = _ref2;
+          return {
+            value: node[optionsKeyMap.value],
+            label: optionsKeyMap.getLabel(node)
+          };
+        }));
+      }
+    });
+  };
+  const comboboxProps = {
+    id,
+    style,
+    options,
+    getOptions,
+    setOptions,
+    debounceMs,
+    disabled,
+    name,
+    label,
+    labelColor,
+    optional,
+    description,
+    setValue,
+    value,
+    color,
+    isFetching,
+    className,
+    minLength,
+    transformSearch,
+    placeholder,
+    promptCreateNewOption
+  };
+  const Input = multiple ? _common.MultipleCombobox : _common.Combobox;
+  return /*#__PURE__*/React.createElement(Input, comboboxProps);
+};
+QueryCombobox.propTypes = {
+  /**
+   * The HTML id for this element
+   */
+  id: _propTypes.default.string,
+  /**
+   * The HTML class names for this element
+   */
+  className: _propTypes.default.string,
+  /**
+   * The React-written, css properties for this element.
+   */
+  style: _propTypes.default.objectOf(_propTypes.default.string),
+  /**
+   * The name of the custom select input
+   */
+  name: _propTypes.default.string,
+  /**
+   * The label of the custom select input
+   */
+  label: _propTypes.default.string,
+  /**
+   * The label color of the custom select input
+   */
+  labelColor: _propTypes.default.string,
+  /**
+   * The custom select input description
+   */
+  description: _propTypes.default.string,
+  /**
+   * Whether the input should be disabled
+   */
+  disabled: _propTypes.default.bool,
+  /**
+   * The base color of the tiles
+   */
+  color: _propTypes.default.string,
+  /**
+   * The debounce time in milliseconds
+   */
+  debounceMs: _propTypes.default.number,
+  /**
+   * The graphql query to fetch the options and the accessor to destructure the results from
+   */
+  query: _propTypes.default.shape({
+    accessor: _propTypes.default.string,
+    graphql: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.object]).isRequired
+  }),
+  /**
+   *  The extra variables required to be used in the query.
+   */
+  extraVariables: _propTypes.default.objectOf(_propTypes.default.string),
+  /**
+   *  The select option keys to be used to map the data to the select options.
+   * i.e `{ value: 'id', label: 'name' }`
+   */
+  optionsKeyMap: _propTypes.default.shape({
+    value: _propTypes.default.string.isRequired,
+    getLabel: _propTypes.default.func.isRequired
+  }),
+  /**
+   * Whether to allow multiple items selection
+   */
+  multiple: _propTypes.default.bool,
+  /**
+   * The variable to be used to search the data
+   */
+  searchVariable: _propTypes.default.string,
+  /**
+   * The minimum length of the search input to start fetching the options
+   */
+  minLength: _propTypes.default.number,
+  /**
+   * The function to transform the search input
+   */
+  transformSearch: _propTypes.default.func,
+  /**
+   * The query combobox field validator function
+   */
+  validate: _propTypes.default.func,
+  /*
+  * Whether the input is optional or not
+  */
+  optional: _propTypes.default.bool,
+  /**
+   * Whether to prompt the user to create a new option if the search input
+   * does not match any of the options
+   */
+  promptCreateNewOption: _propTypes.default.bool
+};
+QueryCombobox.defaultProps = {
+  optionsKeyMap: {
+    value: 'id',
+    getLabel: node => node.name
+  },
+  multiple: false,
+  color: 'interactive',
+  searchVariable: 'search',
+  transformSearch: search => search,
+  minLength: 2,
+  disabled: false,
+  promptCreateNewOption: false
+};
+var _default = exports.default = QueryCombobox;

package/dist/cjs/f/fields/V2/QueryCombobox/common/Combobox/Combobox.js

@@ -0,0 +1,236 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireWildcard(require("react"));
+var React = _react;
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _downshift = require("downshift");
+var _exports = _interopRequireDefault(require("@pareto-engineering/bem/exports"));
+var _ = require("../../../../..");
+var _a = require("../../../../../../a");
+var _b = require("../../../../../../b");
+var _common = require("../../../../../common");
+var _Menu = require("../Menu");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _extends() { _extends = Object.assign ? Object.assign.bind() : 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); } /* @pareto-engineering/generator-front 1.0.12 */ // Local Definitions
+const baseClassName = _exports.default.base;
+const componentClassName = 'combobox';
+
+/**
+ * This is the component description.
+ */
+const Combobox = _ref => {
+  let {
+    id,
+    className: userClassName,
+    style,
+    label,
+    labelColor,
+    name,
+    options: items,
+    getOptions,
+    setOptions,
+    setValue,
+    description,
+    value,
+    color,
+    minLength,
+    isFetching,
+    transformSearch,
+    disabled,
+    optional,
+    placeholder,
+    promptCreateNewOption
+    // ...otherProps
+  } = _ref;
+  const {
+    isOpen,
+    selectItem,
+    selectedItem,
+    inputValue,
+    setInputValue,
+    getLabelProps,
+    getMenuProps,
+    getInputProps,
+    highlightedIndex,
+    getComboboxProps,
+    getItemProps
+  } = (0, _downshift.useCombobox)({
+    items,
+    initialSelectedItem: value,
+    itemToString: item => item ? item.label : '',
+    onInputValueChange: _ref2 => {
+      let {
+        inputValue: searchInputValue
+      } = _ref2;
+      const transformedInput = transformSearch(searchInputValue);
+      if (transformedInput.length > minLength) {
+        getOptions(transformedInput);
+      }
+    }
+  });
+  (0, _react.useEffect)(() => {
+    if (promptCreateNewOption) {
+      (0, _common.lookUpInputValueFromFetchedOptions)({
+        items,
+        inputValue,
+        setOptions,
+        minLength
+      });
+    }
+  }, [inputValue, items, promptCreateNewOption]);
+
+  // If the user has selected an item, we'll set the value of the field
+  // or if the combobox state has a selected item, we'll set the value to the formik state
+  (0, _react.useEffect)(() => {
+    if (selectedItem) {
+      setValue(selectedItem);
+    }
+  }, [selectedItem]);
+
+  // If the formik state has a value, we'll set the selected item to the combobox state
+  (0, _react.useEffect)(() => {
+    if (value?.value !== selectedItem?.value) {
+      selectItem(value);
+    }
+  }, [value]);
+  const parentRef = (0, _react.useRef)(null);
+  const resetInputValue = () => setInputValue('');
+  return /*#__PURE__*/React.createElement("div", _extends({
+    id: id,
+    className: [baseClassName, componentClassName, userClassName, `y-${color}`].filter(e => e).join(' '),
+    style: style,
+    ref: parentRef
+  }, getComboboxProps()), /*#__PURE__*/React.createElement(_.FormLabelV2, _extends({}, getLabelProps(), {
+    name: name,
+    optional: optional,
+    color: labelColor
+  }), label), /*#__PURE__*/React.createElement("input", _extends({}, getInputProps(), {
+    className: "input",
+    disabled: disabled,
+    placeholder: placeholder
+  })), isFetching && /*#__PURE__*/React.createElement(_a.LoadingCircle, {
+    className: "x-main"
+  }), inputValue.length > minLength && !isFetching && /*#__PURE__*/React.createElement(_b.Button, {
+    isSimple: true,
+    isCompact: true,
+    color: "heading",
+    onClick: resetInputValue
+  }, /*#__PURE__*/React.createElement("span", {
+    className: "icon"
+  }, "Y")), /*#__PURE__*/React.createElement(_.FormDescriptionV2, {
+    className: "s-1",
+    description: description,
+    name: name
+  }), /*#__PURE__*/React.createElement(_a.Popover, {
+    isOpen: isOpen,
+    parentRef: parentRef
+  }, /*#__PURE__*/React.createElement(_Menu.Menu, _extends({
+    className: `y-${color}`,
+    isOpen: isOpen,
+    getItemProps: getItemProps,
+    highlightedIndex: highlightedIndex,
+    items: items
+  }, getMenuProps()))));
+};
+Combobox.propTypes = {
+  /**
+   * The HTML id for this element
+   */
+  id: _propTypes.default.string,
+  /**
+   * The HTML class names for this element
+   */
+  className: _propTypes.default.string,
+  /**
+   * The React-written, css properties for this element.
+   */
+  style: _propTypes.default.objectOf(_propTypes.default.string),
+  /**
+   * The label of the custom select input
+   */
+  label: _propTypes.default.string,
+  /**
+   * The custom select input options from the backend
+   */
+  options: _propTypes.default.arrayOf(_propTypes.default.shape({
+    value: _propTypes.default.string,
+    label: _propTypes.default.string
+  })),
+  /**
+   * The name of the custom select input
+   */
+  name: _propTypes.default.string,
+  /**
+   * The function to fetch the options from the backend
+   */
+  getOptions: _propTypes.default.func,
+  /**
+   * The function to set the value of the custom select input
+   */
+  setValue: _propTypes.default.func.isRequired,
+  /**
+   * The custom select input description
+   */
+  description: _propTypes.default.string,
+  /**
+   * The value of the custom select input
+   */
+  value: _propTypes.default.shape({
+    value: _propTypes.default.string,
+    label: _propTypes.default.string
+  }),
+  /**
+   * The base color of the combobox custom select input
+   */
+  color: _propTypes.default.string,
+  /**
+   * Whether the query getting the combobox options is inFlight
+   */
+  isFetching: _propTypes.default.bool.isRequired,
+  /**
+   * The minimum length of the search input to start fetching the options
+   */
+  minLength: _propTypes.default.number,
+  /**
+   * The function to transform the search input
+   */
+  transformSearch: _propTypes.default.func,
+  /**
+   * Whether the input filed shpuld be disabled
+   */
+  disabled: _propTypes.default.bool,
+  /**
+  * The number of columns the label should span
+  */
+  labelSpan: _propTypes.default.number,
+  /**
+   * The number of columns the input should span
+   */
+  inputSpan: _propTypes.default.number,
+  /**
+   * The number of columns the label should span on desktop
+   */
+  desktopLabelSpan: _propTypes.default.number,
+  /**
+   * The number of columns the input should span on desktop
+   */
+  desktopInputSpan: _propTypes.default.number,
+  /**
+  * Whether the input is optional or not
+  */
+  optional: _propTypes.default.bool,
+  /**
+   * The placeholder text for the input
+   */
+  placeholder: _propTypes.default.string
+};
+Combobox.defaultProps = {
+  // someProp: false
+};
+var _default = exports.default = Combobox;

package/dist/cjs/f/fields/V2/QueryCombobox/common/Combobox/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "Combobox", {
+  enumerable: true,
+  get: function () {
+    return _Combobox.default;
+  }
+});
+var _Combobox = _interopRequireDefault(require("./Combobox"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dist/cjs/f/fields/V2/QueryCombobox/common/Menu/Menu.js

@@ -0,0 +1,83 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var React = _interopRequireWildcard(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _exports = _interopRequireDefault(require("@pareto-engineering/bem/exports"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _extends() { _extends = Object.assign ? Object.assign.bind() : 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); } /* @pareto-engineering/generator-front 1.0.12 */
+// Local Definitions
+
+const baseClassName = _exports.default.base;
+const componentClassName = 'menu';
+
+/**
+ * This is the component description.
+ */
+const Menu = /*#__PURE__*/React.forwardRef((_ref, ref) => {
+  let {
+    id,
+    className: userClassName,
+    style,
+    items,
+    isOpen,
+    highlightedIndex,
+    getItemProps,
+    ...otherProps
+  } = _ref;
+  return /*#__PURE__*/React.createElement("ul", _extends({
+    id: id,
+    className: [baseClassName, componentClassName, userClassName].filter(e => e).join(' '),
+    style: style,
+    ref: ref
+  }, otherProps), isOpen && items.map((item, index) => /*#__PURE__*/React.createElement("li", _extends({
+    key: item.label
+  }, getItemProps({
+    item,
+    index
+  }), {
+    className: ['item', highlightedIndex === index && _exports.default.modifierActive].filter(Boolean).join(' ')
+  }), /*#__PURE__*/React.createElement("p", null, item.label))));
+});
+Menu.propTypes = {
+  /**
+   * The HTML id for this element
+   */
+  id: _propTypes.default.string,
+  /**
+   * The HTML class names for this element
+   */
+  className: _propTypes.default.string,
+  /**
+   * The React-written, css properties for this element.
+   */
+  style: _propTypes.default.objectOf(_propTypes.default.string),
+  /**
+   *  The items to be displayed in the menu
+   */
+  items: _propTypes.default.arrayOf(_propTypes.default.shape({
+    value: _propTypes.default.string,
+    label: _propTypes.default.string
+  })),
+  /**
+   * Whether or not the menu is open
+   */
+  isOpen: _propTypes.default.bool,
+  /**
+   * The index of the highlighted item
+   */
+  highlightedIndex: _propTypes.default.number,
+  /**
+   * The function to get the item props
+   */
+  getItemProps: _propTypes.default.func
+};
+Menu.defaultProps = {
+  // someProp:false
+};
+var _default = exports.default = Menu;

package/dist/cjs/f/fields/V2/QueryCombobox/common/Menu/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "Menu", {
+  enumerable: true,
+  get: function () {
+    return _Menu.default;
+  }
+});
+var _Menu = _interopRequireDefault(require("./Menu"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }