fix: fileToByteString docs

Author: ashuvssut

.changeset/rare-sheep-notice.md

@@ -0,0 +1,5 @@
+---
+'@zerochain/sdk': patch
+---
+
+Export necessary TS types + fileToByteString utility

docs/docs/api/file.mdx

@@ -119,7 +119,8 @@ type BulkUploadOption = {
   remotePath: string
   /** Whether to encrypt the file */
   encrypt: boolean
-  thumbnailBytes: number[]
+  /** Use `fileToByteString` to generate the thumbnail byte string, or assign an empty string if unavailable. */
+  thumbnailBytes: string
   /** Callback function will be invoked with progress updates */
   callback?: (
     totalBytes: number,
@@ -162,7 +163,7 @@ const result = await multiUpload({
       file: new File(['file content'], 'file1.txt'),
       remotePath: '/my-folder/file1.txt',
       encrypt: true,
-      thumbnailBytes: [],
+      thumbnailBytes: "",
       callback: (totalBytes, completedBytes, fileName, blobURL, error) => {
         console.log(`Upload progress for ${fileName}: ${completedBytes}/${totalBytes} bytes`);
         if (error) {

docs/docs/api/introduction.mdx

@@ -1,5 +1,6 @@
 ---
 sidebar_position: 1
+title: "SDK Methods Index"
 ---
 
 # Introduction

docs/docs/api/utility.mdx

@@ -207,3 +207,22 @@ import { isDesiredWasmInitialized } from '@zerochain/sdk'
 
 const isInitialized = isDesiredWasmInitialized(console.log)
 ```
+
+### `fileToByteString`
+Converts a JS `File` object to a byte string.
+
+:::info
+If you want to upload a thumbnail for your file in [`multiUpload`](/docs/api/file#multiupload), you will need to add the `thumbnailBytes` param in the `BulkUploadOption` of that file. To get `thumbnailBytes`, use this method to convert the thumbnail file to a byte string.
+:::
+
+#### Parameters
+
+| Name | Type | Description | Default value |
+|--------|--------|---------------------------------|---------------|
+| `file` | `File` | The JS file object to convert to a byte string. | |
+
+#### Return Type
+
+```ts
+Promise<string>
+```

package/src/sdk/blobber.ts

@@ -217,7 +217,8 @@ type BulkUploadOption = {
   remotePath: string
   /** Whether to encrypt the file */
   encrypt: boolean
-  thumbnailBytes: number[]
+  /** Use `fileToByteString` to generate the thumbnail byte string, or assign an empty string if unavailable. */
+  thumbnailBytes: string
   /** Callback function will be invoked with progress updates */
   callback?: (
     totalBytes: number,