refactor(upload): data type is FormData

Upload with a FormData #2

Author: lucaperret

package.json

@@ -64,6 +64,7 @@
     "browser-env": "^3.2.5",
     "codecov": "^3.0.0",
     "cz-conventional-changelog": "^2.1.0",
+    "form-data": "^2.3.2",
     "gh-pages": "^1.0.0",
     "npm-run-all": "^4.1.2",
     "npm-scripts-info": "^0.3.6",

src/lib/sdk.spec.ts

@@ -430,18 +430,38 @@ test('Get file', async t => {
   );
 });
 
-test('Upload file', async t => {
-  await t.context.strapi.upload('foo');
+test('Upload file on Node.js', async t => {
+  const FormData = require('form-data');
+  const form = new FormData();
+  form.append('files', 'foo', 'file-name.ext');
+  await t.context.strapi.upload(form);
 
   t.true(
     t.context.axiosRequest.calledWithExactly({
-      data: 'foo',
+      data: form,
       method: 'post',
       url: '/upload'
     })
   );
 });
 
+test.serial('Upload file on Browser', async t => {
+  browserEnv(['window']);
+  const globalAny: any = global;
+  const form = new globalAny.window.FormData();
+  form.append('files', new globalAny.window.Blob(['foo'], { type: 'text/plain' }), 'file-name.ext');
+  await t.context.strapi.upload(form);
+
+  t.true(
+    t.context.axiosRequest.calledWithExactly({
+      data: form,
+      method: 'post',
+      url: '/upload'
+    })
+  );
+  delete globalAny.window;
+});
+
 test('Set token', t => {
   t.is(t.context.strapi.axios.defaults.headers.common.Authorization, undefined);
   t.context.strapi.setToken('foo');

src/lib/sdk.ts

@@ -314,11 +314,31 @@ export default class Strapi {
 
   /**
    * Upload files
-   * @param data Files
+   *
+   * ### Browser example
+   * ```js
+   * const form = new FormData();
+   * form.append('files', fileInputElement.files[0], 'file-name.ext');
+   * form.append('files', fileInputElement.files[1], 'file-2-name.ext');
+   * const files = await strapi.upload(form);
+   * ```
+   *
+   * ### Node.js example
+   * ```js
+   * const FormData = require('form-data');
+   * const fs = require('fs');
+   * const form = new FormData();
+   * form.append('files', fs.createReadStream('./file-name.ext'), 'file-name.ext');
+   * const files = await strapi.upload(form, {
+   *   headers: form.getHeaders()
+   * });
+   * ```
+   *
+   * @param data FormData
    * @param requestConfig
    */
   public upload(
-    data: any,
+    data: FormData,
     requestConfig?: AxiosRequestConfig
   ): Promise<object> {
     return this.request('post', '/upload', {