@kineticdata/react 6.0.0 → 6.0.2

package/lib/apis/http.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.validateOptions = exports.transformCoreResult = exports.submissionPath = exports.paramBuilder = exports.operations = exports.headerBuilder = exports.handleErrors = exports.generateSortParams = exports.generatePaginationParams = exports.generateCESearchParams = exports.formPath = exports.corePath = exports.apiGroup = exports.apiFunction = void 0;
+exports.validateOptions = exports.transformCoreResult = exports.submissionPath = exports.paramBuilder = exports.operations = exports.headerBuilder = exports.handleErrors = exports.generateSortParams = exports.generatePaginationParams = exports.generateCESearchParams = exports.formPath = exports.formDataBuilder = exports.corePath = exports.apiGroup = exports.apiFunction = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/esm/defineProperty"));
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/esm/toConsumableArray"));
 var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/esm/objectSpread2"));
@@ -20,7 +20,7 @@ var types = {
   404: 'notFound',
   405: 'methodNotAllowed'
 };
-var handleErrors = function handleErrors(error) {
+var handleErrors = exports.handleErrors = function handleErrors(error) {
   // handle a javascript runtime exception by re-throwing it, this is in case we
   // make a mistake in a `then` block in one of our api functions.
   if (error instanceof Error && !error.response) {
@@ -67,8 +67,7 @@ var handleErrors = function handleErrors(error) {
     error: result
   };
 };
-exports.handleErrors = handleErrors;
-var paramBuilder = function paramBuilder(options) {
+var paramBuilder = exports.paramBuilder = function paramBuilder(options) {
   var params = {};
   if (options.include) params.include = options.include;
   if (options.limit >= 0) params.limit = options.limit;
@@ -82,16 +81,45 @@ var paramBuilder = function paramBuilder(options) {
   if (options.count) params.count = options.count;
   return params;
 };
-exports.paramBuilder = paramBuilder;
-var headerBuilder = function headerBuilder(options) {
+var headerBuilder = exports.headerBuilder = function headerBuilder(options) {
   var headers = {};
   if (!options["public"]) {
     headers['X-Kinetic-AuthAssumed'] = 'true';
   }
   return headers;
 };
-exports.headerBuilder = headerBuilder;
-var validateOptions = function validateOptions(functionName, requiredOptions, options) {
+var formDataBuilder = exports.formDataBuilder = function formDataBuilder(data, prefix) {
+  var formData = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : new FormData();
+  return Object.keys(data).reduce(function (result, property) {
+    // Reduce the data object into a FormData object
+    if (Array.isArray(data[property])) {
+      // If value of property is an array of non-file objects, recursively add
+      // each object in the array
+      if (data[property].some(function (value) {
+        return typeof value === 'object' && !(value instanceof File);
+      })) {
+        data[property].forEach(function (value, index) {
+          return formDataBuilder(value, prefix ? "".concat(prefix, "[").concat(property, "][").concat(index, "]") : "".concat(property, "[").concat(index, "]"), result);
+        });
+      }
+      // If it's an array of other types, add each value
+      else {
+        data[property].forEach(function (value) {
+          return result.append(prefix ? "".concat(prefix, "[").concat(property, "]") : property, value);
+        });
+      }
+    } else if (typeof data[property] === 'object' && !(data[property] instanceof File)) {
+      // If value of property is an object that's not a file, append the
+      // object's nested properties recursively
+      formDataBuilder(data[property], prefix ? "".concat(prefix, "[").concat(property, "]") : property, result);
+    } else {
+      // Otherwise append the value
+      result.set(prefix ? "".concat(prefix, "[").concat(property, "]") : property, data[property]);
+    }
+    return result;
+  }, formData);
+};
+var validateOptions = exports.validateOptions = function validateOptions(functionName, requiredOptions, options) {
   var missing = requiredOptions.filter(function (requiredOption) {
     return !options[requiredOption];
   });
@@ -99,8 +127,7 @@ var validateOptions = function validateOptions(functionName, requiredOptions, op
     throw new Error("".concat(functionName, " failed! The following required options are missing: ").concat(missing));
   }
 };
-exports.validateOptions = validateOptions;
-var apiFunction = function apiFunction(_ref) {
+var apiFunction = exports.apiFunction = function apiFunction(_ref) {
   var name = _ref.name,
     method = _ref.method,
     dataOption = _ref.dataOption,
@@ -120,8 +147,7 @@ var apiFunction = function apiFunction(_ref) {
     }).then(transform)["catch"](handleErrors);
   };
 };
-exports.apiFunction = apiFunction;
-var apiGroup = function apiGroup(_ref2) {
+var apiGroup = exports.apiGroup = function apiGroup(_ref2) {
   var _ref3;
   var dataOption = _ref2.dataOption,
     name = _ref2.name,
@@ -148,20 +174,17 @@ var apiGroup = function apiGroup(_ref2) {
     method: 'delete'
   }, singular))), _ref3;
 };
-exports.apiGroup = apiGroup;
-var formPath = function formPath(_ref4) {
+var formPath = exports.formPath = function formPath(_ref4) {
   var form = _ref4.form,
     kapp = _ref4.kapp;
   return !kapp ? form ? "".concat(_helpers.bundle.spaceLocation(), "/app/forms/").concat(form) : "".concat(_helpers.bundle.spaceLocation(), "/app/forms") : form ? "".concat(_helpers.bundle.spaceLocation(), "/").concat(kapp || _helpers.bundle.kappSlug(), "/").concat(form) : "".concat(_helpers.bundle.spaceLocation(), "/").concat(kapp || _helpers.bundle.kappSlug());
 };
-exports.formPath = formPath;
-var submissionPath = function submissionPath(_ref5) {
+var submissionPath = exports.submissionPath = function submissionPath(_ref5) {
   var submission = _ref5.submission,
     datastore = _ref5.datastore;
   return datastore ? submission ? "".concat(_helpers.bundle.spaceLocation(), "/app/datastore/submissions/").concat(submission) : "".concat(_helpers.bundle.spaceLocation(), "/app/datastore/submissions") : submission ? "".concat(_helpers.bundle.spaceLocation(), "/submissions/").concat(submission) : "".concat(_helpers.bundle.spaceLocation(), "/submissions");
 };
-exports.submissionPath = submissionPath;
-var corePath = function corePath(_ref6) {
+var corePath = exports.corePath = function corePath(_ref6) {
   var submission = _ref6.submission,
     kapp = _ref6.kapp,
     form = _ref6.form,
@@ -174,8 +197,7 @@ var corePath = function corePath(_ref6) {
     kapp: kapp
   });
 };
-exports.corePath = corePath;
-var operations = (0, _immutable.Map)({
+var operations = exports.operations = (0, _immutable.Map)({
   startsWith: function startsWith(field, value) {
     return "".concat(field, " =* \"").concat(value, "\"");
   },
@@ -203,7 +225,6 @@ var operations = (0, _immutable.Map)({
     return "".concat(field, " BETWEEN (\"").concat(value.get(0), "\", \"").concat(value.get(1), "\")");
   }
 });
-exports.operations = operations;
 var searchFilters = function searchFilters(filters) {
   var q = (0, _immutable.Map)(filters).filter(function (filter) {
     return filter.getIn(['value'], '') !== '';
@@ -216,7 +237,7 @@ var searchFilters = function searchFilters(filters) {
     q: q
   } : {};
 };
-var generateSortParams = function generateSortParams(_ref7) {
+var generateSortParams = exports.generateSortParams = function generateSortParams(_ref7) {
   var sortColumn = _ref7.sortColumn,
     sortDirection = _ref7.sortDirection;
   return sortColumn ? {
@@ -224,8 +245,7 @@ var generateSortParams = function generateSortParams(_ref7) {
     direction: sortDirection
   } : {};
 };
-exports.generateSortParams = generateSortParams;
-var generatePaginationParams = function generatePaginationParams(_ref8) {
+var generatePaginationParams = exports.generatePaginationParams = function generatePaginationParams(_ref8) {
   var pageSize = _ref8.pageSize,
     nextPageToken = _ref8.nextPageToken;
   return pageSize && nextPageToken ? {
@@ -235,14 +255,13 @@ var generatePaginationParams = function generatePaginationParams(_ref8) {
     limit: pageSize
   } : {};
 };
-exports.generatePaginationParams = generatePaginationParams;
 var sortParams = function sortParams(sortColumn, sortDirection) {
   return sortColumn ? {
     orderBy: sortColumn,
     direction: sortDirection
   } : {};
 };
-var generateCESearchParams = function generateCESearchParams(_ref9) {
+var generateCESearchParams = exports.generateCESearchParams = function generateCESearchParams(_ref9) {
   var pageSize = _ref9.pageSize,
     filters = _ref9.filters,
     sortColumn = _ref9.sortColumn,
@@ -253,8 +272,7 @@ var generateCESearchParams = function generateCESearchParams(_ref9) {
     pageToken: nextPageToken
   }, searchFilters(filters)), sortParams(sortColumn, sortDirection));
 };
-exports.generateCESearchParams = generateCESearchParams;
-var transformCoreResult = function transformCoreResult(envelope) {
+var transformCoreResult = exports.transformCoreResult = function transformCoreResult(envelope) {
   return function (result, paramData) {
     var count = paramData.nextPageToken ? result.count + paramData.pageTokens.size * paramData.pageSize : result.count;
     return {
@@ -263,5 +281,4 @@ var transformCoreResult = function transformCoreResult(envelope) {
       count: count
     };
   };
-};
-exports.transformCoreResult = transformCoreResult;
+};

package/lib/apis/http.test.js

@@ -162,4 +162,104 @@ describe('http module', function () {
       expect(op('field', (0, _immutable.List)(['v1', 'v2']))).toEqual('field IN ("v1", "v2")');
     });
   });
+
+  // The `paramBuilder` only strips out unnecessary options.
+  describe('#formDataBuilder', function () {
+    test('simple values only', function () {
+      var data = {
+        name: 'foo'
+      };
+      var formData = (0, _http.formDataBuilder)(data);
+      expect(formData.getAll('name')).toContain('foo');
+    });
+    test('with array values', function () {
+      var data = {
+        name: ['foo', 'bar']
+      };
+      var formData = (0, _http.formDataBuilder)(data);
+      expect(formData.getAll('name')).toContain('foo');
+      expect(formData.getAll('name')).toContain('bar');
+    });
+    test('with array of objects', function () {
+      var data = {
+        array: [{
+          name: 'foo'
+        }, {
+          name: 'bar'
+        }]
+      };
+      var formData = (0, _http.formDataBuilder)(data);
+      expect(formData.getAll('array[0][name]')).toContain('foo');
+      expect(formData.getAll('array[1][name]')).toContain('bar');
+    });
+    test('with File', function () {
+      var data = {
+        file: new File(['test'], 'test')
+      };
+      var formData = (0, _http.formDataBuilder)(data);
+      expect(formData.get('file') instanceof File).toBeTruthy();
+    });
+    test('with multiple Files', function () {
+      var data = {
+        files: [new File(['test'], 'test'), new File(['test2'], 'test2')]
+      };
+      var formData = (0, _http.formDataBuilder)(data);
+      expect(formData.getAll('files')[0] instanceof File).toBeTruthy();
+      expect(formData.getAll('files')[1] instanceof File).toBeTruthy();
+    });
+    test('nested values', function () {
+      var data = {
+        name: 'foo',
+        child: {
+          name: 'bar'
+        }
+      };
+      var formData = (0, _http.formDataBuilder)(data);
+      expect(formData.getAll('name')).toContain('foo');
+      expect(formData.get('child')).toBeNull();
+      expect(formData.getAll('child[name]')).toContain('bar');
+    });
+    test('nested values with array', function () {
+      var data = {
+        child: {
+          name: ['bar', 'baz']
+        }
+      };
+      var formData = (0, _http.formDataBuilder)(data);
+      expect(formData.getAll('child[name]')).toContain('bar');
+      expect(formData.getAll('child[name]')).toContain('baz');
+    });
+    test('nested values with File', function () {
+      var data = {
+        child: {
+          file: new File(['test'], 'test')
+        }
+      };
+      var formData = (0, _http.formDataBuilder)(data);
+      expect(formData.get('child[file]') instanceof File).toBeTruthy();
+    });
+    test('deeply nested data', function () {
+      var data = {
+        name: 'foo',
+        child: {
+          array: ['bar', 'baz'],
+          sub: {
+            file: new File(['test'], 'test'),
+            last: {
+              slug: 'foobar'
+            }
+          }
+        }
+      };
+      var formData = (0, _http.formDataBuilder)(data);
+      expect(formData.getAll('name')).toContain('foo');
+      expect(formData.get('child')).toBeNull();
+      expect(formData.getAll('child[array]')).toContain('bar');
+      expect(formData.getAll('child[array]')).toContain('baz');
+      expect(formData.get('child[sub]')).toBeNull();
+      expect(formData.get('child[sub][file]') instanceof File).toBeTruthy();
+      expect(formData.get('child[sub][last]')).toBeNull();
+      expect(formData.getAll('child[sub][last][slug]')).toContain('foobar');
+    });
+  });
 });