@performant-software/user-defined-fields 0.6.2-beta.3

package/src/components/UserDefinedFieldsForm.js

@@ -0,0 +1,209 @@
+// @flow
+
+import { DatePicker } from '@performant-software/semantic-components';
+import { RichTextArea, UserDefinedFieldsService } from '@performant-software/shared-components';
+import React, {
+  useCallback,
+  useEffect,
+  useMemo,
+  useState,
+  type ComponentType
+} from 'react';
+import { Form } from 'semantic-ui-react';
+import _ from 'underscore';
+
+type Props = {
+  defineableId?: number,
+  defineableType?: string,
+  isError: (key: string) => boolean,
+  item: any,
+  onChange: (obj: any) => void,
+  onClearValidationError: (...keys: Array<string>) => void
+};
+
+const DataTypes = {
+  boolean: 'Boolean',
+  date: 'Date',
+  number: 'Number',
+  richText: 'RichText',
+  select: 'Select',
+  string: 'String',
+  text: 'Text'
+};
+
+const UserDefinedFieldsForm: ComponentType<any> = (props: Props) => {
+  const [fields, setFields] = useState([]);
+
+  /**
+   * Sets the parsed value by parsing the JSON stored in the "user_defined" prop of the item.
+   *
+   * @type {unknown}
+   */
+  const parsedValue = useMemo(() => {
+    let value = {};
+
+    if (_.isString(props.item.user_defined)) {
+      value = JSON.parse(props.item.user_defined);
+    }
+
+    return value;
+  }, [props.item.user_defined]);
+
+  /**
+   * Returns the key for the passed field.
+   *
+   * @type {function(*): string}
+   */
+  const getFieldKey = useCallback((field) => `user_defined[${field.column_name}]`, []);
+
+  /**
+   * Returns true if an error exists on the state for the passed field.
+   *
+   * @type {function(*): *}
+   */
+  const isError = useCallback((field) => props.isError(getFieldKey(field)), [getFieldKey, props.isError]);
+
+  /**
+   * Changes the value for the passed item.
+   *
+   * @type {(function(*, *): void)|*}
+   */
+  const onChange = useCallback((field, value) => {
+    props.onChange(JSON.stringify({ ...parsedValue, [field.column_name]: value }));
+
+    // Clear the validation error if one exists
+    if (props.onClearValidationError) {
+      props.onClearValidationError(getFieldKey(field));
+    }
+  }, [getFieldKey, parsedValue, props.onChange, props.onClearValidationError]);
+
+  /**
+   * Renders the passed item.
+   *
+   * @type {function(*): *}
+   */
+  const renderItem = useCallback((field) => {
+    let rendered;
+
+    const fieldValue = parsedValue && parsedValue[field.column_name];
+
+    if (field.data_type === DataTypes.string) {
+      rendered = (
+        <Form.Input
+          error={isError(field)}
+          label={field.column_name}
+          required={field.required}
+          onChange={(e, { value }) => onChange(field, value)}
+          value={fieldValue}
+        />
+      );
+    }
+
+    if (field.data_type === DataTypes.number) {
+      rendered = (
+        <Form.Input
+          error={isError(field)}
+          label={field.column_name}
+          required={field.required}
+          onChange={(e, { value }) => onChange(field, value)}
+          value={fieldValue}
+          type='number'
+        />
+      );
+    }
+
+    if (field.data_type === DataTypes.select) {
+      rendered = (
+        <Form.Dropdown
+          clearable
+          error={isError(field)}
+          label={field.column_name}
+          multiple={field.allow_multiple}
+          required={field.required}
+          options={_.map(field.options, (option) => ({ key: option, value: option, text: option }))}
+          onChange={(e, { value }) => onChange(field, value)}
+          selectOnBlur={false}
+          selection
+          value={fieldValue}
+        />
+      );
+    }
+
+    if (field.data_type === DataTypes.text) {
+      rendered = (
+        <Form.TextArea
+          error={isError(field)}
+          label={field.column_name}
+          required={field.required}
+          onChange={(e, { value }) => onChange(field, value)}
+          value={fieldValue}
+        />
+      );
+    }
+
+    if (field.data_type === DataTypes.date) {
+      rendered = (
+        <Form.Input
+          error={isError(field)}
+          label={field.column_name}
+          required={field.required}
+        >
+          <DatePicker
+            onChange={(date) => onChange(field, date && date.toString())}
+            value={fieldValue && new Date(fieldValue)}
+          />
+        </Form.Input>
+      );
+    }
+
+    if (field.data_type === DataTypes.boolean) {
+      rendered = (
+        <Form.Checkbox
+          checked={!!fieldValue}
+          error={isError(field)}
+          label={field.column_name}
+          onChange={(e, { checked }) => onChange(field, checked)}
+        />
+      );
+    }
+
+    if (field.data_type === DataTypes.richText) {
+      rendered = (
+        <Form.Input
+          error={isError(field)}
+          label={field.column_name}
+          required={field.required}
+        >
+          <RichTextArea
+            onChange={(value) => onChange(field, value)}
+            value={fieldValue}
+          />
+        </Form.Input>
+      );
+    }
+
+    return rendered;
+  }, [parsedValue, isError, onChange]);
+
+  /**
+   * Fetches the user defined fields when the component mounts.
+   */
+  useEffect(() => {
+    const params = {
+      defineable_id: props.defineableId,
+      defineable_type: props.defineableType
+    };
+
+    UserDefinedFieldsService
+      .fetchAll(params)
+      .then(({ data }) => setFields(data.user_defined_fields));
+  }, []);
+
+  return (
+    <>
+      { _.map(fields, renderItem.bind(this)) }
+    </>
+  );
+};
+
+export default UserDefinedFieldsForm;

package/src/components/UserDefinedFieldsList.js

@@ -0,0 +1,40 @@
+// @flow
+
+import { BooleanIcon, ListTable } from '@performant-software/semantic-components';
+import { UserDefinedFieldsService } from '@performant-software/shared-components';
+import React, { type ComponentType } from 'react';
+import i18n from '../i18n/i18n';
+import UserDefinedFieldModal from './UserDefinedFieldModal';
+
+const UserDefinedFieldsList: ComponentType<any> = () => (
+  <ListTable
+    actions={[{
+      name: 'edit'
+    }, {
+      name: 'delete'
+    }]}
+    columns={[{
+      name: 'table_name',
+      label: i18n.t('UserDefinedFieldsList.columns.table')
+    }, {
+      name: 'column_name',
+      label: i18n.t('UserDefinedFieldsList.columns.name')
+    }, {
+      name: 'data_type',
+      label: i18n.t('UserDefinedFieldsList.columns.dataType')
+    }, {
+      name: 'required',
+      label: i18n.t('UserDefinedFieldsList.columns.required'),
+      render: (udf) => <BooleanIcon value={udf.required} />
+    }]}
+    collectionName='user_defined_fields'
+    modal={{
+      component: UserDefinedFieldModal
+    }}
+    onLoad={(params) => UserDefinedFieldsService.fetchAll(params)}
+    onSave={(udf) => UserDefinedFieldsService.save(udf)}
+    onDelete={(udf) => UserDefinedFieldsService.delete(udf)}
+  />
+);
+
+export default UserDefinedFieldsList;

package/src/i18n/en.json

@@ -0,0 +1,31 @@
+{
+  "UserDefinedFieldModal": {
+    "labels": {
+      "allowMultiple": "Allow multiple",
+      "dataType": "Data type",
+      "name": "Name",
+      "required": "Required",
+      "table": "Table"
+    },
+    "title": {
+      "add": "Add User Defined Field",
+      "edit": "Edit User Defined Field"
+    }
+  },
+  "UserDefinedFieldsEmbeddedList": {
+    "columns": {
+      "dataType": "Data type",
+      "name": "Name",
+      "required": "Required",
+      "table": "Table"
+    }
+  },
+  "UserDefinedFieldsList": {
+    "columns": {
+      "dataType": "Data type",
+      "name": "Name",
+      "required": "Required",
+      "table": "Table"
+    }
+  }
+}

package/src/i18n/i18n.js

@@ -0,0 +1,24 @@
+import i18next from 'i18next';
+
+import en from './en.json';
+
+const resources = {
+  en: {
+    translation: en
+  }
+};
+
+const i18n = i18next.createInstance();
+
+i18n
+  .init({
+    debug: true,
+    fallbackLng: 'en',
+    lng: 'en',
+    interpolation: {
+      escapeValue: false,
+    },
+    resources
+  });
+
+export default i18n;

package/src/index.js

@@ -0,0 +1,18 @@
+// @flow
+
+// Components
+export { default as UserDefinedFieldModal } from './components/UserDefinedFieldModal';
+export { default as UserDefinedFieldOptions } from './components/UserDefinedFieldOptions';
+export { default as UserDefinedFieldsEmbeddedList } from './components/UserDefinedFieldsEmbeddedList';
+export { default as UserDefinedFieldsForm } from './components/UserDefinedFieldsForm';
+export { default as UserDefinedFieldsList } from './components/UserDefinedFieldsList';
+
+// Services
+export { default as UserDefinedFieldsService } from './services/UserDefinedFields';
+
+// Transforms
+export { default as UserDefinedFieldTransform } from './transforms/UserDefinedField';
+export { default as UserDefinedFieldsTransform } from './transforms/UserDefinedFields';
+
+// Utils
+export { default as UserDefinedFields } from './utils/UserDefinedFields';

package/src/services/UserDefinedFields.js

@@ -0,0 +1,48 @@
+// @flow
+
+import { BaseService } from '@performant-software/shared-components';
+import UserDefinedField from '../transforms/UserDefinedField';
+
+/**
+ * Class responsible for handling all user defined field API requests.
+ */
+class UserDefinedFields extends BaseService {
+  /**
+   * Calls the /api/user_defined_fields/data_types API endpoint.
+   *
+   * @returns {Promise<AxiosResponse<any>>}
+   */
+  fetchDataTypes(): Promise<any> {
+    return this.getAxios().get('/user_defined_fields/data_types');
+  }
+
+  /**
+   * Calls the /api/user_defined_fields/tables API endpoint.
+   *
+   * @returns {Promise<AxiosResponse<any>>}
+   */
+  fetchTables(): Promise<any> {
+    return this.getAxios().get('/user_defined_fields/tables');
+  }
+
+  /**
+   * Returns the user defined fields base URL.
+   *
+   * @returns {string}
+   */
+  getBaseUrl(): string {
+    return '/user_defined_fields/user_defined_fields';
+  }
+
+  /**
+   * Returns the user defined fields transform object.
+   *
+   * @returns {UserDefinedField}
+   */
+  getTransform(): any {
+    return UserDefinedField;
+  }
+}
+
+const UserDefinedFieldsService: UserDefinedFields = new UserDefinedFields();
+export default UserDefinedFieldsService;

package/src/transforms/UserDefinedField.js

@@ -0,0 +1,36 @@
+// @flow
+
+import { BaseTransform } from '@performant-software/shared-components';
+
+/**
+ * Class for transforming user defined field objects for PUT/POST requests.
+ */
+class UserDefinedField extends BaseTransform {
+  /**
+   * Returns the user defined field payload keys.
+   *
+   * @returns {string[]}
+   */
+  getPayloadKeys(): Array<string> {
+    return [
+      'table_name',
+      'column_name',
+      'data_type',
+      'required',
+      'allow_multiple',
+      'options'
+    ];
+  }
+
+  /**
+   * Returns the user defined field parameter name.
+   *
+   * @returns {string}
+   */
+  getParameterName(): string {
+    return 'user_defined_field';
+  }
+}
+
+const UserDefinedFieldTransform: UserDefinedField = new UserDefinedField();
+export default UserDefinedFieldTransform;

package/src/transforms/UserDefinedFields.js

@@ -0,0 +1,55 @@
+// @flow
+
+import { NestedAttributesTransform } from '@performant-software/shared-components';
+
+/**
+ * Class for transforming user defined field nested objects for PUT/POST requests.
+ */
+class UserDefinedFields extends NestedAttributesTransform {
+  /**
+   * Returns the user defined field payload keys.
+   *
+   * @returns {string[]}
+   */
+  getPayloadKeys(): Array<string> {
+    return [
+      'id',
+      'table_name',
+      'column_name',
+      'data_type',
+      'required',
+      'allow_multiple',
+      'options',
+      '_destroy'
+    ];
+  }
+
+  /**
+   * Converts the user defined field collection for the passed object to form data to be sent on
+   * the request as nested attributes.
+   *
+   * @param formData
+   * @param prefix
+   * @param record
+   * @param collection
+   */
+  toFormData(formData: FormData, prefix: string, record: any, collection: string = 'user_defined_fields'): void {
+    return super.toFormData(formData, prefix, record, collection);
+  }
+
+  /**
+   * Converts the user defined field collection for the passed object to JSON to be sent on
+   * the request as nested attributes.
+   *
+   * @param record
+   * @param collectionName
+   *
+   * @returns {{[p: string]: *}}
+   */
+  toPayload(record: any, collectionName: string = 'user_defined_fields'): any {
+    return super.toPayload(record, collectionName);
+  }
+}
+
+const UserDefinedFieldsTransform: UserDefinedFields = new UserDefinedFields();
+export default UserDefinedFieldsTransform;

package/src/utils/UserDefinedFields.js

@@ -0,0 +1,61 @@
+// @flow
+
+import _ from 'underscore';
+
+type Item = {
+  user_defined: ?string
+};
+
+type ErrorProps = {
+  key: string,
+  error: Array<string>
+};
+
+type ErrorReturn = {
+  [key: string]: string
+};
+
+const KEY_USER_DEFINED = 'user_defined';
+
+/**
+ * Returns the error for the passed user defined field.
+ *
+ * @param key
+ * @param error
+ *
+ * @returns {{}|{[p: string]: *}}
+ */
+const resolveError = ({ key, error }: ErrorProps): ErrorReturn => {
+  if (key !== KEY_USER_DEFINED || _.isEmpty(error)) {
+    return {};
+  }
+
+  const [field, message] = error;
+
+  return {
+    [`${KEY_USER_DEFINED}[${field}]`]: message
+  };
+};
+
+/**
+ * Returns the value for the user defined field at the passed key for the passed item.
+ *
+ * @param item
+ * @param key
+ *
+ * @returns {*}
+ */
+const resolveValue = (item: Item, key: string): string => {
+  let userDefined = {};
+
+  if (_.isString(item.user_defined)) {
+    userDefined = JSON.parse(item.user_defined || '{}');
+  }
+
+  return userDefined[key];
+};
+
+export default {
+  resolveError,
+  resolveValue
+};

package/types/components/UserDefinedFieldModal.js.flow

@@ -0,0 +1,114 @@
+// @flow
+
+import { UserDefinedFieldsService } from '@performant-software/shared-components';
+import React, {
+  useCallback,
+  useEffect,
+  useState,
+  type ComponentType
+} from 'react';
+import { Form, Modal } from 'semantic-ui-react';
+import _ from 'underscore';
+import i18n from '../i18n/i18n';
+import UserDefinedFieldOptions from './UserDefinedFieldOptions';
+
+const DataTypes = {
+  select: 'Select'
+};
+
+const UserDefinedFieldModal: ComponentType<any> = (props) => {
+  const [dataTypeOptions, setDataTypeOptions] = useState([]);
+  const [tableOptions, setTableOptions] = useState([]);
+
+  /**
+   * Transforms the passed array of items into a Semantic UI option object.
+   *
+   * @type {function(*): *}
+   */
+  const transformOptions = useCallback((items) => (
+    _.map(items, (item) => ({ key: item, value: item, text: item }))
+  ), []);
+
+  /**
+   * Fetch the available tables and data types.
+   */
+  useEffect(() => {
+    UserDefinedFieldsService
+      .fetchTables()
+      .then(({ data }) => setTableOptions(transformOptions(data.tables)));
+
+    UserDefinedFieldsService
+      .fetchDataTypes()
+      .then(({ data }) => setDataTypeOptions(transformOptions(data.data_types)));
+  }, []);
+
+  return (
+    <Modal
+      as={Form}
+      centered={false}
+      open
+    >
+      <Modal.Header
+        content={props.item.id
+          ? i18n.t('UserDefinedFieldModal.title.edit')
+          : i18n.t('UserDefinedFieldModal.title.add')}
+      />
+      <Modal.Content>
+        <Form.Dropdown
+          clearable
+          error={props.isError('table_name')}
+          label={i18n.t('UserDefinedFieldModal.labels.table')}
+          onChange={props.onTextInputChange.bind(this, 'table_name')}
+          options={tableOptions}
+          required={props.isRequired('table_name')}
+          selection
+          selectOnBlur={false}
+          value={props.item.table_name || ''}
+        />
+        <Form.Input
+          error={props.isError('column_name')}
+          label={i18n.t('UserDefinedFieldModal.labels.name')}
+          onChange={props.onTextInputChange.bind(this, 'column_name')}
+          required={props.isRequired('column_name')}
+          value={props.item.column_name || ''}
+        />
+        <Form.Dropdown
+          clearable
+          error={props.isError('data_type')}
+          label={i18n.t('UserDefinedFieldModal.labels.dataType')}
+          onChange={props.onTextInputChange.bind(this, 'data_type')}
+          options={dataTypeOptions}
+          required={props.isRequired('data_type')}
+          selection
+          selectOnBlur={false}
+          value={props.item.data_type || ''}
+        />
+        <Form.Group>
+          <Form.Checkbox
+            error={props.isError('required')}
+            checked={props.item.required}
+            label={i18n.t('UserDefinedFieldModal.labels.required')}
+            onChange={props.onCheckboxInputChange.bind(this, 'required')}
+          />
+          { props.item.data_type === DataTypes.select && (
+            <Form.Checkbox
+              error={props.isError('allow_multiple')}
+              checked={props.item.allow_multiple}
+              label={i18n.t('UserDefinedFieldModal.labels.allowMultiple')}
+              onChange={props.onCheckboxInputChange.bind(this, 'allow_multiple')}
+            />
+          )}
+        </Form.Group>
+        { props.item.data_type === DataTypes.select && (
+          <UserDefinedFieldOptions
+            options={props.item.options}
+            onChange={(options) => props.onSetState({ options })}
+          />
+        )}
+      </Modal.Content>
+      { props.children }
+    </Modal>
+  );
+};
+
+export default UserDefinedFieldModal;