feat: uploadFile support for File type

src/index.ts

@@ -20,6 +20,7 @@ import type {
 } from './types'
 import { BeeError } from './utils/error'
 import { prepareWebsocketData } from './utils/data'
+import { fileArrayBuffer, isFile } from './utils/file'
 
 /**
  * The Bee class provides a way of interacting with the Bee APIs based on the provided url
@@ -62,18 +63,27 @@ export class Bee {
   /**
    * Upload single file to a Bee node
    *
-   * @param data    Data to be uploaded
-   * @param name    Name of the uploaded file
+   * @param data    Data or file to be uploaded
+   * @param name    Name of the uploaded file (optional)
    * @param options Aditional options like tag, encryption, pinning, content-type
    *
    * @returns reference is a content hash of the file
    */
-  uploadFile(
-    data: string | Uint8Array | Readable,
+  async uploadFile(
+    data: string | Uint8Array | Readable | File,
     name?: string,
     options?: file.FileUploadOptions,
   ): Promise<Reference> {
-    return file.upload(this.url, data, name, options)
+    if (isFile(data)) {
+      const fileData = await fileArrayBuffer(data)
+      const fileName = name || data.name
+      const contentType = data.type
+      const fileOptions = options !== undefined ? { contentType, ...options } : { contentType }
+
+      return file.upload(this.url, fileData, fileName, fileOptions)
+    } else {
+      return file.upload(this.url, data, name, options)
+    }
   }
 
   /**

src/modules/collection.ts

@@ -7,6 +7,7 @@ import { makeTar } from '../utils/tar'
 import { safeAxios } from '../utils/safeAxios'
 import { extractUploadHeaders, readFileHeaders } from '../utils/headers'
 import { BeeArgumentError } from '../utils/error'
+import { fileArrayBuffer } from '../utils/file'
 
 const dirsEndpoint = '/dirs'
 const bzzEndpoint = '/bzz'
@@ -80,19 +81,6 @@ async function buildCollectionRelative(
   return collection
 }
 
-function fileArrayBuffer(file: File): Promise<ArrayBuffer> {
-  if (file.arrayBuffer) {
-    return file.arrayBuffer()
-  }
-
-  // workaround for Safari where arrayBuffer is not supported on Files
-  return new Promise(resolve => {
-    const fr = new FileReader()
-    fr.onload = () => resolve(fr.result as ArrayBuffer)
-    fr.readAsArrayBuffer(file)
-  })
-}
-
 /*
  * This is a workaround for fixing the type definitions
  * regarding the missing `webkitRelativePath` property which is

src/modules/file.ts

@@ -35,14 +35,14 @@ function extractFileUploadHeaders(options?: FileUploadOptions): FileUploadHeader
  */
 export async function upload(
   url: string,
-  data: string | Uint8Array | Readable,
+  data: string | Uint8Array | Readable | ArrayBuffer,
   name?: string,
   options?: FileUploadOptions,
 ): Promise<string> {
   const response = await safeAxios<{ reference: string }>({
     method: 'post',
     url: url + endpoint,
-    data: await prepareData(data),
+    data: prepareData(data),
     headers: {
       'content-type': 'application/octet-stream',
       ...extractFileUploadHeaders(options),

src/utils/data.ts

@@ -1,9 +1,11 @@
 import type { Readable } from 'stream'
 import type { Data } from 'ws'
 
-export function prepareData(data: string | Uint8Array | Readable): Uint8Array | Readable {
+export function prepareData(data: string | ArrayBuffer | Uint8Array | Readable): Uint8Array | Readable {
   if (typeof data === 'string') {
     return new TextEncoder().encode(data)
+  } else if (data instanceof ArrayBuffer) {
+    return new Uint8Array(data)
   }
 
   return data

src/utils/file.ts

@@ -0,0 +1,40 @@
+/**
+ * Compatibility functions for working with File API objects
+ *
+ * https://developer.mozilla.org/en-US/docs/Web/API/File
+ */
+
+export function isFile(file: unknown): file is File {
+  // browser
+  if (typeof File === 'function') {
+    return file instanceof File
+  }
+
+  // node.js
+  const f = file as File
+
+  return (
+    typeof f === 'object' &&
+    typeof f.name === 'string' &&
+    (typeof f.stream === 'function' || typeof f.arrayBuffer === 'function')
+  )
+}
+
+/**
+ * Compatibility helper for browsers where the `arrayBuffer function is
+ * missing from `File` objects.
+ *
+ * @param file A File object
+ */
+export function fileArrayBuffer(file: File): Promise<ArrayBuffer> {
+  if (file.arrayBuffer) {
+    return file.arrayBuffer()
+  }
+
+  // workaround for Safari where arrayBuffer is not supported on Files
+  return new Promise(resolve => {
+    const fr = new FileReader()
+    fr.onload = () => resolve(fr.result as ArrayBuffer)
+    fr.readAsArrayBuffer(file)
+  })
+}

test/bee-class.spec.ts

@@ -18,6 +18,58 @@ describe('Bee class', () => {
       expect(file.name).toEqual(name)
       expect(file.data).toEqual(content)
     })
+
+    it('should work with file object', async () => {
+      const content = new Uint8Array([1, 2, 3])
+      const name = 'hello.txt'
+      const type = 'text/plain'
+      const file = ({
+        arrayBuffer: () => content,
+        name,
+        type,
+      } as unknown) as File
+
+      const hash = await bee.uploadFile(file)
+      const downloadedFile = await bee.downloadFile(hash)
+
+      expect(downloadedFile.data).toEqual(content)
+      expect(downloadedFile.name).toEqual(name)
+      expect(downloadedFile.contentType).toEqual(type)
+    })
+
+    it('should work with file object and name overridden', async () => {
+      const content = new Uint8Array([1, 2, 3])
+      const name = 'hello.txt'
+      const file = ({
+        arrayBuffer: () => content,
+        name,
+      } as unknown) as File
+      const nameOverride = 'hello-override.txt'
+
+      const hash = await bee.uploadFile(file, nameOverride)
+      const downloadedFile = await bee.downloadFile(hash)
+
+      expect(downloadedFile.data).toEqual(content)
+      expect(downloadedFile.name).toEqual(nameOverride)
+    })
+
+    it('should work with file object and content-type overridden', async () => {
+      const content = new Uint8Array([1, 2, 3])
+      const name = 'hello.txt'
+      const type = 'text/plain'
+      const file = ({
+        arrayBuffer: () => content,
+        name,
+        type,
+      } as unknown) as File
+      const contentTypeOverride = 'text/plain+override'
+
+      const hash = await bee.uploadFile(file, undefined, { contentType: contentTypeOverride })
+      const downloadedFile = await bee.downloadFile(hash)
+
+      expect(downloadedFile.data).toEqual(content)
+      expect(downloadedFile.contentType).toEqual(contentTypeOverride)
+    })
   })
 
   describe('collections', () => {