@autonomys/auto-drive 1.1.4 → 1.2.1

package/README.md

@@ -25,43 +25,40 @@ yarn add @autonomys/auto-drive
 Here is an example of how to use the `uploadFileFromFilepath` method to upload a file with optional encryption and compression:
 
 ```typescript
-import { uploadFileFromFilepath } from '@autonomys/auto-drive'
+import { uploadFileFromFilepath,createAutoDriveApi } from '@autonomys/auto-drive'
 
 const api = createAutoDriveApi({ apiKey: 'your-api-key' }) // Initialize your API instance with API key
 const filePath = 'path/to/your/file.txt' // Specify the path to your file
 const options = {
   password: 'your-encryption-password', // Optional: specify a password for encryption
   compression: true,
+  // an optional callback useful for large file uploads
+  onProgress?: (progress: number) => {
+    console.log(`The upload is completed is ${progress}% completed`)
+  }
 }
 
-const uploadObservable = uploadFileFromFilepath(api, filePath, options)
-  .then(() => {
-    console.log('File uploaded successfully!')
-  })
-  .catch((error) => {
-    console.error('Error uploading file:', error)
-  })
+const cid = await uploadFileFromFilepath(api, filePath, options)
+
+console.log(`The file is uploaded and its cid is ${cid}`)
 ```
 
 ### How to upload [File](https://developer.mozilla.org/en-US/docs/Web/API/File) interface
 
 ```typescript
-import { uploadFileFromFilepath } from '@autonomys/auto-drive'
+import { uploadFileFromInput, createAutoDriveApi } from '@autonomys/auto-drive'
 
 const api = createAutoDriveApi({ apiKey: 'your-api-key' }) // Initialize your API instance with API key
-const filePath = 'path/to/your/file.txt' // Specify the path to your file
+
+// e.g Get File from object from HTML event
+const file: File = e.target.value // Substitute with your file
 const options = {
   password: 'your-encryption-password', // Optional: specify a password for encryption
   compression: true,
 }
+const cid = await uploadFileFromInput(api, file, options)
 
-const uploadObservable = uploadFile(api, filePath, options)
-  .then(() => {
-    console.log('File uploaded successfully!')
-  })
-  .catch((error) => {
-    console.error('Error uploading file:', error)
-  })
+console.log(`The file is uploaded and its cid is ${cid}`)
 ```
 
 ### How to upload a file from a custom interface?
@@ -83,7 +80,7 @@ For more info about asynn generator visit [this website](https://developer.mozil
 You could upload any file that could be represented in that way. For example, uploading a file as a `Buffer`
 
 ```typescript
-import { uploadFile } from '@autonomys/auto-drive'
+import { createAutoDriveApi, uploadFile } from '@autonomys/auto-drive'
 
 const api = createAutoDriveApi({ apiKey: 'your-api-key' }) // Initialize your API instance with API key
 const buffer = Buffer.from(...);
@@ -100,21 +97,21 @@ const genericFile = {
 const options = {
   password: 'your-encryption-password', // Optional: specify a password for encryption
   compression: true,
+  // an optional callback useful for large file uploads
+  onProgress?: (progress: number) => {
+    console.log(`The upload is completed is ${progress}% completed`)
+  }
 }
 
-const uploadObservable = uploadFile(api, genericFile, options)
-  .then(() => {
-    console.log('File uploaded successfully!')
-  })
-  .catch((error) => {
-    console.error('Error uploading file:', error)
-  })
+const cid = uploadFile(api, genericFile, options)
+
+console.log(`The file is uploaded and its cid is ${cid}`)
 ```
 
 ### How to upload a folder from folder? (Not available in browser)
 
 ```ts
-import { uploadFolderFromFolderPath } from '@autonomys/auto-drive'
+import { createAutoDriveApi, uploadFolderFromFolderPath } from '@autonomys/auto-drive'
 
 const api = createAutoDriveApi({ apiKey: 'your-api-key' }) // Initialize your API instance with API key
 const folderPath = 'path/to/your/folder' // Specify the path to your folder
@@ -122,74 +119,31 @@ const folderPath = 'path/to/your/folder' // Specify the path to your folder
 const options = {
   uploadChunkSize: 1024 * 1024, // Optional: specify the chunk size for uploads
   password: 'your-encryption-password', // Optional: If folder is encrypted
+  // an optional callback useful for large file uploads
+  onProgress: (progress: number) => {
+    console.log(`The upload is completed is ${progress}% completed`)
+  },
 }
 
-const uploadObservable = uploadFolderFromFolderPath(api, folderPath, options)
-```
-
-**Note: If a folder is tried to be encrypted a zip file would be generated and that file would be encrypted and uploaded.**
-
-### Handle observables
-
-Since uploads may take some time, specially in big-sized files. Uploads do implement `rxjs` observables so you could have feedback about the process or even show your users the progress of the upload.
-
-For that reason when file upload functions return `PromisedObservable<UploadFileStatus>`:
-
-```typescript
-export type UploadFileStatus = {
-  type: 'file'
-  progress: number
-  cid?: CID
-}
-```
-
-Being the cid only returned (and thus optional) when the upload is completed.
-
-Similarly, for folder uploads the functions return `PromisedObservable<UploadFolderStatus>`
-
-```ts
-export type UploadFolderStatus = {
-  type: 'folder'
-  progress: number
-  cid?: CID
-}
-```
-
-**e.g Show upload progress in React**
-
-```typescript
-const [progress, setProgress] = useState<number>(0)
+const folderCID = await uploadFolderFromFolderPath(api, folderPath, options)
 
-useEffect(async () => {
-  const finalStatus = await uploadFileFromInput(api, genericFile, options).forEach((status) => {
-    setProgress(status.progress)
-  })
-})
+console.log(`The folder is uploaded and its cid is ${folderCID}`)
 ```
 
-**e.g Ignore observables**
-
-Other users may want to not use the progress observability. For having a promise instead the field `promise` is a Promise that resolves into `UploadFileStatus` and `UploadFolderStatus` for files and folders respectively.
-
-e.g
-
-```ts
-const status = await uploadFileFromInput(api, genericFile, options).promise
-const cid = status.cid
-```
+**Note: If a folder is tried to be encrypted a zip file would be generated and that file would be encrypted and uploaded.**
 
 ### Example Usage of Download
 
 Here is an example of how to use the `downloadFile` method to download a file from the server:
 
 ```typescript
-import { downloadObject } from '@autonomys/auto-drive'
+import { createAutoDriveApi, downloadFile } from '@autonomys/auto-drive'
 
 const api = createAutoDriveApi({ apiKey: 'your-api-key' }) // Initialize your API instance with API key
 
 try {
   const cid = '..'
-  const stream = await downloadObject(api, { cid })
+  const stream = await downloadFile(api, cid)
   let file = Buffer.alloc(0)
   for await (const chunk of stream) {
     file = Buffer.concat([file, chunk])
@@ -205,16 +159,20 @@ try {
 Here is an example of how to use the `getRoots` method to retrieve the root directories:
 
 ```typescript
-import { createAutoDriveApi, downloadObject } from '@autonomys/auto-drive'
-import fs from 'fs'
+import { createAutoDriveApi, apiCalls, Scope } from '@autonomys/auto-drive'
 
 const api = createAutoDriveApi({ apiKey: 'your-api-key' }) // Initialize your API instance with API key
 
 try {
-  const stream = fs.createWriteStream('/path/to/file')
-  const asyncBuffer = await downloadObject(api, { cid })
-  for await (const buffer of asyncBuffer) {
-    stream.write(buffer)
+  const myFiles = await apiCalls.getRoots(api, {
+    scope: Scope.User,
+    limit: 100,
+    offset: 0,
+  })
+
+  console.log(`Retrieved ${myFiles.rows.length} files of ${myFiles.totalCount} total`)
+  for (const file of myFiles.rows) {
+    console.log(`${file.name} - ${file.headCid}: ${file.size}`)
   }
 } catch (error) {
   console.error('Error downloading file:', error)

package/dist/api/calls/index.d.ts

@@ -50,6 +50,7 @@ export declare const apiCalls: {
     getObjectMetadata: (api: import("..").AutoDriveApi, query: import("../../utils").ArgsWithoutPagination<{
         cid: string;
     }>) => Promise<import("..").ObjectInformation["metadata"]>;
+    getMe: (api: import("..").AutoDriveApi) => Promise<import("../models/user").UserInfo>;
     downloadObject: (api: import("..").AutoDriveApi, query: import("../../utils").ArgsWithoutPagination<{
         cid: string;
     }>) => Promise<ReadableStream<Uint8Array>>;

package/dist/api/calls/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/calls/index.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,QAAQ;;;;;;;;;;;;gBAMg0B,CAAC;;;;;;qBAAgvC,CAAC;;;;;gBAAkiD,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CADzmH,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/calls/index.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,QAAQ;;;;;;;;;;;;gBAMg0B,CAAC;;;;;;qBAAgvC,CAAC;;;;;gBAAkiD,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CADzmH,CAAA"}

package/dist/api/calls/read.d.ts

@@ -2,6 +2,7 @@ import { ArgsWithoutPagination, ArgsWithPagination } from '../../utils/types';
 import { AutoDriveApi } from '../connection';
 import { PaginatedResult } from '../models/common';
 import { ObjectInformation, ObjectSummary, Scope } from '../models/objects';
+import { UserInfo } from '../models/user';
 /**
  * Retrieves the root objects based on the specified scope.
  *
@@ -96,4 +97,12 @@ export declare const getObjectOwners: (api: AutoDriveApi, query: ArgsWithoutPagi
 export declare const getObjectMetadata: (api: AutoDriveApi, query: ArgsWithoutPagination<{
     cid: string;
 }>) => Promise<ObjectInformation["metadata"]>;
+/**
+ * Get upload and download limits of the user
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @returns {Promise<UserInfo>} - A promise that resolves to the user info.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export declare const getMe: (api: AutoDriveApi) => Promise<UserInfo>;
 //# sourceMappingURL=read.d.ts.map

package/dist/api/calls/read.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"read.d.ts","sourceRoot":"","sources":["../../../src/api/calls/read.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAE3E;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,QACd,YAAY,SACV,kBAAkB,CAAC;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC,KAC1C,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,CAaxC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,QACrB,YAAY,SACV,kBAAkB,KACxB,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,CAaxC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,QAChB,YAAY,SACV,kBAAkB,KACxB,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,CAaxC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,QACf,YAAY,SACV,qBAAqB,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,KAC5C,OAAO,CAAC,iBAAiB,CAU3B,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,qBAAqB,QAC3B,YAAY,SACV,qBAAqB,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,KAC5C,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAU3C,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,QACrB,YAAY,SACV,qBAAqB,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,KAC5C,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAUrC,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,iBAAiB,QACvB,YAAY,SACV,qBAAqB,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,KAC5C,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAUvC,CAAA"}
+{"version":3,"file":"read.d.ts","sourceRoot":"","sources":["../../../src/api/calls/read.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC7E,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAA;AAC3E,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAEzC;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,QACd,YAAY,SACV,kBAAkB,CAAC;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC,KAC1C,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,CAaxC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,QACrB,YAAY,SACV,kBAAkB,KACxB,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,CAaxC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,QAChB,YAAY,SACV,kBAAkB,KACxB,OAAO,CAAC,eAAe,CAAC,aAAa,CAAC,CAaxC,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,QACf,YAAY,SACV,qBAAqB,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,KAC5C,OAAO,CAAC,iBAAiB,CAU3B,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,qBAAqB,QAC3B,YAAY,SACV,qBAAqB,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,KAC5C,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAU3C,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,QACrB,YAAY,SACV,qBAAqB,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,KAC5C,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAUrC,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,iBAAiB,QACvB,YAAY,SACV,qBAAqB,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,KAC5C,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAUvC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,KAAK,QAAe,YAAY,KAAG,OAAO,CAAC,QAAQ,CAS/D,CAAA"}

package/dist/api/calls/read.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getObjectMetadata = exports.getObjectOwners = exports.getObjectUploadStatus = exports.getObject = exports.getDeleted = exports.getSharedWithMe = exports.getRoots = void 0;
+exports.getMe = exports.getObjectMetadata = exports.getObjectOwners = exports.getObjectUploadStatus = exports.getObject = exports.getDeleted = exports.getSharedWithMe = exports.getRoots = void 0;
 /**
  * Retrieves the root objects based on the specified scope.
  *
@@ -157,3 +157,20 @@ const getObjectMetadata = (api, query) => __awaiter(void 0, void 0, void 0, func
     return response.json();
 });
 exports.getObjectMetadata = getObjectMetadata;
+/**
+ * Get upload and download limits of the user
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @returns {Promise<UserInfo>} - A promise that resolves to the user info.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+const getMe = (api) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield api.sendRequest('@me', {
+        method: 'GET',
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to get limits: ${response.statusText}`);
+    }
+    return response.json();
+});
+exports.getMe = getMe;

package/dist/api/models/user.d.ts

@@ -0,0 +1,28 @@
+export type SubscriptionGranularity = 'monthly';
+export type SubscriptionInfo = {
+    id: string;
+    organizationId: string;
+    uploadLimit: number;
+    downloadLimit: number;
+    granularity: SubscriptionGranularity;
+    pendingUploadCredits: number;
+    pendingDownloadCredits: number;
+};
+export declare enum UserRole {
+    User = "User",
+    Admin = "Admin"
+}
+export type User = {
+    oauthProvider: string;
+    oauthUserId: string;
+    role: UserRole;
+    downloadCredits: number;
+    uploadCredits: number;
+    publicId: string;
+    onboarded: true;
+};
+export type UserInfo = {
+    user: User;
+    subscription: SubscriptionInfo;
+};
+//# sourceMappingURL=user.d.ts.map

package/dist/api/models/user.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../../src/api/models/user.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,uBAAuB,GAAG,SAAS,CAAA;AAE/C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,cAAc,EAAE,MAAM,CAAA;IACtB,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;IACrB,WAAW,EAAE,uBAAuB,CAAA;IACpC,oBAAoB,EAAE,MAAM,CAAA;IAC5B,sBAAsB,EAAE,MAAM,CAAA;CAC/B,CAAA;AAED,oBAAY,QAAQ;IAClB,IAAI,SAAS;IACb,KAAK,UAAU;CAChB;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,aAAa,EAAE,MAAM,CAAA;IACrB,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,QAAQ,CAAA;IACd,eAAe,EAAE,MAAM,CAAA;IACvB,aAAa,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,IAAI,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,IAAI,CAAA;IACV,YAAY,EAAE,gBAAgB,CAAA;CAC/B,CAAA"}

package/dist/api/models/user.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserRole = void 0;
+var UserRole;
+(function (UserRole) {
+    UserRole["User"] = "User";
+    UserRole["Admin"] = "Admin";
+})(UserRole || (exports.UserRole = UserRole = {}));

package/dist/api/wrappers.d.ts

@@ -1,10 +1,10 @@
-import { PromisedObservable } from '../utils/observable';
 import { AutoDriveApi } from './connection';
 import { GenericFile, GenericFileWithinFolder } from './models/file';
-import { UploadChunksStatus, UploadFileStatus, UploadFolderStatus } from './models/uploads';
+import { SubscriptionInfo } from './models/user';
 export type UploadFileOptions = {
     password?: string;
     compression?: boolean;
+    onProgress?: (progress: number) => void;
 };
 /**
  * Uploads a file to the server with optional encryption and compression.
@@ -23,7 +23,7 @@ export type UploadFileOptions = {
  * @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, options?: UploadFileOptions, uploadChunkSize?: number) => PromisedObservable<UploadFileStatus>;
+export declare const uploadFileFromInput: (api: AutoDriveApi, file: File, options?: UploadFileOptions, uploadChunkSize?: number) => Promise<string>;
 /**
  * Uploads a file to the server with optional encryption and compression.
  *
@@ -38,10 +38,26 @@ export declare const uploadFileFromInput: (api: AutoDriveApi, file: File, option
  * @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.
+ * @returns {Promise<string>} - The CID of the uploaded file.
+ * @throws {Error} - Throws an error if the upload fails at any stage.
+ */
+export declare const uploadFile: (api: AutoDriveApi, file: GenericFile, options?: UploadFileOptions, uploadChunkSize?: number) => Promise<string>;
+/**
+ * Uploads an object as a JSON file to the server.
+ *
+ * This function serializes the provided object to a JSON string,
+ * and then uploads the JSON string as a file to the server.
+ *
+ * @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 {Promise<string>} - The CID of the uploaded file.
  * @throws {Error} - Throws an error if the upload fails at any stage.
  */
-export declare const uploadFile: (api: AutoDriveApi, file: GenericFile, options?: UploadFileOptions, uploadChunkSize?: number) => PromisedObservable<UploadFileStatus>;
+export declare const uploadObjectAsJSON: (api: AutoDriveApi, object: unknown, name?: string | undefined, options?: UploadFileOptions, uploadChunkSize?: number) => Promise<string>;
 /**
  * Uploads an entire folder to the server.
  *
@@ -59,10 +75,11 @@ export declare const uploadFile: (api: AutoDriveApi, file: GenericFile, options?
  * @returns {PromisedObservable<UploadFileStatus | UploadFolderStatus>} - An observable that emits the upload status.
  * @throws {Error} - Throws an error if the upload fails at any stage.
  */
-export declare const uploadFolderFromInput: (api: AutoDriveApi, fileList: FileList | File[], { uploadChunkSize, password }?: {
+export declare const uploadFolderFromInput: (api: AutoDriveApi, fileList: FileList | File[], { uploadChunkSize, password, onProgress, }?: {
     uploadChunkSize?: number;
     password?: string;
-}) => Promise<PromisedObservable<UploadFileStatus | UploadFolderStatus>>;
+    onProgress?: (progress: number) => void;
+}) => Promise<string>;
 /**
  * Uploads a file within an existing folder upload session.
  *
@@ -72,7 +89,7 @@ export declare const uploadFolderFromInput: (api: AutoDriveApi, fileList: FileLi
  *
  * @returns {Promise<void>} A promise that resolves when the file upload is complete.
  */
-export declare const uploadFileWithinFolderUpload: (api: AutoDriveApi, uploadId: string, file: GenericFileWithinFolder, uploadChunkSize?: number) => PromisedObservable<UploadChunksStatus>;
+export declare const uploadFileWithinFolderUpload: (api: AutoDriveApi, uploadId: string, file: GenericFileWithinFolder, uploadChunkSize?: number, options?: Pick<UploadFileOptions, "onProgress">) => Promise<string>;
 /**
  * Downloads a file from the AutoDrive service.
  *
@@ -81,4 +98,9 @@ export declare const uploadFileWithinFolderUpload: (api: AutoDriveApi, uploadId:
  * @returns {Promise<ReadableStream<Uint8Array>>} A promise that resolves to a ReadableStream of the downloaded file.
  */
 export declare const downloadFile: (api: AutoDriveApi, cid: string, password?: string) => Promise<AsyncIterable<Buffer>>;
+export declare const getPendingCredits: (api: AutoDriveApi) => Promise<{
+    upload: number;
+    download: number;
+}>;
+export declare const getSubscriptionInfo: (api: AutoDriveApi) => Promise<SubscriptionInfo>;
 //# sourceMappingURL=wrappers.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"wrappers.d.ts","sourceRoot":"","sources":["../../src/api/wrappers.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAExD,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAA;AAEpE,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AAE3F,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB,CAAA;AAuBD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,mBAAmB,QACzB,YAAY,QACX,IAAI,YACD,iBAAiB,oBACR,MAAM,KACvB,kBAAkB,CAAC,gBAAgB,CAgDrC,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,UAAU,QAChB,YAAY,QACX,WAAW,YACR,iBAAiB,oBACR,MAAM,KACvB,kBAAkB,CAAC,gBAAgB,CAiDrC,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,CA8DnE,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,4BAA4B,QAClC,YAAY,YACP,MAAM,QACV,uBAAuB,oBACX,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,CAwB/B,CAAA"}
+{"version":3,"file":"wrappers.d.ts","sourceRoot":"","sources":["../../src/api/wrappers.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAA;AAEpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAEhD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;CACxC,CAAA;AA6BD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,mBAAmB,QACzB,YAAY,QACX,IAAI,YACD,iBAAiB,oBACR,MAAM,KACvB,OAAO,CAAC,MAAM,CAgDhB,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,UAAU,QAChB,YAAY,QACX,WAAW,YACR,iBAAiB,oBACR,MAAM,KACvB,OAAO,CAAC,MAAM,CA+ChB,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,kBAAkB,QACxB,YAAY,UACT,OAAO,SACR,MAAM,GAAG,SAAS,YAChB,iBAAiB,oBACR,MAAM,KACvB,OAAO,CAAC,MAAM,CAiBhB,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,qBAAqB,QAC3B,YAAY,YACP,QAAQ,GAAG,IAAI,EAAE,+CAKxB;IAAE,eAAe,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;CAAE,KAC1F,OAAO,CAAC,MAAM,CA2DhB,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,4BAA4B,QAClC,YAAY,YACP,MAAM,QACV,uBAAuB,oBACX,MAAM,YACf,IAAI,CAAC,iBAAiB,EAAE,YAAY,CAAC,KAC7C,OAAO,CAAC,MAAM,CAchB,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,QAClB,YAAY,OACZ,MAAM,aACA,MAAM,KAChB,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAwB/B,CAAA;AAED,eAAO,MAAM,iBAAiB,QACvB,YAAY,KAChB,OAAO,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAM9C,CAAA;AAED,eAAO,MAAM,mBAAmB,QAAe,YAAY,KAAG,OAAO,CAAC,gBAAgB,CAIrF,CAAA"}