@ardrive/turbo-sdk 1.27.0-alpha.4 → 1.27.0

package/README.md

@@ -567,32 +567,25 @@ const uploadResult = await turbo.upload({
 });
 ```
 
-#### `uploadFile({ fileStreamFactory, fileSizeFactory, signal, dataItemOpts, events })`
+#### `uploadFile({ ...fileOrStreamFactoryOpts, signal, dataItemOpts, events })`
 
-Signs and uploads a raw file. The provided `fileStreamFactory` should produce a NEW file data stream each time it is invoked. The `fileSizeFactory` is a function that returns the size of the file. The `signal` is an optional [AbortSignal] that can be used to cancel the upload or timeout the request. `dataItemOpts` is an optional object that can be used to configure tags, target, and anchor for the data item upload.
+Signs and uploads a raw file. There are two ways to provide the file to the SDK:
+
+1. Using a `file` parameter
+2. Using a `fileStreamFactory` and `fileSizeFactory`
+
+##### Using `file`
+
+In Web with a file input:
 
 ```typescript
-const filePath = path.join(__dirname, './my-unsigned-file.txt');
-const fileSize = fs.stateSync(filePath).size;
+const selectedFile = e.target.files[0];
 const uploadResult = await turbo.uploadFile({
-  fileStreamFactory: () => fs.createReadStream(filePath),
-  fileSizeFactory: () => fileSize,
+  file: selectedFile,
   dataItemOpts: {
-    // optional
-    tags: [
-      {
-        name: 'Content-Type',
-        value: 'text/plain',
-      },
-      {
-        name: 'My-Custom-Tag',
-        value: 'my-custom-value',
-      },
-    ],
-    // no timeout or AbortSignal provided
+    tags: [{ name: 'Content-Type', value: 'text/plain' }],
   },
   events: {
-    // upload events
     onUploadProgress: ({ totalBytes, processedBytes }) => {
       console.log('Upload progress:', { totalBytes, processedBytes });
     },
@@ -602,11 +595,36 @@ const uploadResult = await turbo.uploadFile({
     onUploadSuccess: () => {
       console.log('Upload success!');
     },
-    // add any other events you want to listen to (see `Events` section for more details)
   },
 });
 ```
 
+In NodeJS with a file path:
+
+```typescript
+const filePath = path.join(__dirname, './my-unsigned-file.txt');
+const fileSize = fs.stateSync(filePath).size;
+const uploadResult = await turbo.uploadFile({
+  file: filePath,
+  dataItemOpts: {
+    tags: [{ name: 'Content-Type', value: 'text/plain' }],
+  },
+});
+```
+
+##### Using `fileStreamFactory` and `fileSizeFactory`
+
+Note: The provided `fileStreamFactory` should produce a NEW file data stream each time it is invoked. The `fileSizeFactory` is a function that returns the size of the file. The `signal` is an optional [AbortSignal] that can be used to cancel the upload or timeout the request. `dataItemOpts` is an optional object that can be used to configure tags, target, and anchor for the data item upload.
+
+```typescript
+const filePath = path.join(__dirname, './my-unsigned-file.txt');
+const fileSize = fs.stateSync(filePath).size;
+const uploadResult = await turbo.uploadFile({
+  fileStreamFactory: () => fs.createReadStream(filePath),
+  fileSizeFactory: () => fileSize,
+});
+```
+
 #### `uploadFolder({ folderPath, files, dataItemOpts, signal, maxConcurrentUploads, throwOnFailure, manifestOptions })`
 
 Signs and uploads a folder of files. For NodeJS, the `folderPath` of the folder to upload is required. For the browser, an array of `files` is required. The `dataItemOpts` is an optional object that can be used to configure tags, target, and anchor for the data item upload. The `signal` is an optional [AbortSignal] that can be used to cancel the upload or timeout the request. The `maxConcurrentUploads` is an optional number that can be used to limit the number of concurrent uploads. The `throwOnFailure` is an optional boolean that can be used to throw an error if any upload fails. The `manifestOptions` is an optional object that can be used to configure the manifest file, including a custom index file, fallback file, or whether to disable manifests altogether. Manifests are enabled by default.

package/bundles/web.bundle.min.js

@@ -314072,7 +314072,7 @@ var import_winston = __toESM(require_winston(), 1);
 init_dirname();
 init_buffer2();
 init_process2();
-var version16 = "1.27.0-alpha.3";
+var version16 = "1.27.0-alpha.4";
 
 // src/common/logger.ts
 var TurboWinstonLogger = class _TurboWinstonLogger {

package/lib/cjs/version.js

@@ -17,4 +17,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-exports.version = '1.27.0-alpha.4';
+exports.version = '1.27.0';

package/lib/esm/version.js

@@ -14,4 +14,4 @@
  * limitations under the License.
  */
 // AUTOMATICALLY GENERATED FILE - DO NOT TOUCH
-export const version = '1.27.0-alpha.4';
+export const version = '1.27.0';

package/lib/types/version.d.ts

@@ -13,5 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare const version = "1.27.0-alpha.3";
+export declare const version = "1.27.0-alpha.4";
 //# sourceMappingURL=version.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ardrive/turbo-sdk",
-  "version": "1.27.0-alpha.4",
+  "version": "1.27.0",
   "main": "./lib/cjs/node/index.js",
   "types": "./lib/types/node/index.d.ts",
   "module": "./lib/esm/node/index.js",