@performant-software/controlled-vocabulary 3.1.22-beta.4 → 3.1.22-beta.6

package/src/utils/Reference.js

@@ -1,21 +0,0 @@
-// @flow
-
-import _ from 'underscore';
-
-const LIST_DELIMITER = ', ';
-
-/**
- * Returns the view value for the  passed array of references.
- *
- * @param references
- *
- * @returns {*}
- */
-const getViewValue = (references) => _.map(
-  _.filter(references, (reference) => !reference._destroy),
-  (reference) => reference.reference_code?.name
-).join(LIST_DELIMITER);
-
-export default {
-  getViewValue
-};

package/types/components/ReferenceCodeDropdown.js.flow

@@ -1,148 +0,0 @@
-// @flow
-
-import React, {
-  useCallback,
-  useEffect,
-  useMemo,
-  useState
-} from 'react';
-import { Dropdown } from 'semantic-ui-react';
-import _ from 'underscore';
-import ReferenceCodesService from '../services/ReferenceCodes';
-
-type Item = {
-  reference_table_id: number,
-  key: string
-};
-
-type Props = {
-  disabled?: boolean,
-  fluid?: boolean,
-  multiple?: boolean,
-  onChange: (item: Item) => void,
-  placeholder?: string,
-  referenceTable: string,
-  value: Item | Array<Item>
-};
-
-const ReferenceCodeDropdown = (props: Props) => {
-  const [loading, setLoading] = useState(false);
-  const [options, setOptions] = useState([]);
-
-  /**
-   * Sets the "value" variable for the Dropdown component.
-   */
-  const value = useMemo(() => {
-    const v = _.pluck(_.filter(props.value, (x) => !x._destroy), 'reference_code_id');
-    return props.multiple ? v : _.first(v);
-  }, [props.multiple, props.value]);
-
-  /**
-   * Converts the passed ID to a reference code item.
-   *
-   * @type {function(*): {reference_code_id: *}}
-   */
-  const toItem = useCallback((id) => {
-    const option = _.findWhere(options, { key: id });
-
-    return {
-      reference_code_id: id,
-      reference_code: {
-        id,
-        name: option.text
-      }
-    };
-  }, [options]);
-
-  /**
-   * Converts the passed reference code to a dropdown option.
-   *
-   * @type {function(*): {text: *, value: *, key: *}}
-   */
-  const toOption = useCallback((referenceCode) => ({
-    key: referenceCode.id,
-    value: referenceCode.id,
-    text: referenceCode.name
-  }), []);
-
-  /**
-   * Converts the selected values and calls the onChange prop.
-   *
-   * @type {(function(*, {value: *}): void)|*}
-   */
-  const onChange = useCallback((e, data) => {
-    let referenceCodeIds;
-
-    if (props.multiple) {
-      referenceCodeIds = data.value;
-    } else {
-      referenceCodeIds = _.compact([data.value]);
-    }
-
-    const items = [];
-
-    // Find existing records or create new records
-    _.each(referenceCodeIds, (referenceCodeId) => {
-      let newValue = _.findWhere(props.value, { reference_code_id: referenceCodeId });
-
-      if (!newValue) {
-        newValue = toItem(referenceCodeId);
-      }
-
-      items.push(_.omit(newValue, '_destroy'));
-    });
-
-    // Mark records for delete
-    _.each(props.value, (v) => {
-      if (v.id && !_.contains(referenceCodeIds, v.reference_code_id)) {
-        items.push({ ...v, _destroy: true });
-      }
-    });
-
-    props.onChange(items);
-  }, [toItem, props.multiple, props.onChange, props.value]);
-
-  /**
-   * Loads the list of reference codes from the server.
-   */
-  useEffect(() => {
-    setLoading(true);
-
-    const params = {
-      per_page: 0,
-      reference_table: props.referenceTable,
-      sort_by: 'name'
-    };
-
-    ReferenceCodesService
-      .fetchAll(params)
-      .then(({ data }) => setOptions(_.map(data.reference_codes, toOption)))
-      .finally(() => setLoading(false));
-  }, [toOption]);
-
-  return (
-    <Dropdown
-      clearable
-      disabled={loading || props.disabled}
-      fluid={props.fluid}
-      loading={loading}
-      multiple={props.multiple}
-      onChange={onChange}
-      options={options}
-      placeholder={props.placeholder}
-      search
-      selection
-      selectOnBlur={false}
-      value={value}
-    />
-  );
-};
-
-ReferenceCodeDropdown.defaultProps = {
-  disabled: false,
-  fluid: true,
-  multiple: false,
-  placeholder: undefined
-};
-
-export default ReferenceCodeDropdown;

package/types/components/ReferenceCodeFormDropdown.js.flow

@@ -1,76 +0,0 @@
-// @flow
-
-import { EditModal } from '@performant-software/semantic-components';
-import React, { type ComponentType, useState } from 'react';
-import { Form } from 'semantic-ui-react';
-import ReferenceCodeDropdown from './ReferenceCodeDropdown';
-import ReferenceCodeFormLabel from './ReferenceCodeFormLabel';
-import ReferenceTableModal from './ReferenceTableModal';
-import ReferenceTablesService from '../services/ReferenceTables';
-
-type Props = {
-  error?: boolean,
-  label?: string,
-  required?: boolean,
-  referenceTable: string
-};
-
-const ReferenceCodeFormDropdown: ComponentType<any> = (props: Props) => {
-  const {
-    error,
-    label,
-    required,
-    referenceTable,
-    ...rest
-  } = props;
-
-  const [modal, setModal] = useState(false);
-  const [dropdownKey, setDropdownKey] = useState(0);
-
-  return (
-    <>
-      <Form.Input
-        error={error}
-        label={(
-          <ReferenceCodeFormLabel
-            label={label}
-            onClick={() => setModal(true)}
-            referenceTable={referenceTable}
-          />
-        )}
-        required={required}
-      >
-        <ReferenceCodeDropdown
-          {...rest}
-          id={referenceTable}
-          referenceTable={referenceTable}
-          key={dropdownKey}
-        />
-      </Form.Input>
-      { modal && (
-        <EditModal
-          component={ReferenceTableModal}
-          item={{ id: referenceTable, key: referenceTable }}
-          onClose={() => setModal(false)}
-          onInitialize={(key) => (
-            ReferenceTablesService
-              .fetchByKey(key)
-              .then(({ data }) => ({
-                ...data.reference_table,
-                key
-              }))
-          )}
-          onSave={(record) => (
-            ReferenceTablesService
-              .save(record)
-              .then(({ data }) => data.reference_table)
-              .then(() => setDropdownKey((prevKey) => prevKey + 1))
-              .finally(() => setModal(false))
-          )}
-        />
-      )}
-    </>
-  );
-};
-
-export default ReferenceCodeFormDropdown;

package/types/components/ReferenceCodeFormLabel.js.flow

@@ -1,52 +0,0 @@
-// @flow
-
-import React, { type ComponentType } from 'react';
-import {
-  Button,
-  Header,
-  Icon,
-  Popup
-} from 'semantic-ui-react';
-import i18n from '../i18n/i18n';
-import './ReferenceCodeFormLabel.css';
-
-type Props = {
-  label: string,
-  onClick: () => void,
-  referenceTable: string
-};
-
-const ReferenceCodeFormLabel: ComponentType<any> = (props: Props) => (
-  <>
-    <label
-      className='reference-code-form-label'
-      htmlFor={props.referenceTable}
-    >
-      { props.label }
-    </label>
-    <Popup
-      hoverable
-      trigger={(
-        <Icon
-          name='info circle'
-          style={{
-            marginLeft: '0.3em'
-          }}
-        />
-      )}
-    >
-      <Header
-        content={props.label}
-      />
-      <p>{ i18n.t('ReferenceCodeFormLabel.content', { name: props.label })}</p>
-      <Button
-        content={i18n.t('Common.buttons.edit')}
-        icon='edit'
-        primary
-        onClick={props.onClick}
-      />
-    </Popup>
-  </>
-);
-
-export default ReferenceCodeFormLabel;

package/types/components/ReferenceCodeModal.js.flow

@@ -1,38 +0,0 @@
-// @flow
-
-import { ModalContext, type EditContainerProps } from '@performant-software/shared-components';
-import React from 'react';
-import { Form, Modal } from 'semantic-ui-react';
-import i18n from '../i18n/i18n';
-
-const ReferenceCodeModal = (props: EditContainerProps) => (
-  <ModalContext.Consumer>
-    { (mountNode) => (
-      <Modal
-        as={Form}
-        centered={false}
-        mountNode={mountNode}
-        open
-      >
-        <Modal.Header
-          content={props.item.id
-            ? i18n.t('ReferenceCodeModal.title.edit')
-            : i18n.t('ReferenceCodeModal.title.add')}
-        />
-        <Modal.Content>
-          <Form.Input
-            autoFocus
-            error={props.isError('name')}
-            label={i18n.t('ReferenceCodeModal.labels.name')}
-            onChange={props.onTextInputChange.bind(this, 'name')}
-            required={props.isRequired('name')}
-            value={props.item.name || ''}
-          />
-        </Modal.Content>
-        { props.children }
-      </Modal>
-    )}
-  </ModalContext.Consumer>
-);
-
-export default ReferenceCodeModal;

package/types/components/ReferenceTableModal.js.flow

@@ -1,73 +0,0 @@
-// @flow
-
-import { EmbeddedList } from '@performant-software/semantic-components';
-import { ModalContext, type EditContainerProps } from '@performant-software/shared-components';
-import React from 'react';
-import { Form, Header, Modal } from 'semantic-ui-react';
-import i18n from '../i18n/i18n';
-import ReferenceCodeModal from './ReferenceCodeModal';
-
-const ReferenceTableModal = (props: EditContainerProps) => (
-  <ModalContext.Consumer>
-    { (mountNode) => (
-      <Modal
-        as={Form}
-        centered={false}
-        className='reference-table-modal'
-        mountNode={mountNode}
-        open
-      >
-        <Modal.Header
-          content={props.item.id
-            ? i18n.t('ReferenceTableModal.title.edit')
-            : i18n.t('ReferenceTableModal.title.add')}
-        />
-        <Modal.Content>
-          <Form.Input
-            autoFocus
-            error={props.isError('name')}
-            label={i18n.t('ReferenceTableModal.labels.name')}
-            onChange={props.onTextInputChange.bind(this, 'name')}
-            required={props.isRequired('name')}
-            value={props.item.name || ''}
-          />
-          <Form.Input
-            error={props.isError('key')}
-            label={i18n.t('ReferenceTableModal.labels.key')}
-            onChange={props.onTextInputChange.bind(this, 'key')}
-            required={props.isRequired('key')}
-            value={props.item.key || ''}
-          />
-          <Header
-            content={i18n.t('ReferenceTableModal.labels.referenceCodes')}
-          />
-          <EmbeddedList
-            actions={[{
-              name: 'edit'
-            }, {
-              name: 'copy'
-            }, {
-              name: 'delete'
-            }]}
-            columns={[{
-              name: 'name',
-              label: i18n.t('ReferenceTableModal.referenceCodes.columns.name')
-            }]}
-            items={props.item.reference_codes}
-            modal={{
-              component: ReferenceCodeModal,
-              props: {
-                required: ['name']
-              }
-            }}
-            onDelete={props.onDeleteChildAssociation.bind(this, 'reference_codes')}
-            onSave={props.onSaveChildAssociation.bind(this, 'reference_codes')}
-          />
-        </Modal.Content>
-        { props.children }
-      </Modal>
-    )}
-  </ModalContext.Consumer>
-);
-
-export default ReferenceTableModal;

package/types/components/ReferenceTablesList.js.flow

@@ -1,44 +0,0 @@
-// @flow
-
-import { ListTable } from '@performant-software/semantic-components';
-import React from 'react';
-import ReferenceTableModal from './ReferenceTableModal';
-import ReferenceTablesService from '../services/ReferenceTables';
-
-const ReferenceTablesList = () => (
-  <ListTable
-    actions={[{
-      name: 'edit'
-    }, {
-      name: 'copy'
-    }, {
-      name: 'delete'
-    }]}
-    collectionName='reference_tables'
-    columns={[{
-      name: 'name',
-      label: 'Name',
-      sortable: true
-    }, {
-      name: 'key',
-      label: 'Key',
-      sortable: true
-    }]}
-    modal={{
-      component: ReferenceTableModal,
-      props: {
-        onInitialize: (id) => (
-          ReferenceTablesService
-            .fetchOne(id)
-            .then(({ data }) => data.reference_table)
-        ),
-        required: ['name', 'key']
-      }
-    }}
-    onDelete={(referenceTable) => ReferenceTablesService.delete(referenceTable)}
-    onLoad={(params) => ReferenceTablesService.fetchAll(params)}
-    onSave={(referenceTable) => ReferenceTablesService.save(referenceTable)}
-  />
-);
-
-export default ReferenceTablesList;

package/types/i18n/i18n.js.flow

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

package/types/index.js.flow

@@ -1,23 +0,0 @@
-// @flow
-
-// Components
-export { default as ReferenceCodeDropdown } from './components/ReferenceCodeDropdown';
-export { default as ReferenceCodeFormDropdown } from './components/ReferenceCodeFormDropdown';
-export { default as ReferenceCodeFormLabel } from './components/ReferenceCodeFormLabel';
-export { default as ReferenceCodeModal } from './components/ReferenceCodeModal';
-export { default as ReferenceTablesList } from './components/ReferenceTablesList';
-
-// Services
-export { default as ReferenceCodesService } from './services/ReferenceCodes';
-export { default as ReferenceTablesService } from './services/ReferenceTables';
-
-// Transforms
-export { default as ReferenceCodesTransform } from './transforms/ReferenceCodes';
-export { default as ReferencesTransform } from './transforms/References';
-export { default as ReferenceTableTransform } from './transforms/ReferenceTable';
-
-// Types
-export type { Referrable as ReferrableType } from './types/Referrable';
-
-// Utils
-export { default as Reference } from './utils/Reference';

package/types/services/ReferenceCodes.js.flow

@@ -1,28 +0,0 @@
-// @flow
-
-import { BaseService } from '@performant-software/shared-components';
-
-/**
- * Class responsible for handling all reference code API requests.
- */
-class ReferenceCodes extends BaseService {
-  /**
-   * Returns the reference codes base URL.
-   *
-   * @returns {string}
-   */
-  getBaseUrl() {
-    return '/controlled_vocabulary/reference_codes';
-  }
-
-  /**
-   * Returns the reference codes transform object.
-   *
-   * @returns {{}}
-   */
-  getTransform() {
-    return { }; // PUT/POST routes not implemented
-  }
-}
-
-export default new ReferenceCodes();

package/types/services/ReferenceTables.js.flow

@@ -1,40 +0,0 @@
-// @flow
-
-import { BaseService } from '@performant-software/shared-components';
-import ReferenceTable from '../transforms/ReferenceTable';
-
-/**
- * Class responsible for handling all reference table API requests.
- */
-class ReferenceTables extends BaseService {
-  /**
-   * Calls the find_by_key API end point for reference tables.
-   *
-   * @param key
-   *
-   * @returns {Promise<AxiosResponse<any>>}
-   */
-  fetchByKey(key) {
-    return this.getAxios().get(`${this.getBaseUrl()}/find_by_key`, { params: { key } });
-  }
-
-  /**
-   * Returns the reference tables base URL.
-   *
-   * @returns {string}
-   */
-  getBaseUrl() {
-    return '/controlled_vocabulary/reference_tables';
-  }
-
-  /**
-   * Returns the reference table transform object.
-   *
-   * @returns {ReferenceTable}
-   */
-  getTransform() {
-    return ReferenceTable;
-  }
-}
-
-export default new ReferenceTables();

package/types/transforms/ReferenceCodes.js.flow

@@ -1,35 +0,0 @@
-// @flow
-
-import { NestedAttributesTransform } from '@performant-software/shared-components';
-
-/**
- * Class for transforming reference codes nested objects for PUT/POST requests.
- */
-class ReferenceCodes extends NestedAttributesTransform {
-  /**
-   * Returns the reference codes payload keys.
-   *
-   * @returns {string[]}
-   */
-  getPayloadKeys(): Array<string> {
-    return [
-      'id',
-      'name',
-      '_destroy'
-    ];
-  }
-
-  /**
-   * Calls the super method with a default value for the collection name.
-   *
-   * @param record
-   * @param collection
-   *
-   * @returns {{[p: string]: *}}
-   */
-  toPayload(record: any, collection: string = 'reference_codes') {
-    return super.toPayload(record, collection);
-  }
-}
-
-export default new ReferenceCodes();

package/types/transforms/ReferenceTable.js.flow

@@ -1,53 +0,0 @@
-// @flow
-
-import { BaseTransform } from '@performant-software/shared-components';
-import ReferenceCodes from './ReferenceCodes';
-
-type ReferenceTableType = {
-  id: number,
-  name: string,
-  key: string
-};
-
-/**
- * Class for transforming reference table objects for PUT/POST requests.
- */
-class ReferenceTable extends BaseTransform {
-  /**
-   * Returns the reference table parameter name.
-   *
-   * @returns {string}
-   */
-  getParameterName() {
-    return 'reference_table';
-  }
-
-  /**
-   * Returns the reference table payload keys.
-   *
-   * @returns {string[]}
-   */
-  getPayloadKeys() {
-    return [
-      'name',
-      'key'
-    ];
-  }
-
-  /**
-   * Converts the passed reference table object to JSON for PUT/POST requests.
-   *
-   * @param referenceTable
-   * @param attributes
-   *
-   * @returns {*}
-   */
-  toPayload(referenceTable: ReferenceTableType, attributes: any = {}) {
-    return super.toPayload(referenceTable, {
-      ...attributes,
-      ...ReferenceCodes.toPayload(referenceTable)
-    });
-  }
-}
-
-export default new ReferenceTable();

package/types/transforms/References.js.flow

@@ -1,24 +0,0 @@
-// @flow
-
-import { NestedAttributesTransform } from '@performant-software/shared-components';
-
-/**
- * Class for transforming references nested objects for PUT/POST requests.
- */
-class References extends NestedAttributesTransform {
-  /**
-   * Returns the references payload keys.
-   *
-   * @returns {string[]}
-   */
-  getPayloadKeys(): Array<string> {
-    return [
-      'id',
-      'reference_code_id',
-      '_destroy'
-    ];
-  }
-}
-
-const ReferencesTransform: References = new References();
-export default ReferencesTransform;

package/types/types/Referrable.js.flow

@@ -1,7 +0,0 @@
-// @flow
-
-export type Referrable = {
-  id: number,
-  key: string,
-  reference_code_id: string
-};