feat: Support buffer+filename as input (#5)

* feat: Support buffer+filename as input

* docs: Readme

Author: aarne

README.md

@@ -38,11 +38,15 @@ import { FileUpload } from "genql-upload";
 import fs from "fs";
 
 async function upload() {
-  // client is setup before
+  // read stream is valid file input
+  const file1 = new FileUpload(fs.createReadStream("./README.md"));
+
+  // but file can also be Buffer
+  const file2 = new FileUpload(Buffer.from(/* ... */), "filename.txt");
 
   const response = await client.chain.mutation
     .singleUpload({
-      file: new FileUpload(fs.createReadStream("./README.md")),
+      file: file1, // file2
     })
     .get({
       filename: true,

src/FileUpload.ts

@@ -2,7 +2,13 @@ import { ReactNativeFile } from "extract-files";
 import type { ReadStream } from 'fs';
 
 export class FileUpload extends ReactNativeFile {
-    constructor(private data: ReadStream) {
-        super({ uri: '', name: String(data.path) })
+    constructor(public data: ReadStream | Buffer, filename?: string) {
+        super({ uri: '' })
+
+        if (data instanceof Buffer) {
+            this.name = filename
+        } else {
+            this.name = filename || String(data.path)
+        }
     }
 }

src/createFetcher.ts

@@ -44,7 +44,7 @@ export function createFetcher(opts: GenqlUploadOptions) {
         // 3. all files not (same index as in map)
         let j = 0;
         for (const [file] of files) {
-            formData.append(`${j++}`, file.data)
+            formData.append(`${j++}`, file.data, file.name);
         }
 
         // normal fetch

test/usage.test.ts

@@ -26,7 +26,7 @@ afterAll(async () => {
     }
 })
 
-test('Test using express', async () => {
+test('Test with createReadStream', async () => {
 
     const client = createClient({
         fetcher: createFetcher({
@@ -56,3 +56,36 @@ test('Test using express', async () => {
     // expect this to not throw
     await fsp.unlink('local-file-output.txt')
 })
+
+test('Test with Buffer', async () => {
+
+    const client = createClient({
+        fetcher: createFetcher({
+            url: serverUrl,
+            headers: async () => {
+                return {
+                    'X-Test': 'test'
+                }
+            }
+        })
+    })
+
+    const fileBuffer = fs.readFileSync('./SECURITY.md')
+
+    const f = await client.chain.mutation.singleUpload({
+        file: new FileUpload(fileBuffer, 'SECURITY.md')
+    }).get({
+        filename: true,
+        mimetype: true,
+        headers: true
+    })
+
+    expect(f.filename).toBe('SECURITY.md')
+    expect(f.mimetype).toBe('text/markdown')
+
+    const headers = JSON.parse(f.headers)
+    expect(headers['x-test']).toBe('test')
+
+    // expect this to not throw
+    await fsp.unlink('local-file-output.txt')
+})