@autonomys/auto-drive 0.7.4 → 0.8.2

package/README.md

@@ -1,167 +1,74 @@
-# Auto-Drive
+# auto-drive
 
-![Autonomys Banner](https://github.com/autonomys/auto-sdk/blob/main/.github/images/autonomys-banner.webp)
+## auto-drive API Tools
 
-[![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)
+The `auto-drive` package provides a set of tools to interact with the auto-drive API. Below are some key functionalities:
 
-## Overview
+### Installation
 
-The **Autonomys Auto Drive SDK** (`@autonomys/auto-drive`) provides utilities for creating and managing IPLD DAGs (InterPlanetary Linked Data Directed Acyclic Graphs) for files and folders. It facilitates chunking large files, handling metadata, and creating folder structures suitable for distributed storage systems like IPFS.
-
-## Features
-
-- **File Chunking and DAG Creation**: Efficiently split large files into smaller chunks and create IPLD DAGs.
-- **Folder Structure Creation**: Generate IPLD DAGs for directory structures.
-- **Metadata Handling**: Add and manage metadata for files and folders.
-- **CID Management**: Utilities for working with Content Identifiers (CIDs).
-- **TypeScript Support**: Fully typed for enhanced developer experience.
-
-## Installation
-
-You can install Auto-Drive using npm or yarn:
-
-```bash
-npm install @autonomys/auto-drive
-```
-
-or
+To install the package, use the following command:
 
 ```bash
 yarn add @autonomys/auto-drive
 ```
 
-## Usage
+### How to use it?
 
-### Creating an IPLD DAG from a File
+### Example Usage
 
-To create an IPLD DAG from a file, you can use the `createFileIPLDDag` function:
+Here is an example of how to use the `uploadFile` method to upload a file with optional encryption and compression:
 
 ```typescript
-import { createFileIPLDDag } from '@autonomys/auto-drive'
-import fs from 'fs'
-
-const fileBuffer = fs.readFileSync('path/to/your/file.txt')
-
-const dag = createFileIPLDDag(fileBuffer, 'file.txt')
-```
-
-### Creating an IPLD DAG from a Folder
-
-To create an IPLD DAG from a folder, you can use the `createFolderIPLDDag` function:
+import { uploadFile } from '@autonomys/auto-drive'
 
-```typescript
-import { createFolderIPLDDag } from '@autonomys/auto-drive'
-import { CID } from 'multiformats'
-
-// Example child CIDs and folder information
-const childCIDs: CID[] = [
-  /* array of CIDs */
-]
-const folderName = 'my-folder'
-const folderSize = 1024 // size in bytes
-
-const folderDag = createFolderIPLDDag(childCIDs, folderName, folderSize)
-```
-
-### Working with CIDs
-
-You can use functions from the `cid` module to work with CIDs:
-
-```typescript
-import { cidOfNode, cidToString, stringToCid } from '@autonomys/auto-drive'
-
-// Create a CID from a node
-const cid = cidOfNode(dag.head)
-
-// Convert the CID to a string
-const cidString = cidToString(cid)
-
-// Parse a string back into a CID
-const parsedCID = stringToCid(cidString)
-```
-
-### Encoding and Decoding Nodes
-
-You can encode and decode IPLD nodes:
-
-```typescript
-import { encodeNode, decodeNode } from '@autonomys/auto-drive'
-
-// Encode a node
-const encodedNode = encodeNode(dag.head)
+const api = new AutoDriveApi() // Initialize your API instance
+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,
+}
 
-// Decode a node
-const decodedNode = decodeNode(encodedNode)
+uploadFile(api, filePath, options)
+  .then(() => {
+    console.log('File uploaded successfully!')
+  })
+  .catch((error) => {
+    console.error('Error uploading file:', error)
+  })
 ```
 
-### Handling Metadata
+### Example Usage of Download
 
-To add metadata to a node, you can create a metadata node:
+Here is an example of how to use the `downloadFile` method to download a file from the server:
 
 ```typescript
-import { createMetadataNode } from '@autonomys/auto-drive'
+import { getRoots } from '@autonomys/auto-drive'
 
-const metadata = {
-  name: 'My File',
-  description: 'This is a sample file',
-  // ... other metadata fields
-}
+const api = new AutoDriveApi() // Initialize your API instance
 
-const metadataNode = createMetadataNode(metadata)
+getRoots(api)
+  .then((roots) => {
+    console.log('Root directories:', roots)
+  })
+  .catch((error) => {
+    console.error('Error retrieving root directories:', error)
+  })
 ```
 
-### Example: Creating a File DAG and Converting to CID
-
-```typescript
-import { createFileIPLDDag, cidOfNode, cidToString } from '@autonomys/auto-drive'
-import fs from 'fs'
-
-const fileBuffer = fs.readFileSync('path/to/your/file.txt')
-
-const dag = createFileIPLDDag(fileBuffer, 'file.txt')
-
-const cid = cidOfNode(dag.headCID)
-const cidString = cidToString(cid)
+### Example Usage of getRoots
 
-console.log(`CID of the file DAG: ${cidString}`)
-```
-
-### Example: Converting Metadata To DAG
+Here is an example of how to use the `getRoots` method to retrieve the root directories:
 
 ```typescript
-import {
-  createMetadataIPLDDag,
-  cidOfNode,
-  cidToString,
-  type OffchainMetadata,
-} from '@autonomys/auto-drive'
-import fs from 'fs'
-
-const metadata: OffchainMetadata = fs.readFileSync('path/to/your/metadata.json')
+import { getRoots } from '@autonomys/auto-drive'
 
-const dag = createMetadataIPLDDag(metadata)
+const api = new AutoDriveApi() // Initialize your API instance
 
-const cid = cidOfNode(dag.headCID)
-const cidString = cidToString(cid)
-
-console.log(`CID of the metadata DAG: ${cidString}`)
+getRoots(api)
+  .then((roots) => {
+    console.log('Root directories:', roots)
+  })
+  .catch((error) => {
+    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).
-- **Auto-Utils Package**: Utility functions used alongside `auto-drive` can be found in [`@autonomys/auto-utils`](../Auto-Utils/README.md).
-
-## 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/calls/download.d.ts

@@ -0,0 +1,6 @@
+import { ArgsWithoutPagination } from '../../utils/types.js';
+import { AutoDriveApi } from '../connection.js';
+export declare const downloadObject: (api: AutoDriveApi, query: ArgsWithoutPagination<{
+    cid: string;
+}>) => Promise<ReadableStream<Uint8Array>>;
+//# sourceMappingURL=download.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../../src/api/calls/download.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AAE/C,eAAO,MAAM,cAAc,QACpB,YAAY,SACV,qBAAqB,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,KAC5C,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAcpC,CAAA"}

package/dist/api/calls/download.js

@@ -0,0 +1,12 @@
+export const downloadObject = async (api, query) => {
+    const response = await api.sendRequest(`/objects/${query.cid}/download`, {
+        method: 'GET',
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to download file: ${response.statusText}`);
+    }
+    if (!response.body) {
+        throw new Error('No body returned from download request');
+    }
+    return response.body;
+};

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

@@ -0,0 +1,5 @@
+export * from './download.js';
+export * from './read.js';
+export * from './upload.js';
+export * from './write.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/calls/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,WAAW,CAAA;AACzB,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA"}

package/dist/api/calls/index.js

@@ -0,0 +1,4 @@
+export * from './download.js';
+export * from './read.js';
+export * from './upload.js';
+export * from './write.js';

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

@@ -0,0 +1,98 @@
+import { ArgsWithoutPagination, ArgsWithPagination } from '../../utils/types.js';
+import { AutoDriveApi } from '../connection.js';
+import { ObjectInformation, ObjectSummary, Scope } from '../models/objects.js';
+/**
+ * Retrieves the root objects based on the specified scope.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithPagination<{ scope: Scope }>} query - The query parameters including scope, limit, and offset.
+ * @returns {Promise<ObjectSummary[]>} - A promise that resolves to an array of ObjectSummary representing the root objects.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export declare const getRoots: (api: AutoDriveApi, query: ArgsWithPagination<{
+    scope: Scope;
+}>) => Promise<ObjectSummary[]>;
+/**
+ * Retrieves the objects that have been shared with the authenticated user.
+ *
+ * This method sends a request to the server to fetch a list of objects
+ * that are shared with the user, based on the specified pagination parameters.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithPagination} query - The query parameters including limit and offset for pagination.
+ * @returns {Promise<ObjectSummary[]>} - A promise that resolves to an array of ObjectSummary representing the shared objects.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export declare const getSharedWithMe: (api: AutoDriveApi, query: ArgsWithPagination) => Promise<ObjectSummary[]>;
+/**
+ * Retrieves the objects that have been marked as deleted.
+ *
+ * This method sends a request to the server to fetch a list of objects
+ * that have been deleted, based on the specified pagination parameters.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithPagination} query - The query parameters including limit and offset for pagination.
+ * @returns {Promise<ObjectSummary[]>} - A promise that resolves to an array of ObjectSummary representing the deleted objects.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export declare const getDeleted: (api: AutoDriveApi, query: ArgsWithPagination) => Promise<ObjectSummary[]>;
+/**
+ * Retrieves the aggregated information of a specific object identified by its CID.
+ *
+ * This method sends a request to the server to fetch details about the
+ * object, including its metadata and other relevant information.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithoutPagination<{ cid: string }>} query - The query parameters containing the CID of the object to retrieve.
+ * @returns {Promise<ObjectInformation>} - A promise that resolves to the information of the requested object.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export declare const getObject: (api: AutoDriveApi, query: ArgsWithoutPagination<{
+    cid: string;
+}>) => Promise<ObjectInformation>;
+/**
+ * Retrieves the upload status of a specific object identified by its CID.
+ *
+ * This method sends a request to the server to fetch the current upload status
+ * of the object, which can indicate whether the upload is pending, completed,
+ * or failed.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithoutPagination<{ cid: string }>} query - The query parameters containing the CID of the object whose upload status is to be retrieved.
+ * @returns {Promise<ObjectInformation['uploadStatus']>} - A promise that resolves to the upload status of the requested object.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export declare const getObjectUploadStatus: (api: AutoDriveApi, query: ArgsWithoutPagination<{
+    cid: string;
+}>) => Promise<ObjectInformation["uploadStatus"]>;
+/**
+ * Retrieves the owners of a specific object identified by its CID.
+ *
+ * This method sends a request to the server to fetch the list of owners
+ * associated with the object. The owners can provide insights into who
+ * has access to or control over the object.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithoutPagination<{ cid: string }>} query - The query parameters containing the CID of the object whose owners are to be retrieved.
+ * @returns {Promise<ObjectInformation['owners']>} - A promise that resolves to the list of owners of the requested object.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export declare const getObjectOwners: (api: AutoDriveApi, query: ArgsWithoutPagination<{
+    cid: string;
+}>) => Promise<ObjectInformation["owners"]>;
+/**
+ * Retrieves the metadata of a specific object identified by its CID.
+ *
+ * This method sends a request to the server to fetch the metadata associated
+ * with the object. The metadata can include various details about the object,
+ * such as its name, type, size, and other relevant information.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithoutPagination<{ cid: string }>} query - The query parameters containing the CID of the object whose metadata is to be retrieved.
+ * @returns {Promise<ObjectInformation['metadata']>} - A promise that resolves to the metadata of the requested object.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export declare const getObjectMetadata: (api: AutoDriveApi, query: ArgsWithoutPagination<{
+    cid: string;
+}>) => Promise<ObjectInformation["metadata"]>;
+//# sourceMappingURL=read.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"read.d.ts","sourceRoot":"","sources":["../../../src/api/calls/read.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AAC/C,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AAE9E;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,QACd,YAAY,SACV,kBAAkB,CAAC;IAAE,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC,KAC1C,OAAO,CAAC,aAAa,EAAE,CAazB,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,QACrB,YAAY,SACV,kBAAkB,KACxB,OAAO,CAAC,aAAa,EAAE,CAazB,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,QAChB,YAAY,SACV,kBAAkB,KACxB,OAAO,CAAC,aAAa,EAAE,CAazB,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"}

package/dist/api/calls/read.js

@@ -0,0 +1,140 @@
+/**
+ * Retrieves the root objects based on the specified scope.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithPagination<{ scope: Scope }>} query - The query parameters including scope, limit, and offset.
+ * @returns {Promise<ObjectSummary[]>} - A promise that resolves to an array of ObjectSummary representing the root objects.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export const getRoots = async (api, query) => {
+    const response = await api.sendRequest(`/objects/roots?scope=${query.scope}&limit=${query.limit}&offset=${query.offset}`, {
+        method: 'GET',
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to get roots: ${response.statusText}`);
+    }
+    return response.json();
+};
+/**
+ * Retrieves the objects that have been shared with the authenticated user.
+ *
+ * This method sends a request to the server to fetch a list of objects
+ * that are shared with the user, based on the specified pagination parameters.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithPagination} query - The query parameters including limit and offset for pagination.
+ * @returns {Promise<ObjectSummary[]>} - A promise that resolves to an array of ObjectSummary representing the shared objects.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export const getSharedWithMe = async (api, query) => {
+    const response = await api.sendRequest(`/objects/roots/shared?limit=${query.limit}&offset=${query.offset}`, {
+        method: 'GET',
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to get shared with me: ${response.statusText}`);
+    }
+    return response.json();
+};
+/**
+ * Retrieves the objects that have been marked as deleted.
+ *
+ * This method sends a request to the server to fetch a list of objects
+ * that have been deleted, based on the specified pagination parameters.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithPagination} query - The query parameters including limit and offset for pagination.
+ * @returns {Promise<ObjectSummary[]>} - A promise that resolves to an array of ObjectSummary representing the deleted objects.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export const getDeleted = async (api, query) => {
+    const response = await api.sendRequest(`/objects/roots/deleted?limit=${query.limit}&offset=${query.offset}`, {
+        method: 'GET',
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to get deleted: ${response.statusText}`);
+    }
+    return response.json();
+};
+/**
+ * Retrieves the aggregated information of a specific object identified by its CID.
+ *
+ * This method sends a request to the server to fetch details about the
+ * object, including its metadata and other relevant information.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithoutPagination<{ cid: string }>} query - The query parameters containing the CID of the object to retrieve.
+ * @returns {Promise<ObjectInformation>} - A promise that resolves to the information of the requested object.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export const getObject = async (api, query) => {
+    const response = await api.sendRequest(`/objects/${query.cid}`, {
+        method: 'GET',
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to get object: ${response.statusText}`);
+    }
+    return response.json();
+};
+/**
+ * Retrieves the upload status of a specific object identified by its CID.
+ *
+ * This method sends a request to the server to fetch the current upload status
+ * of the object, which can indicate whether the upload is pending, completed,
+ * or failed.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithoutPagination<{ cid: string }>} query - The query parameters containing the CID of the object whose upload status is to be retrieved.
+ * @returns {Promise<ObjectInformation['uploadStatus']>} - A promise that resolves to the upload status of the requested object.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export const getObjectUploadStatus = async (api, query) => {
+    const response = await api.sendRequest(`/objects/${query.cid}/status`, {
+        method: 'GET',
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to get object: ${response.statusText}`);
+    }
+    return response.json();
+};
+/**
+ * Retrieves the owners of a specific object identified by its CID.
+ *
+ * This method sends a request to the server to fetch the list of owners
+ * associated with the object. The owners can provide insights into who
+ * has access to or control over the object.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithoutPagination<{ cid: string }>} query - The query parameters containing the CID of the object whose owners are to be retrieved.
+ * @returns {Promise<ObjectInformation['owners']>} - A promise that resolves to the list of owners of the requested object.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export const getObjectOwners = async (api, query) => {
+    const response = await api.sendRequest(`/objects/${query.cid}/owners`, {
+        method: 'GET',
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to get object: ${response.statusText}`);
+    }
+    return response.json();
+};
+/**
+ * Retrieves the metadata of a specific object identified by its CID.
+ *
+ * This method sends a request to the server to fetch the metadata associated
+ * with the object. The metadata can include various details about the object,
+ * such as its name, type, size, and other relevant information.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithoutPagination<{ cid: string }>} query - The query parameters containing the CID of the object whose metadata is to be retrieved.
+ * @returns {Promise<ObjectInformation['metadata']>} - A promise that resolves to the metadata of the requested object.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export const getObjectMetadata = async (api, query) => {
+    const response = await api.sendRequest(`/objects/${query.cid}/metadata`, {
+        method: 'GET',
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to get object: ${response.statusText}`);
+    }
+    return response.json();
+};

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

@@ -0,0 +1,94 @@
+import { FileUploadOptions } from '@autonomys/auto-dag-data';
+import { ArgsWithoutPagination } from '../../utils/types.js';
+import { AutoDriveApi } from '../connection.js';
+import { FolderTree } from '../models/folderTree.js';
+import { FileUpload, FolderUpload } from '../models/uploads.js';
+/**
+ * Initiates a file upload to the server.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithoutPagination<{ mimeType?: string; filename: string; uploadOptions: FileUploadOptions | null }>} args - The arguments for the file upload.
+ * @param {string} args.mimeType - The MIME type of the file (optional).
+ * @param {string} args.filename - The name of the file to be uploaded.
+ * @param {FileUploadOptions | null} args.uploadOptions - Additional options for the file upload (optional).
+ * @returns {Promise<FileUpload>} - A promise that resolves to the file upload information.
+ * @throws {Error} - Throws an error if the upload fails.
+ */
+export declare const createFileUpload: (api: AutoDriveApi, { mimeType, filename, uploadOptions, }: ArgsWithoutPagination<{
+    mimeType?: string;
+    filename: string;
+    uploadOptions: FileUploadOptions | null;
+}>) => Promise<FileUpload>;
+/**
+ * Initiates a folder upload to the server.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithoutPagination<{ fileTree: FolderTree; uploadOptions: FileUploadOptions }>} args - The arguments for the folder upload.
+ * @param {FolderTree} args.fileTree - The structure of the folder and its contents to be uploaded.
+ * @param {FileUploadOptions} args.uploadOptions - Additional options for the folder upload.
+ * @returns {Promise<FolderUpload>} - A promise that resolves to the folder upload information.
+ * @throws {Error} - Throws an error if the upload fails.
+ */
+export declare const createFolderUpload: (api: AutoDriveApi, { fileTree, uploadOptions, }: ArgsWithoutPagination<{
+    fileTree: FolderTree;
+    uploadOptions: FileUploadOptions;
+}>) => Promise<FolderUpload>;
+/**
+ * Creates a file upload within an existing folder upload.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithoutPagination<{ uploadId: string; name: string; mimeType: string; relativeId: string; uploadOptions: FileUploadOptions }>} args - The arguments for the file upload.
+ * @param {string} args.uploadId - The ID of the folder upload to which the file will be added.
+ * @param {string} args.name - The name of the file to be uploaded.
+ * @param {string} args.mimeType - The MIME type of the file being uploaded.
+ * @param {string} args.relativeId - The relative ID of the file within the folder structure.
+ * @param {FileUploadOptions} [args.uploadOptions={}] - Additional options for the file upload.
+ * @returns {Promise<FileUpload>} - A promise that resolves to the file upload information.
+ * @throws {Error} - Throws an error if the upload fails.
+ */
+export declare const createFileUploadWithinFolderUpload: (api: AutoDriveApi, { uploadId, name, mimeType, relativeId, uploadOptions, }: ArgsWithoutPagination<{
+    uploadId: string;
+    name: string;
+    mimeType?: string;
+    relativeId: string;
+    uploadOptions: FileUploadOptions;
+}>) => Promise<FileUpload>;
+/**
+ * Uploads a chunk of a file to the server.
+ *
+ * This function allows for the uploading of a specific chunk of a file
+ * during a multi-part upload process. It sends the chunk along with its
+ * index to the server, which can be used to reconstruct the file on the
+ * server side.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithoutPagination<{ uploadId: string; chunk: Buffer; index: number }>} args - The arguments for the file chunk upload.
+ * @param {string} args.uploadId - The ID of the upload session.
+ * @param {Buffer} args.chunk - The chunk of the file to be uploaded.
+ * @param {number} args.index - The index of the chunk in the overall file.
+ * @returns {Promise<void>} - A promise that resolves when the chunk is uploaded successfully.
+ * @throws {Error} - Throws an error if the upload fails.
+ */
+export declare const uploadFileChunk: (api: AutoDriveApi, { uploadId, chunk, index, }: ArgsWithoutPagination<{
+    uploadId: string;
+    chunk: Buffer;
+    index: number;
+}>) => Promise<void>;
+/**
+ * Completes a file or folder upload session on the server.
+ *
+ * This function sends a request to the server to finalize the upload
+ * process for a given upload session identified by the upload ID. It is
+ * typically called after all file chunks have been uploaded. This method
+ * can be used to complete both file and folder uploads.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithoutPagination<{ uploadId: string }>} args - The arguments for completing the upload.
+ * @param {string} args.uploadId - The ID of the upload session to complete.
+ * @returns {Promise<any>} - A promise that resolves to the response from the server.
+ * @throws {Error} - Throws an error if the completion of the upload fails.
+ */
+export declare const completeUpload: (api: AutoDriveApi, { uploadId }: ArgsWithoutPagination<{
+    uploadId: string;
+}>) => Promise<any>;
+//# sourceMappingURL=upload.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"upload.d.ts","sourceRoot":"","sources":["../../../src/api/calls/upload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAE/D;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB,QACtB,YAAY,0CAKd,qBAAqB,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAAA;CACxC,CAAC,KACD,OAAO,CAAC,UAAU,CAiBpB,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB,QACxB,YAAY,gCAId,qBAAqB,CAAC;IAAE,QAAQ,EAAE,UAAU,CAAC;IAAC,aAAa,EAAE,iBAAiB,CAAA;CAAE,CAAC,KACnF,OAAO,CAAC,YAAY,CAiBtB,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,kCAAkC,QACxC,YAAY,4DAOd,qBAAqB,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,EAAE,iBAAiB,CAAA;CACjC,CAAC,KACD,OAAO,CAAC,UAAU,CAiBpB,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,eAAe,QACrB,YAAY,+BAKd,qBAAqB,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,KAC3E,OAAO,CAAC,IAAI,CAgBd,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,cAAc,QACpB,YAAY,gBACH,qBAAqB,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,iBAW1D,CAAA"}