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

package/dist/es/f/fields/V2/QueryChoices/QueryChoices.js

@@ -0,0 +1,126 @@
+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 */
+import * as React from 'react';
+import { useEffect, useState } from 'react';
+import { useRelayEnvironment, fetchQuery } from 'react-relay';
+import { useField } from 'formik';
+import PropTypes from 'prop-types';
+import { ChoicesInput } from "../ChoicesInput";
+
+/**
+ * This is the component description.
+ */
+const QueryChoices = ({
+  name,
+  optionsKeyMap,
+  query,
+  variables,
+  validate,
+  loadingOption,
+  extraVariables,
+  ...otherProps
+}) => {
+  const [,, helpers] = useField({
+    name,
+    validate
+  });
+  const {
+    setError
+  } = helpers;
+  const environment = useRelayEnvironment();
+  const [isFetching, setIsFetching] = useState(false);
+  const [options, setOptions] = useState([loadingOption]);
+  const {
+    graphql,
+    accessor
+  } = query;
+  const getOptions = () => {
+    if (isFetching) return;
+    let searchVariables = variables;
+    if (extraVariables) {
+      searchVariables = {
+        ...variables,
+        ...extraVariables
+      };
+    }
+    fetchQuery(environment, graphql, searchVariables).subscribe({
+      start: () => {
+        setIsFetching(true);
+      },
+      complete: () => {
+        setIsFetching(false);
+      },
+      error: fetchError => {
+        setIsFetching(false);
+        if (setError) setError(fetchError.message);
+      },
+      next: data => {
+        setOptions([...data[accessor].edges.map(({
+          node
+        }) => ({
+          value: node[optionsKeyMap.value],
+          label: optionsKeyMap.getLabel(node)
+        }))]);
+      }
+    });
+  };
+  useEffect(() => {
+    getOptions();
+  }, [variables]);
+  return /*#__PURE__*/React.createElement(ChoicesInput, _extends({
+    name: name,
+    validate: validate,
+    options: options
+  }, otherProps));
+};
+QueryChoices.propTypes = {
+  /**
+   * The choices name
+   */
+  name: PropTypes.string.isRequired,
+  /**
+  *  The select option keys to be used to map the data to the select options.
+  * i.e `{ value: 'id', label: 'name' }`
+  */
+  optionsKeyMap: PropTypes.shape({
+    value: PropTypes.string.isRequired,
+    getLabel: PropTypes.func.isRequired
+  }).isRequired,
+  /**
+  * The graphql query to fetch the options and the accessor to destructure the results from
+  */
+  query: PropTypes.shape({
+    accessor: PropTypes.string,
+    graphql: PropTypes.oneOfType([PropTypes.string, PropTypes.object]).isRequired
+  }),
+  /**
+   *  The variables that might be required to be used in the query to fetch
+   *  select options.
+   */
+  variables: PropTypes.objectOf(PropTypes.string),
+  /**
+  * The option to displayed when the select options are being fetched
+  */
+  loadingOption: PropTypes.shape({
+    value: PropTypes.string.isRequired,
+    label: PropTypes.string.isRequired,
+    disabled: PropTypes.bool.isRequired
+  }),
+  /**
+   * The input field validator function
+   */
+  validate: PropTypes.string,
+  /**
+   *  The extra variables that might be required to be used in the query to fetch
+   *  select options.
+   */
+  extraVariables: PropTypes.objectOf(PropTypes.string)
+};
+QueryChoices.defaultProps = {
+  loadingOption: {
+    value: '',
+    label: 'Fetching Options',
+    disabled: true
+  }
+};
+export default QueryChoices;

package/dist/es/f/fields/V2/QueryChoices/index.js

@@ -0,0 +1,2 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+export { default as QueryChoices } from "./QueryChoices";

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

@@ -0,0 +1,221 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+import * as React from 'react';
+import { useState, useInsertionEffect } from 'react';
+import { useField } from 'formik';
+import { useRelayEnvironment, fetchQuery } from 'react-relay';
+import PropTypes from 'prop-types';
+
+// Local Definitions
+
+import { Combobox, MultipleCombobox } from "./common";
+
+/**
+ * This is the component description.
+ */
+const QueryCombobox = ({
+  id,
+  style,
+  className,
+  query,
+  multiple,
+  name,
+  label,
+  labelColor,
+  color,
+  optional,
+  description,
+  disabled,
+  debounceMs,
+  searchVariable,
+  extraVariables,
+  optionsKeyMap,
+  minLength,
+  transformSearch,
+  validate,
+  placeholder,
+  promptCreateNewOption
+  // ...otherProps
+}) => {
+  useInsertionEffect(() => {
+    import("./styles.scss");
+  }, []);
+  const [, meta, helpers] = useField({
+    name,
+    validate
+  });
+  const {
+    setValue,
+    setError
+  } = helpers;
+  const {
+    value
+  } = meta;
+  const environment = useRelayEnvironment();
+  const [isFetching, setIsFetching] = useState(false);
+  const [options, setOptions] = useState([]);
+  const {
+    graphql,
+    accessor
+  } = query;
+  const getOptions = inputValue => {
+    if (isFetching) return;
+    let variables = {
+      [searchVariable]: inputValue
+    };
+    if (extraVariables) {
+      variables = {
+        ...variables,
+        ...extraVariables
+      };
+    }
+    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(({
+          node
+        }) => ({
+          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 ? MultipleCombobox : Combobox;
+  return /*#__PURE__*/React.createElement(Input, comboboxProps);
+};
+QueryCombobox.propTypes = {
+  /**
+   * The HTML id for this element
+   */
+  id: PropTypes.string,
+  /**
+   * The HTML class names for this element
+   */
+  className: PropTypes.string,
+  /**
+   * The React-written, css properties for this element.
+   */
+  style: PropTypes.objectOf(PropTypes.string),
+  /**
+   * The name of the custom select input
+   */
+  name: PropTypes.string,
+  /**
+   * The label of the custom select input
+   */
+  label: PropTypes.string,
+  /**
+   * The label color of the custom select input
+   */
+  labelColor: PropTypes.string,
+  /**
+   * The custom select input description
+   */
+  description: PropTypes.string,
+  /**
+   * Whether the input should be disabled
+   */
+  disabled: PropTypes.bool,
+  /**
+   * The base color of the tiles
+   */
+  color: PropTypes.string,
+  /**
+   * The debounce time in milliseconds
+   */
+  debounceMs: PropTypes.number,
+  /**
+   * The graphql query to fetch the options and the accessor to destructure the results from
+   */
+  query: PropTypes.shape({
+    accessor: PropTypes.string,
+    graphql: PropTypes.oneOfType([PropTypes.string, PropTypes.object]).isRequired
+  }),
+  /**
+   *  The extra variables required to be used in the query.
+   */
+  extraVariables: PropTypes.objectOf(PropTypes.string),
+  /**
+   *  The select option keys to be used to map the data to the select options.
+   * i.e `{ value: 'id', label: 'name' }`
+   */
+  optionsKeyMap: PropTypes.shape({
+    value: PropTypes.string.isRequired,
+    getLabel: PropTypes.func.isRequired
+  }),
+  /**
+   * Whether to allow multiple items selection
+   */
+  multiple: PropTypes.bool,
+  /**
+   * The variable to be used to search the data
+   */
+  searchVariable: PropTypes.string,
+  /**
+   * The minimum length of the search input to start fetching the options
+   */
+  minLength: PropTypes.number,
+  /**
+   * The function to transform the search input
+   */
+  transformSearch: PropTypes.func,
+  /**
+   * The query combobox field validator function
+   */
+  validate: PropTypes.func,
+  /*
+  * Whether the input is optional or not
+  */
+  optional: PropTypes.bool,
+  /**
+   * Whether to prompt the user to create a new option if the search input
+   * does not match any of the options
+   */
+  promptCreateNewOption: PropTypes.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
+};
+export default QueryCombobox;

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

@@ -0,0 +1,229 @@
+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 */
+import * as React from 'react';
+import { useEffect, useRef } from 'react';
+import PropTypes from 'prop-types';
+import { useCombobox } from 'downshift';
+import styleNames from '@pareto-engineering/bem/exports';
+import { FormLabelV2, FormDescriptionV2 } from "../../../../..";
+import { Popover, LoadingCircle } from "../../../../../../a";
+import { Button } from "../../../../../../b";
+import { lookUpInputValueFromFetchedOptions } from "../../../../../common";
+
+// Local Definitions
+
+import { Menu } from "../Menu";
+const baseClassName = styleNames.base;
+const componentClassName = 'combobox';
+
+/**
+ * This is the component description.
+ */
+const Combobox = ({
+  id,
+  className: userClassName,
+  style,
+  label,
+  labelColor,
+  name,
+  options: items,
+  getOptions,
+  setOptions,
+  setValue,
+  description,
+  value,
+  color,
+  minLength,
+  isFetching,
+  transformSearch,
+  disabled,
+  optional,
+  placeholder,
+  promptCreateNewOption
+  // ...otherProps
+}) => {
+  const {
+    isOpen,
+    selectItem,
+    selectedItem,
+    inputValue,
+    setInputValue,
+    getLabelProps,
+    getMenuProps,
+    getInputProps,
+    highlightedIndex,
+    getComboboxProps,
+    getItemProps
+  } = useCombobox({
+    items,
+    initialSelectedItem: value,
+    itemToString: item => item ? item.label : '',
+    onInputValueChange: ({
+      inputValue: searchInputValue
+    }) => {
+      const transformedInput = transformSearch(searchInputValue);
+      if (transformedInput.length > minLength) {
+        getOptions(transformedInput);
+      }
+    }
+  });
+  useEffect(() => {
+    if (promptCreateNewOption) {
+      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
+  useEffect(() => {
+    if (selectedItem) {
+      setValue(selectedItem);
+    }
+  }, [selectedItem]);
+
+  // If the formik state has a value, we'll set the selected item to the combobox state
+  useEffect(() => {
+    if (value?.value !== selectedItem?.value) {
+      selectItem(value);
+    }
+  }, [value]);
+  const parentRef = 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(LoadingCircle, {
+    className: "x-main"
+  }), inputValue.length > minLength && !isFetching && /*#__PURE__*/React.createElement(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(Popover, {
+    isOpen: isOpen,
+    parentRef: parentRef
+  }, /*#__PURE__*/React.createElement(Menu, _extends({
+    className: `y-${color}`,
+    isOpen: isOpen,
+    getItemProps: getItemProps,
+    highlightedIndex: highlightedIndex,
+    items: items
+  }, getMenuProps()))));
+};
+Combobox.propTypes = {
+  /**
+   * The HTML id for this element
+   */
+  id: PropTypes.string,
+  /**
+   * The HTML class names for this element
+   */
+  className: PropTypes.string,
+  /**
+   * The React-written, css properties for this element.
+   */
+  style: PropTypes.objectOf(PropTypes.string),
+  /**
+   * The label of the custom select input
+   */
+  label: PropTypes.string,
+  /**
+   * The custom select input options from the backend
+   */
+  options: PropTypes.arrayOf(PropTypes.shape({
+    value: PropTypes.string,
+    label: PropTypes.string
+  })),
+  /**
+   * The name of the custom select input
+   */
+  name: PropTypes.string,
+  /**
+   * The function to fetch the options from the backend
+   */
+  getOptions: PropTypes.func,
+  /**
+   * The function to set the value of the custom select input
+   */
+  setValue: PropTypes.func.isRequired,
+  /**
+   * The custom select input description
+   */
+  description: PropTypes.string,
+  /**
+   * The value of the custom select input
+   */
+  value: PropTypes.shape({
+    value: PropTypes.string,
+    label: PropTypes.string
+  }),
+  /**
+   * The base color of the combobox custom select input
+   */
+  color: PropTypes.string,
+  /**
+   * Whether the query getting the combobox options is inFlight
+   */
+  isFetching: PropTypes.bool.isRequired,
+  /**
+   * The minimum length of the search input to start fetching the options
+   */
+  minLength: PropTypes.number,
+  /**
+   * The function to transform the search input
+   */
+  transformSearch: PropTypes.func,
+  /**
+   * Whether the input filed shpuld be disabled
+   */
+  disabled: PropTypes.bool,
+  /**
+  * The number of columns the label should span
+  */
+  labelSpan: PropTypes.number,
+  /**
+   * The number of columns the input should span
+   */
+  inputSpan: PropTypes.number,
+  /**
+   * The number of columns the label should span on desktop
+   */
+  desktopLabelSpan: PropTypes.number,
+  /**
+   * The number of columns the input should span on desktop
+   */
+  desktopInputSpan: PropTypes.number,
+  /**
+  * Whether the input is optional or not
+  */
+  optional: PropTypes.bool,
+  /**
+   * The placeholder text for the input
+   */
+  placeholder: PropTypes.string
+};
+Combobox.defaultProps = {
+  // someProp: false
+};
+export default Combobox;

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

@@ -0,0 +1,2 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+export { default as Combobox } from "./Combobox";

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

@@ -0,0 +1,73 @@
+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 */
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import styleNames from '@pareto-engineering/bem/exports';
+
+// Local Definitions
+
+const baseClassName = styleNames.base;
+const componentClassName = 'menu';
+
+/**
+ * This is the component description.
+ */
+const Menu = /*#__PURE__*/React.forwardRef(({
+  id,
+  className: userClassName,
+  style,
+  items,
+  isOpen,
+  highlightedIndex,
+  getItemProps,
+  ...otherProps
+}, ref) => /*#__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 && styleNames.modifierActive].filter(Boolean).join(' ')
+}), /*#__PURE__*/React.createElement("p", null, item.label)))));
+Menu.propTypes = {
+  /**
+   * The HTML id for this element
+   */
+  id: PropTypes.string,
+  /**
+   * The HTML class names for this element
+   */
+  className: PropTypes.string,
+  /**
+   * The React-written, css properties for this element.
+   */
+  style: PropTypes.objectOf(PropTypes.string),
+  /**
+   *  The items to be displayed in the menu
+   */
+  items: PropTypes.arrayOf(PropTypes.shape({
+    value: PropTypes.string,
+    label: PropTypes.string
+  })),
+  /**
+   * Whether or not the menu is open
+   */
+  isOpen: PropTypes.bool,
+  /**
+   * The index of the highlighted item
+   */
+  highlightedIndex: PropTypes.number,
+  /**
+   * The function to get the item props
+   */
+  getItemProps: PropTypes.func
+};
+Menu.defaultProps = {
+  // someProp:false
+};
+export default Menu;

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

@@ -0,0 +1,2 @@
+/* @pareto-engineering/generator-front 1.0.12 */
+export { default as Menu } from "./Menu";