envoc-form 2.0.1-1 → 2.0.1-13

package/src/utils/objectToFormData.js

@@ -0,0 +1,89 @@
+// Original: https://github.com/therealparmesh/object-to-formdata/blob/master/src/index.js
+// With Multiple Form File Fix: https://github.com/therealparmesh/object-to-formdata/pull/94/files
+import {
+  isUndefined,
+  isNull,
+  isBoolean,
+  isObject,
+  isArray,
+  isDate,
+  isBlob,
+  isFile,
+} from './typeChecks';
+
+const serialize = (obj, cfg, fd, pre) => {
+  cfg = cfg || {};
+
+  cfg.indices = isUndefined(cfg.indices) ? false : cfg.indices;
+
+  cfg.nullsAsUndefineds = isUndefined(cfg.nullsAsUndefineds)
+    ? false
+    : cfg.nullsAsUndefineds;
+
+  cfg.booleansAsIntegers = isUndefined(cfg.booleansAsIntegers)
+    ? false
+    : cfg.booleansAsIntegers;
+
+  cfg.allowEmptyArrays = isUndefined(cfg.allowEmptyArrays)
+    ? false
+    : cfg.allowEmptyArrays;
+
+  //reverse of normal because we want a different default
+  cfg.dotNotation = isUndefined(cfg.dotNotation) ? true : cfg.dotNotation;
+
+  fd = fd || new FormData();
+
+  if (isUndefined(obj)) {
+    return fd;
+  } else if (isNull(obj)) {
+    if (!cfg.nullsAsUndefineds) {
+      fd.append(pre, '');
+    }
+  } else if (isBoolean(obj)) {
+    if (cfg.booleansAsIntegers) {
+      fd.append(pre, obj ? 1 : 0);
+    } else {
+      fd.append(pre, obj);
+    }
+  } else if (isArray(obj)) {
+    if (obj.length) {
+      obj.forEach((value, index) => {
+        let key;
+        if (cfg.noFileListBrackets && isFile(value)) {
+          key = pre;
+        } else {
+          key = pre + '[' + (cfg.indices ? index : '') + ']';
+        }
+        serialize(value, cfg, fd, key);
+      });
+    } else if (cfg.allowEmptyArrays) {
+      fd.append(pre + '[]', '');
+    }
+  } else if (isDate(obj)) {
+    fd.append(pre, obj.toISOString());
+  } else if (isObject(obj) && !isFile(obj) && !isBlob(obj)) {
+    Object.keys(obj).forEach((prop) => {
+      const value = obj[prop];
+
+      if (isArray(value)) {
+        while (prop.length > 2 && prop.lastIndexOf('[]') === prop.length - 2) {
+          prop = prop.substring(0, prop.length - 2);
+        }
+      }
+
+      const key = pre
+        ? cfg.dotNotation
+          ? pre + '.' + prop
+          : pre + '[' + prop + ']'
+        : prop;
+
+      serialize(value, cfg, fd, key);
+    });
+  } else {
+    fd.append(pre, obj);
+  }
+
+  return fd;
+};
+
+export default serialize;

package/src/utils/objectToFormData.test.js

@@ -0,0 +1,76 @@
+import serialize from './objectToFormData';
+
+const options = {
+  indices: true,
+  dotNotation: true,
+  allowEmptyArrays: true,
+  noFileListBrackets: true,
+};
+
+const formDataAppend = global.FormData.prototype.append;
+
+beforeEach(() => {
+  global.FormData.prototype.append = jest.fn(formDataAppend);
+});
+
+describe('Object To Form Data', () => {
+  it('properly serializes a simple object', () => {
+    const object = {
+      name: 'Bob',
+      age: 20,
+    };
+
+    const result = serialize(object, options);
+    expect(result.get('name')).toBe(object.name);
+    expect(result.get('age')).toBe('20');
+  });
+
+  it('properly serializes an object with a non-file array property', () => {
+    const object = {
+      name: 'Bob',
+      age: 20,
+      favoriteFoods: ['Hamburger', 'Pizza'],
+    };
+
+    const result = serialize(object, options);
+    expect(result.get('name')).toBe(object.name);
+    expect(result.has('favoriteFoods[0]')).toBe(true);
+    expect(result.get('favoriteFoods[0]')).toBe('Hamburger');
+    expect(result.has('favoriteFoods[1]')).toBe(true);
+    expect(result.get('favoriteFoods[1]')).toBe('Pizza');
+  });
+
+  it('properly serializes a file in a form', () => {
+    const object = {
+      a: new File(['foo'], 'foo.txt', {
+        type: 'text/plain',
+      }),
+    };
+
+    const result = serialize(object, options);
+    expect(result.has('a')).toBe(true);
+    expect(result.get('a')).toBeInstanceOf(File);
+  });
+
+  it('properly serializes an object with a file array property', () => {
+    const foo = new File(['foo'], 'foo.txt', {
+      type: 'text/plain',
+    });
+    const bar = new File(['bar'], 'bar.txt', {
+      type: 'text/plain',
+    });
+    const object = {
+      fileArray: [foo, bar],
+    };
+
+    const result = serialize(object, options);
+    expect(result.append).toHaveBeenCalledTimes(2);
+    expect(result.append).toHaveBeenNthCalledWith(1, 'fileArray', foo);
+    expect(result.append).toHaveBeenNthCalledWith(2, 'fileArray', bar);
+    expect(result.has('fileArray[]')).toBe(false);
+    expect(result.has('fileArray[0]')).toBe(false);
+    expect(result.has('fileArray[1]')).toBe(false);
+    expect(result.has('fileArray')).toBe(true);
+    expect(result.getAll('fileArray')).toEqual(object.fileArray);
+  });
+});

package/src/utils/typeChecks.js

@@ -0,0 +1,18 @@
+export const isUndefined = (value) => value === undefined;
+export const isNull = (value) => value === null;
+export const isBoolean = (value) => typeof value === 'boolean';
+export const isObject = (value) => value === Object(value);
+export const isArray = (value) => Array.isArray(value);
+export const isDate = (value) => value instanceof Date;
+
+export const isBlob = (value) =>
+  value &&
+  typeof value.size === 'number' &&
+  typeof value.type === 'string' &&
+  typeof value.slice === 'function';
+
+export const isFile = (value) =>
+  isBlob(value) &&
+  typeof value.name === 'string' &&
+  (typeof value.lastModifiedDate === 'object' ||
+    typeof value.lastModified === 'number');

package/src/validators/index.js

@@ -1,2 +1,2 @@
-import * as validators from './validators';
-export default validators;
+import * as validators from './validators';
+export default validators;

package/src/validators/validators.js

@@ -1,93 +1,93 @@
-export const required = (value) =>
-  value || value === false || value === 0 ? undefined : 'Required';
-
-//asserts that the value is a certain number of characters. numbers are coerced to a string
-export const length = (len) => (value) => {
-  let val = value;
-  const type = typeof val;
-  switch (type) {
-    case 'undefined':
-      return undefined;
-    case 'string':
-      break;
-    case 'number':
-      val = val.toString();
-      break;
-    default:
-      console.error(`Invalid value type: ${type} passed to length validator`);
-  }
-  return val.length === len ? undefined : `Length must be ${len}`;
-};
-
-export const integer = (val) => {
-  if (!Number.isInteger(parseFloat(val))) {
-    return 'Must be a whole number';
-  }
-};
-
-export const maxLength = function maxLength(length) {
-  return (value) => {
-    if (value) {
-      return value.length <= length
-        ? undefined
-        : `Maximum length ${length} exceeded`;
-    } else {
-      return undefined;
-    }
-  };
-};
-
-export function maxCount(count) {
-  return (value) => {
-    return !value || value.filter((x) => !x.isDeleted).length <= count
-      ? undefined
-      : `Should not have more than ${count}`;
-  };
-}
-
-export function minCount(count) {
-  return (value) => {
-    return value && value.filter((x) => !x.isDeleted).length >= count
-      ? undefined
-      : `Should have at least ${count}`;
-  };
-}
-
-export const maxValue = function maxValue(value) {
-  return (inputValue) => {
-    if (inputValue && value) {
-      return inputValue <= value
-        ? undefined
-        : `Maximum value ${value} exceeded`;
-    } else {
-      return undefined;
-    }
-  };
-};
-
-export const minValue = function minValue(value) {
-  return (inputValue) => {
-    if (inputValue && value) {
-      return inputValue >= value ? undefined : `Minimum value ${value} not met`;
-    } else {
-      return undefined;
-    }
-  };
-};
-
-export const zipCode = (value) => {
-  return value && !/^[0-9]{5}(?:-[0-9]{4})?$/.test(value)
-    ? 'Invalid ZIP Code'
-    : undefined;
-};
-
-//one of the validators provided must be true
-export const any = (...validatorList) => (value) => {
-  if (validatorList.length === 0 || !value) {
-    return;
-  }
-  return validatorList.reduce(
-    (isAnyTrue, any) => (isAnyTrue ? isAnyTrue : any(value)),
-    false
-  );
-};
+export const required = (value) =>
+  value || value === false || value === 0 ? undefined : 'Required';
+
+//asserts that the value is a certain number of characters. numbers are coerced to a string
+export const length = (len) => (value) => {
+  let val = value;
+  const type = typeof val;
+  switch (type) {
+    case 'undefined':
+      return undefined;
+    case 'string':
+      break;
+    case 'number':
+      val = val.toString();
+      break;
+    default:
+      console.error(`Invalid value type: ${type} passed to length validator`);
+  }
+  return val.length === len ? undefined : `Length must be ${len}`;
+};
+
+export const integer = (val) => {
+  if (!Number.isInteger(parseFloat(val))) {
+    return 'Must be a whole number';
+  }
+};
+
+export const maxLength = function maxLength(length) {
+  return (value) => {
+    if (value) {
+      return value.length <= length
+        ? undefined
+        : `Maximum length ${length} exceeded`;
+    } else {
+      return undefined;
+    }
+  };
+};
+
+export function maxCount(count) {
+  return (value) => {
+    return !value || value.filter((x) => !x.isDeleted).length <= count
+      ? undefined
+      : `Should not have more than ${count}`;
+  };
+}
+
+export function minCount(count) {
+  return (value) => {
+    return value && value.filter((x) => !x.isDeleted).length >= count
+      ? undefined
+      : `Should have at least ${count}`;
+  };
+}
+
+export const maxValue = function maxValue(value) {
+  return (inputValue) => {
+    if (inputValue && value) {
+      return inputValue <= value
+        ? undefined
+        : `Maximum value ${value} exceeded`;
+    } else {
+      return undefined;
+    }
+  };
+};
+
+export const minValue = function minValue(value) {
+  return (inputValue) => {
+    if (inputValue && value) {
+      return inputValue >= value ? undefined : `Minimum value ${value} not met`;
+    } else {
+      return undefined;
+    }
+  };
+};
+
+export const zipCode = (value) => {
+  return value && !/^[0-9]{5}(?:-[0-9]{4})?$/.test(value)
+    ? 'Invalid ZIP Code'
+    : undefined;
+};
+
+//one of the validators provided must be true
+export const any = (...validatorList) => (value) => {
+  if (validatorList.length === 0 || !value) {
+    return;
+  }
+  return validatorList.reduce(
+    (isAnyTrue, any) => (isAnyTrue ? isAnyTrue : any(value)),
+    false
+  );
+};

package/src/validators/validators.test.js

@@ -1,79 +1,79 @@
-import { integer, length, maxLength, maxValue, minValue } from './validators';
-
-describe('integer validator', () => {
-  it('accepts an integer', () => {
-    const returned = integer(123);
-    expect(returned).toBe(undefined);
-  });
-
-  it("doesn't accept a float", () => {
-    const returned = integer(123.5569);
-    expect(returned).toBe('Must be a whole number');
-  });
-});
-
-describe('length validator', () => {
-  it('fails for invalid Length', () => {
-    const length10 = length(10);
-    const tooLong = length10('01234567890');
-    const tooShort = length10('aaa');
-    expect(tooLong).toBe('Length must be 10');
-    expect(tooShort).toBe('Length must be 10');
-  });
-
-  it('succeeds for correct length', () => {
-    const length10 = length(10);
-    const validString = length10('0123456789');
-    const validNumber = length10(1234567890);
-    expect(validString).toBe(undefined);
-    expect(validNumber).toBe(undefined);
-  });
-});
-
-describe('maxValue validator', () => {
-  it('fails for invalid value', () => {
-    const maxValue10 = maxValue(10);
-    const tooBig = maxValue10(11);
-    expect(tooBig).toBe('Maximum value 10 exceeded');
-  });
-
-  it('succeeds for valid value', () => {
-    const maxValue10 = maxValue(10);
-    const maxAllowable = maxValue10(10);
-    const lowAllowable = maxValue10(1);
-    expect(maxAllowable).toBe(undefined);
-    expect(lowAllowable).toBe(undefined);
-  });
-});
-
-describe('minValue validator', () => {
-  it('fails for invalid value', () => {
-    const minValue10 = minValue(10);
-    const tooSmall = minValue10(9);
-    expect(tooSmall).toBe('Minimum value 10 not met');
-  });
-
-  it('succeeds for valid value', () => {
-    const minValue10 = minValue(10);
-    const minAllowable = minValue10(10);
-    const highAllowable = minValue10(15);
-    expect(minAllowable).toBe(undefined);
-    expect(highAllowable).toBe(undefined);
-  });
-});
-
-describe('maxLength validator', () => {
-  it('fails for invalid value', () => {
-    const maxLength10 = maxLength(10);
-    const tooLong = maxLength10('012345678910');
-    expect(tooLong).toBe('Maximum length 10 exceeded');
-  });
-
-  it('succeeds for valid value', () => {
-    const maxLength10 = maxLength(10);
-    const exactMatch = maxLength10('0123456789');
-    const shortValid = maxLength10('0123');
-    expect(exactMatch).toBe(undefined);
-    expect(shortValid).toBe(undefined);
-  });
-});
+import { integer, length, maxLength, maxValue, minValue } from './validators';
+
+describe('integer validator', () => {
+  it('accepts an integer', () => {
+    const returned = integer(123);
+    expect(returned).toBe(undefined);
+  });
+
+  it("doesn't accept a float", () => {
+    const returned = integer(123.5569);
+    expect(returned).toBe('Must be a whole number');
+  });
+});
+
+describe('length validator', () => {
+  it('fails for invalid Length', () => {
+    const length10 = length(10);
+    const tooLong = length10('01234567890');
+    const tooShort = length10('aaa');
+    expect(tooLong).toBe('Length must be 10');
+    expect(tooShort).toBe('Length must be 10');
+  });
+
+  it('succeeds for correct length', () => {
+    const length10 = length(10);
+    const validString = length10('0123456789');
+    const validNumber = length10(1234567890);
+    expect(validString).toBe(undefined);
+    expect(validNumber).toBe(undefined);
+  });
+});
+
+describe('maxValue validator', () => {
+  it('fails for invalid value', () => {
+    const maxValue10 = maxValue(10);
+    const tooBig = maxValue10(11);
+    expect(tooBig).toBe('Maximum value 10 exceeded');
+  });
+
+  it('succeeds for valid value', () => {
+    const maxValue10 = maxValue(10);
+    const maxAllowable = maxValue10(10);
+    const lowAllowable = maxValue10(1);
+    expect(maxAllowable).toBe(undefined);
+    expect(lowAllowable).toBe(undefined);
+  });
+});
+
+describe('minValue validator', () => {
+  it('fails for invalid value', () => {
+    const minValue10 = minValue(10);
+    const tooSmall = minValue10(9);
+    expect(tooSmall).toBe('Minimum value 10 not met');
+  });
+
+  it('succeeds for valid value', () => {
+    const minValue10 = minValue(10);
+    const minAllowable = minValue10(10);
+    const highAllowable = minValue10(15);
+    expect(minAllowable).toBe(undefined);
+    expect(highAllowable).toBe(undefined);
+  });
+});
+
+describe('maxLength validator', () => {
+  it('fails for invalid value', () => {
+    const maxLength10 = maxLength(10);
+    const tooLong = maxLength10('012345678910');
+    expect(tooLong).toBe('Maximum length 10 exceeded');
+  });
+
+  it('succeeds for valid value', () => {
+    const maxLength10 = maxLength(10);
+    const exactMatch = maxLength10('0123456789');
+    const shortValid = maxLength10('0123');
+    expect(exactMatch).toBe(undefined);
+    expect(shortValid).toBe(undefined);
+  });
+});

package/CHANGELOG.json

@@ -1,95 +0,0 @@
-{
-  "name": "envoc-form",
-  "entries": [
-    {
-      "version": "2.0.0",
-      "tag": "envoc-form_v2.0.0",
-      "date": "Fri, 11 Sep 2020 16:49:17 GMT",
-      "comments": {}
-    },
-    {
-      "version": "1.3.1",
-      "tag": "envoc-form_v1.3.1",
-      "date": "Fri, 04 Sep 2020 19:35:20 GMT",
-      "comments": {}
-    },
-    {
-      "version": "1.3.0",
-      "tag": "envoc-form_v1.3.0",
-      "date": "Tue, 01 Sep 2020 16:02:23 GMT",
-      "comments": {}
-    },
-    {
-      "version": "1.2.0",
-      "tag": "envoc-form_v1.2.0",
-      "date": "Mon, 31 Aug 2020 20:33:06 GMT",
-      "comments": {
-        "none": [
-          {
-            "comment": "readme change"
-          },
-          {
-            "comment": "Resolves issues with scss not being included, provides support for tree-shaking, adds jest testing"
-          },
-          {
-            "comment": " Prerelease"
-          },
-          {
-            "comment": "Fixes missing destructed prop on ConfirmBaseForm and adds some tests"
-          },
-          {
-            "comment": "build script changes"
-          },
-          {
-            "comment": "Fix issues with validators export"
-          },
-          {
-            "comment": "fixes normalizers"
-          }
-        ]
-      }
-    },
-    {
-      "version": "1.1.26",
-      "tag": "envoc-form_v1.1.26",
-      "date": "Mon, 13 Jul 2020 16:17:47 GMT",
-      "comments": {}
-    },
-    {
-      "version": "1.1.25",
-      "tag": "envoc-form_v1.1.25",
-      "date": "Fri, 10 Jul 2020 19:16:12 GMT",
-      "comments": {
-        "none": [
-          {
-            "comment": "Changing the 'sideEffects' to be false for better tree shaking"
-          }
-        ]
-      }
-    },
-    {
-      "version": "1.1.24",
-      "tag": "envoc-form_v1.1.24",
-      "date": "Fri, 10 Jul 2020 18:58:53 GMT",
-      "comments": {
-        "none": [
-          {
-            "comment": "Resolves issues with scss not being included, provides support for tree-shaking, adds jest testing"
-          }
-        ]
-      }
-    },
-    {
-      "version": "1.1.23",
-      "tag": "envoc-form_v1.1.23",
-      "date": "Thu, 25 Jun 2020 19:05:11 GMT",
-      "comments": {
-        "none": [
-          {
-            "comment": "Initial envoc-form implementation"
-          }
-        ]
-      }
-    }
-  ]
-}

package/CHANGELOG.md

@@ -1,58 +0,0 @@
-# Change Log - envoc-form
-
-This log was last generated on Fri, 11 Sep 2020 16:49:17 GMT and should not be manually modified.
-
-## 2.0.0
-Fri, 11 Sep 2020 16:49:17 GMT
-
-*Version update only*
-
-## 1.3.1
-Fri, 04 Sep 2020 19:35:20 GMT
-
-*Version update only*
-
-## 1.3.0
-Tue, 01 Sep 2020 16:02:23 GMT
-
-*Version update only*
-
-## 1.2.0
-Mon, 31 Aug 2020 20:33:06 GMT
-
-### Updates
-
-- readme change
-- Resolves issues with scss not being included, provides support for tree-shaking, adds jest testing
--  Prerelease
-- Fixes missing destructed prop on ConfirmBaseForm and adds some tests
-- build script changes
-- Fix issues with validators export
-- fixes normalizers
-
-## 1.1.26
-Mon, 13 Jul 2020 16:17:47 GMT
-
-*Version update only*
-
-## 1.1.25
-Fri, 10 Jul 2020 19:16:12 GMT
-
-### Updates
-
-- Changing the 'sideEffects' to be false for better tree shaking
-
-## 1.1.24
-Fri, 10 Jul 2020 18:58:53 GMT
-
-### Updates
-
-- Resolves issues with scss not being included, provides support for tree-shaking, adds jest testing
-
-## 1.1.23
-Thu, 25 Jun 2020 19:05:11 GMT
-
-### Updates
-
-- Initial envoc-form implementation
-