@autonomys/auto-drive 1.0.5 → 1.0.7

package/README.md

@@ -1,8 +1,14 @@
-# auto-drive
+# Autonomys Auto Drive SDK
 
-## auto-drive API Tools
+![Autonomys Banner](https://github.com/autonomys/auto-sdk/blob/main/.github/images/autonomys-banner.webp)
 
-The `auto-drive` package provides a set of tools to interact with the auto-drive API. Below are some key functionalities:
+[![Latest Github release](https://img.shields.io/github/v/tag/autonomys/auto-sdk.svg)](https://github.com/autonomys/auto-sdk/tags)
+[![Build status of the main branch on Linux/OSX](https://img.shields.io/github/actions/workflow/status/autonomys/auto-sdk/build.yaml?branch=main&label=Linux%2FOSX%20build)](https://github.com/autonomys/auto-sdk/actions/workflows/build.yaml)
+[![npm version](https://badge.fury.io/js/@autonomys%2Fauto-drive.svg)](https://badge.fury.io/js/@autonomys/auto-drive)
+
+## Overview
+
+The `auto-drive` package provides a set of tools to interact with the Autonomys Auto-Drive API. Below are some key functionalities:
 
 ### Installation
 
@@ -72,3 +78,19 @@ getRoots(api)
     console.error('Error retrieving root directories:', error)
   })
 ```
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Additional Resources
+
+- **Autonomys Academy**: Learn more at [Autonomys Academy](https://academy.autonomys.xyz).
+
+## Contact
+
+If you have any questions or need support, feel free to reach out:
+
+- **GitHub Issues**: [GitHub Issues Page](https://github.com/autonomys/auto-sdk/issues)
+
+We appreciate your feedback and contributions!

package/dist/api/wrappers.d.ts

@@ -24,6 +24,24 @@ type UploadFileOptions = {
  * @throws {Error} - Throws an error if the upload fails at any stage.
  */
 export declare const uploadFileFromFilepath: (api: AutoDriveApi, filePath: string, { password, compression }: UploadFileOptions, uploadChunkSize?: number) => PromisedObservable<UploadFileStatus>;
+/**
+ * Uploads a file to the server with optional encryption and compression.
+ *
+ * This function reads a file from the provided input, optionally encrypts it
+ * using the specified password, and compresses it using the specified algorithm if requested.
+ * It uploads the file in chunks to the server, creating an upload session and
+ * completing it once all chunks have been successfully uploaded.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {File} file - The file to be uploaded.
+ * @param {UploadFileOptions} options - Options for the upload process.
+ * @param {string} [options.password] - The password for encryption (optional).
+ * @param {boolean} [options.compression=true] - Whether to compress the file (optional).
+ * @param {number} [uploadChunkSize] - The size of each chunk to upload (optional).
+ * @returns {PromisedObservable<UploadFileStatus>} - An observable that emits the upload status.
+ * @throws {Error} - Throws an error if the upload fails at any stage.
+ */
+export declare const uploadFileFromInput: (api: AutoDriveApi, file: File, { password, compression }: UploadFileOptions, uploadChunkSize?: number) => PromisedObservable<UploadFileStatus>;
 /**
  * Uploads a file to the server with optional encryption and compression.
  *
@@ -38,10 +56,10 @@ export declare const uploadFileFromFilepath: (api: AutoDriveApi, filePath: strin
  * @param {string} [options.password] - The password for encryption (optional).
  * @param {boolean} [options.compression=true] - Whether to compress the file (optional).
  * @param {number} [uploadChunkSize] - The size of each chunk to upload (optional).
- * @returns {Promise<CID>} - A promise that resolves with the CID of the uploaded file.
+ * @returns {PromisedObservable<UploadFileStatus>} - An observable that emits the upload status.
  * @throws {Error} - Throws an error if the upload fails at any stage.
  */
-export declare const uploadFileFromInput: (api: AutoDriveApi, file: File | GenericFile, { password, compression }: UploadFileOptions, uploadChunkSize?: number) => PromisedObservable<UploadFileStatus>;
+export declare const uploadFile: (api: AutoDriveApi, file: GenericFile, { password, compression }: UploadFileOptions, uploadChunkSize?: number) => PromisedObservable<UploadFileStatus>;
 /**
  * Uploads an entire folder to the server.
  *

package/dist/api/wrappers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wrappers.d.ts","sourceRoot":"","sources":["../../src/api/wrappers.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAA;AAU3D,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAM9C,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAE9F,KAAK,iBAAiB,GAAG;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB,CAAA;AAuBD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,sBAAsB,QAC5B,YAAY,YACP,MAAM,6BACkB,iBAAiB,oBACjC,MAAM,KACvB,kBAAkB,CAAC,gBAAgB,CAkBrC,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,mBAAmB,QACzB,YAAY,QACX,IAAI,GAAG,WAAW,6BACU,iBAAiB,oBACjC,MAAM,KACvB,kBAAkB,CAAC,gBAAgB,CA8CrC,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,0BAA0B,QAChC,YAAY,cACL,MAAM,kCACa;IAAE,eAAe,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,KAC7E,OAAO,CAAC,kBAAkB,CAAC,gBAAgB,GAAG,kBAAkB,CAAC,CA6DnE,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,qBAAqB,QAC3B,YAAY,YACP,QAAQ,GAAG,IAAI,EAAE,kCACI;IAAE,eAAe,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,KAC7E,OAAO,CAAC,kBAAkB,CAAC,gBAAgB,GAAG,kBAAkB,CAAC,CA+DnE,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,4BAA4B,QAClC,YAAY,YACP,MAAM,QACV,WAAW,oBACC,MAAM,KACvB,kBAAkB,CAAC,kBAAkB,CAkBvC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,QAClB,YAAY,OACZ,MAAM,aACA,MAAM,KAChB,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAoB/B,CAAA"}
+{"version":3,"file":"wrappers.d.ts","sourceRoot":"","sources":["../../src/api/wrappers.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAA;AAU3D,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAM9C,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAE9F,KAAK,iBAAiB,GAAG;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB,CAAA;AAuBD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,sBAAsB,QAC5B,YAAY,YACP,MAAM,6BACkB,iBAAiB,oBACjC,MAAM,KACvB,kBAAkB,CAAC,gBAAgB,CAkBrC,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,mBAAmB,QACzB,YAAY,QACX,IAAI,6BACwB,iBAAiB,oBACjC,MAAM,KACvB,kBAAkB,CAAC,gBAAgB,CA6CrC,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,UAAU,QAChB,YAAY,QACX,WAAW,6BACiB,iBAAiB,oBACjC,MAAM,KACvB,kBAAkB,CAAC,gBAAgB,CA6CrC,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,0BAA0B,QAChC,YAAY,cACL,MAAM,kCACa;IAAE,eAAe,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,KAC7E,OAAO,CAAC,kBAAkB,CAAC,gBAAgB,GAAG,kBAAkB,CAAC,CA6DnE,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,qBAAqB,QAC3B,YAAY,YACP,QAAQ,GAAG,IAAI,EAAE,kCACI;IAAE,eAAe,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,KAC7E,OAAO,CAAC,kBAAkB,CAAC,gBAAgB,GAAG,kBAAkB,CAAC,CA+DnE,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,4BAA4B,QAClC,YAAY,YACP,MAAM,QACV,WAAW,oBACC,MAAM,KACvB,kBAAkB,CAAC,kBAAkB,CAkBvC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,QAClB,YAAY,OACZ,MAAM,aACA,MAAM,KAChB,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAoB/B,CAAA"}

package/dist/api/wrappers.js

@@ -69,7 +69,7 @@ const uploadFileChunks = (api, fileUploadId, asyncIterable, uploadChunkSize = UP
  */
 export const uploadFileFromFilepath = (api, filePath, { password, compression = true }, uploadChunkSize) => {
     const name = filePath.split('/').pop();
-    return uploadFileFromInput(api, {
+    return uploadFile(api, {
         read: () => fs.createReadStream(filePath),
         name,
         mimeType: mime.lookup(name) || undefined,
@@ -89,17 +89,72 @@ export const uploadFileFromFilepath = (api, filePath, { password, compression =
  * completing it once all chunks have been successfully uploaded.
  *
  * @param {AutoDriveApi} api - The API instance used to send requests.
- * @param {File | GenericFile} file - The file to be uploaded, which can be a File or a GenericFile.
+ * @param {File} file - The file to be uploaded.
  * @param {UploadFileOptions} options - Options for the upload process.
  * @param {string} [options.password] - The password for encryption (optional).
  * @param {boolean} [options.compression=true] - Whether to compress the file (optional).
  * @param {number} [uploadChunkSize] - The size of each chunk to upload (optional).
- * @returns {Promise<CID>} - A promise that resolves with the CID of the uploaded file.
+ * @returns {PromisedObservable<UploadFileStatus>} - An observable that emits the upload status.
  * @throws {Error} - Throws an error if the upload fails at any stage.
  */
 export const uploadFileFromInput = (api, file, { password, compression = true }, uploadChunkSize) => {
     return new PromisedObservable((subscriber) => __awaiter(void 0, void 0, void 0, function* () {
-        let asyncIterable = file instanceof File ? fileToIterable(file) : file.read();
+        let asyncIterable = fileToIterable(file);
+        if (compression) {
+            asyncIterable = compressFile(asyncIterable, {
+                level: 9,
+                algorithm: CompressionAlgorithm.ZLIB,
+            });
+        }
+        if (password) {
+            asyncIterable = encryptFile(asyncIterable, password, {
+                algorithm: EncryptionAlgorithm.AES_256_GCM,
+            });
+        }
+        const uploadOptions = {
+            compression: compression
+                ? {
+                    level: 9,
+                    algorithm: CompressionAlgorithm.ZLIB,
+                }
+                : undefined,
+            encryption: password
+                ? {
+                    algorithm: EncryptionAlgorithm.AES_256_GCM,
+                }
+                : undefined,
+        };
+        const fileUpload = yield createFileUpload(api, {
+            mimeType: mime.lookup(file.name) || undefined,
+            filename: file.name,
+            uploadOptions,
+        });
+        yield uploadFileChunks(api, fileUpload.id, asyncIterable, uploadChunkSize).forEach((e) => subscriber.next({ type: 'file', progress: progressToPercentage(e.uploadBytes, file.size) }));
+        const result = yield completeUpload(api, { uploadId: fileUpload.id });
+        subscriber.next({ type: 'file', progress: 100, cid: stringToCid(result.cid) });
+        subscriber.complete();
+    }));
+};
+/**
+ * Uploads a file to the server with optional encryption and compression.
+ *
+ * This function reads a file from the provided input, optionally encrypts it
+ * using the specified password, and compresses it using the specified algorithm if requested.
+ * It uploads the file in chunks to the server, creating an upload session and
+ * completing it once all chunks have been successfully uploaded.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {File | GenericFile} file - The file to be uploaded, which can be a File or a GenericFile.
+ * @param {UploadFileOptions} options - Options for the upload process.
+ * @param {string} [options.password] - The password for encryption (optional).
+ * @param {boolean} [options.compression=true] - Whether to compress the file (optional).
+ * @param {number} [uploadChunkSize] - The size of each chunk to upload (optional).
+ * @returns {PromisedObservable<UploadFileStatus>} - An observable that emits the upload status.
+ * @throws {Error} - Throws an error if the upload fails at any stage.
+ */
+export const uploadFile = (api, file, { password, compression = true }, uploadChunkSize) => {
+    return new PromisedObservable((subscriber) => __awaiter(void 0, void 0, void 0, function* () {
+        let asyncIterable = file.read();
         if (compression) {
             asyncIterable = compressFile(asyncIterable, {
                 level: 9,
@@ -160,9 +215,9 @@ export const uploadFolderFromFolderPath = (api_1, folderPath_1, ...args_1) => __
         const filesMap = Object.fromEntries(files.map((file) => [file, file]));
         const zipBlob = yield constructZipBlobFromTreeAndPaths(fileTree, filesMap);
         const name = folderPath.split('/').pop();
-        return uploadFileFromInput(api, {
+        return uploadFile(api, {
             read: () => fileToIterable(zipBlob),
-            name,
+            name: `${name}.zip`,
             mimeType: 'application/zip',
             size: zipBlob.size,
             path: name,
@@ -227,7 +282,7 @@ export const uploadFolderFromInput = (api_1, fileList_1, ...args_1) => __awaiter
         const filesMap = Object.fromEntries(files.map((file) => [file.webkitRelativePath, file]));
         const zipBlob = yield constructZipBlobFromTreeAndPaths(fileTree, filesMap);
         const name = fileList[0].webkitRelativePath.split('/').filter(Boolean)[0];
-        return uploadFileFromInput(api, {
+        return uploadFile(api, {
             read: () => fileToIterable(zipBlob),
             name: `${name}.zip`,
             mimeType: 'application/zip',

package/package.json

@@ -3,11 +3,14 @@
   "packageManager": "yarn@4.2.2",
   "type": "module",
   "main": "dist/index.js",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "author": {
     "name": "Autonomys",
     "url": "https://autonomys.net"
   },
+  "engines": {
+    "node": ">=20.8.0"
+  },
   "scripts": {
     "build": "tsc"
   },
@@ -16,7 +19,7 @@
     "typescript": "^5.6.3"
   },
   "dependencies": {
-    "@autonomys/auto-dag-data": "^1.0.5",
+    "@autonomys/auto-dag-data": "^1.0.7",
     "jszip": "^3.10.1",
     "mime-types": "^2.1.35",
     "zod": "^3.23.8"

package/src/api/wrappers.ts

@@ -1,5 +1,4 @@
 import {
-  CID,
   compressFile,
   CompressionAlgorithm,
   decompressFile,
@@ -83,7 +82,7 @@ export const uploadFileFromFilepath = (
 ): PromisedObservable<UploadFileStatus> => {
   const name = filePath.split('/').pop()!
 
-  return uploadFileFromInput(
+  return uploadFile(
     api,
     {
       read: () => fs.createReadStream(filePath),
@@ -109,23 +108,91 @@ export const uploadFileFromFilepath = (
  * completing it once all chunks have been successfully uploaded.
  *
  * @param {AutoDriveApi} api - The API instance used to send requests.
- * @param {File | GenericFile} file - The file to be uploaded, which can be a File or a GenericFile.
+ * @param {File} file - The file to be uploaded.
  * @param {UploadFileOptions} options - Options for the upload process.
  * @param {string} [options.password] - The password for encryption (optional).
  * @param {boolean} [options.compression=true] - Whether to compress the file (optional).
  * @param {number} [uploadChunkSize] - The size of each chunk to upload (optional).
- * @returns {Promise<CID>} - A promise that resolves with the CID of the uploaded file.
+ * @returns {PromisedObservable<UploadFileStatus>} - An observable that emits the upload status.
  * @throws {Error} - Throws an error if the upload fails at any stage.
  */
 export const uploadFileFromInput = (
   api: AutoDriveApi,
-  file: File | GenericFile,
+  file: File,
+  { password, compression = true }: UploadFileOptions,
+  uploadChunkSize?: number,
+): PromisedObservable<UploadFileStatus> => {
+  return new PromisedObservable<UploadFileStatus>(async (subscriber) => {
+    let asyncIterable: AsyncIterable<Buffer> = fileToIterable(file)
+
+    if (compression) {
+      asyncIterable = compressFile(asyncIterable, {
+        level: 9,
+        algorithm: CompressionAlgorithm.ZLIB,
+      })
+    }
+
+    if (password) {
+      asyncIterable = encryptFile(asyncIterable, password, {
+        algorithm: EncryptionAlgorithm.AES_256_GCM,
+      })
+    }
+
+    const uploadOptions = {
+      compression: compression
+        ? {
+            level: 9,
+            algorithm: CompressionAlgorithm.ZLIB,
+          }
+        : undefined,
+      encryption: password
+        ? {
+            algorithm: EncryptionAlgorithm.AES_256_GCM,
+          }
+        : undefined,
+    }
+    const fileUpload = await createFileUpload(api, {
+      mimeType: mime.lookup(file.name) || undefined,
+      filename: file.name,
+      uploadOptions,
+    })
+
+    await uploadFileChunks(api, fileUpload.id, asyncIterable, uploadChunkSize).forEach((e) =>
+      subscriber.next({ type: 'file', progress: progressToPercentage(e.uploadBytes, file.size) }),
+    )
+
+    const result = await completeUpload(api, { uploadId: fileUpload.id })
+
+    subscriber.next({ type: 'file', progress: 100, cid: stringToCid(result.cid) })
+    subscriber.complete()
+  })
+}
+
+/**
+ * Uploads a file to the server with optional encryption and compression.
+ *
+ * This function reads a file from the provided input, optionally encrypts it
+ * using the specified password, and compresses it using the specified algorithm if requested.
+ * It uploads the file in chunks to the server, creating an upload session and
+ * completing it once all chunks have been successfully uploaded.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {File | GenericFile} file - The file to be uploaded, which can be a File or a GenericFile.
+ * @param {UploadFileOptions} options - Options for the upload process.
+ * @param {string} [options.password] - The password for encryption (optional).
+ * @param {boolean} [options.compression=true] - Whether to compress the file (optional).
+ * @param {number} [uploadChunkSize] - The size of each chunk to upload (optional).
+ * @returns {PromisedObservable<UploadFileStatus>} - An observable that emits the upload status.
+ * @throws {Error} - Throws an error if the upload fails at any stage.
+ */
+export const uploadFile = (
+  api: AutoDriveApi,
+  file: GenericFile,
   { password, compression = true }: UploadFileOptions,
   uploadChunkSize?: number,
 ): PromisedObservable<UploadFileStatus> => {
   return new PromisedObservable<UploadFileStatus>(async (subscriber) => {
-    let asyncIterable: AsyncIterable<Buffer> =
-      file instanceof File ? fileToIterable(file) : file.read()
+    let asyncIterable: AsyncIterable<Buffer> = file.read()
 
     if (compression) {
       asyncIterable = compressFile(asyncIterable, {
@@ -200,11 +267,11 @@ export const uploadFolderFromFolderPath = async (
     const filesMap = Object.fromEntries(files.map((file) => [file, file]))
     const zipBlob = await constructZipBlobFromTreeAndPaths(fileTree, filesMap)
     const name = folderPath.split('/').pop()!
-    return uploadFileFromInput(
+    return uploadFile(
       api,
       {
         read: () => fileToIterable(zipBlob),
-        name,
+        name: `${name}.zip`,
         mimeType: 'application/zip',
         size: zipBlob.size,
         path: name,
@@ -288,7 +355,7 @@ export const uploadFolderFromInput = async (
     const zipBlob = await constructZipBlobFromTreeAndPaths(fileTree, filesMap)
     const name = fileList[0].webkitRelativePath.split('/').filter(Boolean)[0]!
 
-    return uploadFileFromInput(
+    return uploadFile(
       api,
       {
         read: () => fileToIterable(zipBlob),

package/LICENSE

@@ -1,18 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Autonomys Network (autonomys.xyz)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-1. **Attribution**: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-2. **No Warranty**: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-
-3. **Limitation of Liability**: IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
----