@performant-software/shared-components 0.5.2 → 0.5.5

package/types/transforms/FormDataTransform.js.flow

@@ -0,0 +1,30 @@
+// @flow
+
+import _ from 'underscore';
+import BaseTransform from './BaseTransform';
+import StringUtils from '../utils/String';
+
+/**
+ * Class for handling transforming records for PUT/POST requests. This class transforms objects in FormData. This
+ * class is useful if your model contains binary data to be uploaded.
+ */
+class FormDataTransform extends BaseTransform {
+  /**
+   * Converts the passed records to a formData object to be sent on PUT/POST requests.
+   *
+   * @param record
+   *
+   * @returns {FormData}
+   */
+  toPayload(record: any) {
+    const formData = new FormData();
+
+    _.each(this.getPayloadKeys(), (key) => {
+      formData.append(`${this.getParameterName()}[${key}]`, StringUtils.toString(record[key]));
+    });
+
+    return formData;
+  }
+}
+
+export default FormDataTransform;

package/types/transforms/NestedAttributesTransform.js.flow

@@ -0,0 +1,63 @@
+// @flow
+
+import _ from 'underscore';
+import StringUtils from '../utils/String';
+
+/**
+ * Class for handling transforming nested attributes of a parent object. This class will handle transforming the
+ * object into a payload to be sent to a POST/PUT request on an API. This class currently supports transforming into
+ * a plain Javascript object or a FormData object.
+ */
+class NestedAttributesTransform {
+  /**
+   * Constructs a new BaseTransform object. This constructor should never be used directly.
+   */
+  constructor() {
+    if (this.constructor === NestedAttributesTransform) {
+      throw new TypeError('Abstract class "NestedAttributesTransform" cannot be instantiated directly.');
+    }
+  }
+
+  /**
+   * Returns the array of payload keys.
+   *
+   * @returns {*[]}
+   */
+  getPayloadKeys() {
+    // Implemented in sub-class.
+    return [];
+  }
+
+  /**
+   * Appends the passed record's collection to the form data.
+   *
+   * @param formData
+   * @param prefix
+   * @param record
+   * @param collection
+   */
+  toFormData(formData: FormData, prefix: string, record: any, collection: string) {
+    _.each(record[collection], (item, index) => {
+      _.each(this.getPayloadKeys(), (key) => {
+        formData.append(`${prefix}[${collection}][${index}][${key}]`, StringUtils.toString(item[key]));
+      });
+    });
+  }
+
+  /**
+   * Transforms the passed record's collection to a payload object.
+   *
+   * @param record
+   * @param collection
+   *
+   * @returns {{[p: string]: *}}
+   */
+  toPayload(record: any, collection: string) {
+    return {
+      [collection]: _.map(record[collection],
+        (item, index) => ({ ..._.pick(item, this.getPayloadKeys()), order: index }))
+    };
+  }
+}
+
+export default NestedAttributesTransform;

package/types/transforms/ReferenceCodes.js.flow

@@ -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/types/transforms/ReferenceTable.js.flow

@@ -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/Utility.js

@@ -1,14 +0,0 @@
-// @flow
-
-/**
- * Returns true if passed value is a promise (i.e, has a .then method)
- *
- * @param *
- *
- * @returns {boolean}
- */
-const isPromise = (value: any) => !!value && typeof value === 'object' && typeof value.then === 'function';
-
-export default {
-  isPromise
-};