@performant-software/shared-components 0.5.2 → 0.5.5

package/src/index.js

@@ -1,12 +1,5 @@
 // @flow
 
-// API
-export { default as Attachments } from './api/Attachments';
-export { default as BaseService } from './api/BaseService';
-export { default as BaseTransform } from './api/BaseTransform';
-export { default as FormDataTransform } from './api/FormDataTransform';
-export { default as NestedAttributesTransform } from './api/NestedAttributesTransform';
-
 // Components
 export { default as useEditContainer } from './components/EditContainer';
 export { default as withGoogleAnalytics } from './components/GoogleAnalytics';
@@ -17,8 +10,19 @@ export { default as Keyboard } from './components/Keyboard';
 // I18n
 export { default as i18n } from './i18n/i18n';
 
+// Services
+export { default as BaseService } from './services/BaseService';
+export { default as ReferenceCodesService } from './services/ReferenceCodes';
+export { default as ReferenceTablesService } from './services/ReferenceTables';
+
+// Transforms
+export { default as Attachments } from './transforms/Attachments';
+export { default as BaseTransform } from './transforms/BaseTransform';
+export { default as FormDataTransform } from './transforms/FormDataTransform';
+export { default as NestedAttributesTransform } from './transforms/NestedAttributesTransform';
+
 // Utils
-export * as Browser from './utils/Browser';
+export { default as Browser } from './utils/Browser';
 export { default as Calendar } from './utils/Calendar';
 export { default as Date } from './utils/Date';
 export { default as useDragDrop } from './utils/DragDrop';
@@ -27,7 +31,6 @@ export { default as Map } from './utils/Map';
 export { default as Object } from './utils/Object';
 export { default as String } from './utils/String';
 export { default as Timer } from './utils/Timer';
-export { default as Utility } from './utils/Utility'; // TODO: Rename me
 
 // Types
 export type { EditContainerProps as EditModalProps } from './components/EditContainer'; // Backwards compatability

package/src/services/BaseService.js

@@ -0,0 +1,141 @@
+// @flow
+
+import axios, { type AxiosResponse, type AxiosStatic } from 'axios';
+
+/**
+ * Base class for making API calls. This class uses Axios under the hood and a customizable transform class for
+ * PUT/POST requests.
+ */
+class BaseService {
+  /**
+   * Allows for static configuration of the axios object.
+   *
+   * @param callback
+   */
+  static configure(callback: (axiosInstance: typeof axios) => void) {
+    callback(axios);
+  }
+
+  /**
+   * Constructs a new BaseService object. This constructor should never be used directly.
+   */
+  constructor() {
+    if (this.constructor === BaseService) {
+      throw new TypeError('Abstract class "BaseService" cannot be instantiated directly.');
+    }
+  }
+
+  /**
+   * Calls the POST /api/<resource>/ endpoint with the passed item.
+   *
+   * @param item
+   *
+   * @returns {Promise<AxiosResponse<T>>}
+   */
+  create(item: any): Promise<AxiosResponse> {
+    const transform = this.getTransform();
+    return axios.post(this.getBaseUrl(), transform.toPayload(item), this.getConfig());
+  }
+
+  /**
+   * Calls the DELETE /api/<resource>/:id endpoint for the passed item.
+   *
+   * @param item
+   *
+   * @returns {Promise<AxiosResponse<T>>}
+   */
+  delete(item: any) {
+    return axios.delete(`${this.getBaseUrl()}/${item.id}`);
+  }
+
+  /**
+   * Calls the GET /api/<resource>/ endpoint.
+   *
+   * @returns {Promise<AxiosResponse<T>>}
+   */
+  fetchAll(params: any) {
+    return axios.get(this.getBaseUrl(), { params });
+  }
+
+  /**
+   * Calls the GET /api/<resource>/:id endpoint.
+   *
+   * @returns {Promise<AxiosResponse<T>>}
+   */
+  fetchOne(id: number) {
+    return axios.get(`${this.getBaseUrl()}/${id}`);
+  }
+
+  /**
+   * Calls the create/update API endpoint for the passed item.
+   *
+   * @param item
+   *
+   * @returns {Promise<AxiosResponse<T>>}
+   */
+  save(item: any) {
+    return item.id ? this.update(item) : this.create(item);
+  }
+
+  /**
+   * Calls the POST /api/<resource>/search endpoint.
+   *
+   * @param params
+   *
+   * @returns {Promise<AxiosResponse<T>>}
+   */
+  search(params: any) {
+    return axios.post(`${this.getBaseUrl()}/search`, params);
+  }
+
+  /**
+   * Calls the PUT /api/<resource>/:id endpoint with the passed item.
+   *
+   * @param item
+   *
+   * @returns {Promise<AxiosResponse<T>>}
+   */
+  update(item: any) {
+    const transform = this.getTransform();
+    return axios.put(`${this.getBaseUrl()}/${item.id}`, transform.toPayload(item), this.getConfig());
+  }
+
+  // protected
+
+  /**
+   * Returns the axios instance.
+   *
+   * @returns {AxiosStatic}
+   */
+  getAxios(): AxiosStatic {
+    return axios;
+  }
+
+  /**
+   * Returns the API base URL string.
+   */
+  getBaseUrl(): string {
+    // Implemented in concrete classes.
+    return '';
+  }
+
+  /**
+   * Returns the config properties for POST/PUT requests.
+   *
+   * @returns {null}
+   */
+  getConfig() {
+    // Implemented in concrete classes
+    return null;
+  }
+
+  /**
+   * Returns the transform object. This class will be used to generate the object sent on POST/PUT requests.
+   */
+  getTransform() {
+    // Implemented in concrete classes.
+    return {};
+  }
+}
+
+export default BaseService;

package/src/services/ReferenceCodes.js

@@ -0,0 +1,28 @@
+// @flow
+
+import BaseService from './BaseService';
+
+/**
+ * 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/src/services/ReferenceTables.js

@@ -0,0 +1,29 @@
+// @flow
+
+import BaseService from './BaseService';
+import ReferenceTable from '../transforms/ReferenceTable';
+
+/**
+ * Class responsible for handling all reference table API requests.
+ */
+class ReferenceTables extends BaseService {
+  /**
+   * 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/src/transforms/ReferenceCodes.js

@@ -0,0 +1,35 @@
+// @flow
+
+import NestedAttributesTransform from './NestedAttributesTransform';
+
+/**
+ * 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/src/transforms/ReferenceTable.js

@@ -0,0 +1,55 @@
+// @flow
+
+import _ from 'underscore';
+import BaseTransform from './BaseTransform';
+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
+   *
+   * @returns {*}
+   */
+  toPayload(referenceTable: ReferenceTableType) {
+    return {
+      reference_table: {
+        ..._.pick(referenceTable, this.getPayloadKeys()),
+        ...ReferenceCodes.toPayload(referenceTable)
+      }
+    };
+  }
+}
+
+export default new ReferenceTable();

package/src/utils/Browser.js

@@ -5,4 +5,8 @@
  *
  * @returns {boolean}
  */
-export const isBrowser = () => (typeof window !== 'undefined');
+const isBrowser = () => (typeof window !== 'undefined');
+
+export default {
+  isBrowser
+};

package/src/utils/Object.js

@@ -31,7 +31,7 @@ const WHITESPACE_REGEX = /\s\s+/g;
  *
  * @returns {boolean|*}
  */
-export const isEmpty = (value: any) => {
+const isEmpty = (value: any) => {
   // If the value is an object or array, use underscore's isEmpty check.
   if (_.isObject(value) || _.isArray(value)) {
     return _.isEmpty(value);
@@ -49,7 +49,7 @@ export const isEmpty = (value: any) => {
  *
  * @returns {boolean}
  */
-export const isEqual = (a: any, b: any, userOptions: OptionsProps = {}) => {
+const isEqual = (a: any, b: any, userOptions: OptionsProps = {}) => {
   const options = _.defaults(userOptions, DEFAULT_OPTIONS);
 
   // Check equality, consider empty strings and "null" values as equal
@@ -109,6 +109,10 @@ export const isEqual = (a: any, b: any, userOptions: OptionsProps = {}) => {
   return false;
 };
 
-export default {
+const isPromise = (value: any) => !!value && typeof value === 'object' && typeof value.then === 'function';
 
+export default {
+  isEmpty,
+  isEqual,
+  isPromise
 };

package/types/api/BaseService.js.flow

@@ -1,6 +1,6 @@
 // @flow
 
-import axios, { type AxiosResponse } from 'axios';
+import axios, { type AxiosResponse, type AxiosStatic } from 'axios';
 
 /**
  * Base class for making API calls. This class uses Axios under the hood and a customizable transform class for
@@ -25,9 +25,7 @@ class BaseService {
    */
   create(item: any): Promise<AxiosResponse> {
     const transform = this.getTransform();
-
-    // $FlowFixMe - Flow doesn't currently support abstract classes
-    return axios.post(this.getBaseUrl(), transform.toPayload(item), this.getConfig());
+    return this.getAxios().post(this.getBaseUrl(), transform.toPayload(item), this.getConfig());
   }
 
   /**
@@ -38,7 +36,7 @@ class BaseService {
    * @returns {Promise<AxiosResponse<T>>}
    */
   delete(item: any) {
-    return axios.delete(`${this.getBaseUrl()}/${item.id}`);
+    return this.getAxios().delete(`${this.getBaseUrl()}/${item.id}`);
   }
 
   /**
@@ -47,7 +45,7 @@ class BaseService {
    * @returns {Promise<AxiosResponse<T>>}
    */
   fetchAll(params: any) {
-    return axios.get(this.getBaseUrl(), { params });
+    return this.getAxios().get(this.getBaseUrl(), { params });
   }
 
   /**
@@ -56,7 +54,7 @@ class BaseService {
    * @returns {Promise<AxiosResponse<T>>}
    */
   fetchOne(id: number) {
-    return axios.get(`${this.getBaseUrl()}/${id}`);
+    return this.getAxios().get(`${this.getBaseUrl()}/${id}`);
   }
 
   /**
@@ -78,7 +76,7 @@ class BaseService {
    * @returns {Promise<AxiosResponse<T>>}
    */
   search(params: any) {
-    return axios.post(`${this.getBaseUrl()}/search`, params);
+    return this.getAxios().post(`${this.getBaseUrl()}/search`, params);
   }
 
   /**
@@ -90,9 +88,7 @@ class BaseService {
    */
   update(item: any) {
     const transform = this.getTransform();
-
-    // $FlowFixMe - Flow doesn't currently support abstract classes
-    return axios.put(`${this.getBaseUrl()}/${item.id}`, transform.toPayload(item), this.getConfig());
+    return this.getAxios().put(`${this.getBaseUrl()}/${item.id}`, transform.toPayload(item), this.getConfig());
   }
 
   // protected
@@ -115,6 +111,16 @@ class BaseService {
     return null;
   }
 
+  /**
+   * Returns the axios instance object to use for API calls.
+   *
+   * @returns {null}
+   */
+  getInstance() {
+    // Implemented in concrete classes
+    return null;
+  }
+
   /**
    * Returns the transform object. This class will be used to generate the object sent on POST/PUT requests.
    */
@@ -122,6 +128,17 @@ class BaseService {
     // Implemented in concrete classes.
     return {};
   }
+
+  // private
+
+  /**
+   * Returns the axios instance to use for API calls.
+   *
+   * @returns {*|AxiosStatic}
+   */
+  getAxios(): AxiosStatic {
+    return this.getInstance() || axios;
+  }
 }
 
 export default BaseService;

package/types/index.js.flow

@@ -1,12 +1,5 @@
 // @flow
 
-// API
-export { default as Attachments } from './api/Attachments';
-export { default as BaseService } from './api/BaseService';
-export { default as BaseTransform } from './api/BaseTransform';
-export { default as FormDataTransform } from './api/FormDataTransform';
-export { default as NestedAttributesTransform } from './api/NestedAttributesTransform';
-
 // Components
 export { default as useEditContainer } from './components/EditContainer';
 export { default as withGoogleAnalytics } from './components/GoogleAnalytics';
@@ -17,6 +10,17 @@ export { default as Keyboard } from './components/Keyboard';
 // I18n
 export { default as i18n } from './i18n/i18n';
 
+// Services
+export { default as BaseService } from './services/BaseService';
+export { default as ReferenceCodesService } from './services/ReferenceCodes';
+export { default as ReferenceTablesService } from './services/ReferenceTables';
+
+// Transforms
+export { default as Attachments } from './transforms/Attachments';
+export { default as BaseTransform } from './transforms/BaseTransform';
+export { default as FormDataTransform } from './transforms/FormDataTransform';
+export { default as NestedAttributesTransform } from './transforms/NestedAttributesTransform';
+
 // Utils
 export * as Browser from './utils/Browser';
 export { default as Calendar } from './utils/Calendar';

package/{src/api/BaseService.js → types/services/BaseService.js.flow}

@@ -7,6 +7,15 @@ import axios, { type AxiosResponse } from 'axios';
  * PUT/POST requests.
  */
 class BaseService {
+  /**
+   * Allows for static configuration of the axios object.
+   *
+   * @param callback
+   */
+  static configure(callback: (axiosInstance: typeof axios) => void) {
+    callback(axios);
+  }
+
   /**
    * Constructs a new BaseService object. This constructor should never be used directly.
    */
@@ -25,8 +34,6 @@ class BaseService {
    */
   create(item: any): Promise<AxiosResponse> {
     const transform = this.getTransform();
-
-    // $FlowFixMe - Flow doesn't currently support abstract classes
     return axios.post(this.getBaseUrl(), transform.toPayload(item), this.getConfig());
   }
 
@@ -90,8 +97,6 @@ class BaseService {
    */
   update(item: any) {
     const transform = this.getTransform();
-
-    // $FlowFixMe - Flow doesn't currently support abstract classes
     return axios.put(`${this.getBaseUrl()}/${item.id}`, transform.toPayload(item), this.getConfig());
   }
 

package/types/services/ReferenceCodes.js.flow

@@ -0,0 +1,28 @@
+// @flow
+
+import BaseService from './BaseService';
+
+/**
+ * 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

@@ -0,0 +1,29 @@
+// @flow
+
+import BaseService from './BaseService';
+import ReferenceTable from '../transforms/ReferenceTable';
+
+/**
+ * Class responsible for handling all reference table API requests.
+ */
+class ReferenceTables extends BaseService {
+  /**
+   * 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/Attachments.js.flow

@@ -0,0 +1,28 @@
+// @flow
+
+/**
+ * Helper class for handling binary data. This class should be used in conjunction with the FormDataTransform.
+ */
+class Attachments {
+  /**
+   * Appends the attachment for the passed record to the passed form data. If the attachment is not present, the
+   * "*_remove" attribute will be appended if the attachment has been removed.
+   *
+   * @param formData
+   * @param prefix
+   * @param record
+   * @param name
+   */
+  toPayload(formData: FormData, prefix: string, record: any, name: string) {
+    const attachment = record[name];
+    const removeAttribute = `${name}_remove`;
+
+    if (attachment) {
+      formData.append(`${prefix}[${name}]`, attachment);
+    } else if (record[removeAttribute]) {
+      formData.append(`${prefix}[${removeAttribute}]`, record[removeAttribute]);
+    }
+  }
+}
+
+export default new Attachments();

package/types/transforms/BaseTransform.js.flow

@@ -0,0 +1,55 @@
+// @flow
+
+import _ from 'underscore';
+
+/**
+ * Class for handling transforming objects for PUT/POST requests. This class transforms records into
+ * plain Javascript objects.
+ */
+class BaseTransform {
+  /**
+   * Constructs a new BaseTransform object. This constructor should never be used directly.
+   */
+  constructor() {
+    if (this.constructor === BaseTransform) {
+      throw new TypeError('Abstract class "BaseTransform" cannot be instantiated directly.');
+    }
+  }
+
+  // protected
+
+  /**
+   * Returns the parameter name.
+   *
+   * @returns {string}
+   */
+  getParameterName(): string {
+    // Implemented in sub-class
+    return '';
+  }
+
+  /**
+   * Returns the array of payload keys.
+   *
+   * @returns {*[]}
+   */
+  getPayloadKeys(): Array<string> {
+    // Implemented in sub-class
+    return [];
+  }
+
+  /**
+   * Returns the object for POST/PUT requests as a plain Javascript object.
+   *
+   * @param item
+   *
+   * @returns any
+   */
+  toPayload(item: any): any {
+    return {
+      [this.getParameterName()]: _.pick(item, this.getPayloadKeys())
+    };
+  }
+}
+
+export default BaseTransform;