@autonomys/auto-drive 1.0.2 → 1.0.3

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

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

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

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

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

@@ -0,0 +1,97 @@
+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"]>;

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

@@ -0,0 +1,93 @@
+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>;

package/dist/cjs/api/calls/write.d.ts

@@ -0,0 +1,48 @@
+import { ArgsWithoutPagination } from '../../utils/types.js';
+import { AutoDriveApi } from '../connection.js';
+/**
+ * Shares an object with a specified public ID.
+ *
+ * This function sends a request to the server to share an object identified
+ * by its CID. The object will be shared with the provided public ID, allowing
+ * access to the object for users with that ID.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {ArgsWithoutPagination<{ cid: string; publicId: string }>} query - The query parameters containing the CID of the object to share and the public ID to share it with.
+ * @returns {Promise<any>} - A promise that resolves to the response from the server.
+ * @throws {Error} - Throws an error if the sharing process fails.
+ */
+export declare const shareObject: (api: AutoDriveApi, query: ArgsWithoutPagination<{
+    cid: string;
+    publicId: string;
+}>) => Promise<any>;
+/**
+ * Marks an object as deleted by sending a request to the server.
+ *
+ * This function sends a request to the server to mark an object identified
+ * by its CID as deleted. This action is typically irreversible and should
+ * be used with caution.
+ *
+ * @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 mark as deleted.
+ * @returns {Promise<void>} - A promise that resolves when the object has been marked as deleted.
+ * @throws {Error} - Throws an error if the marking process fails.
+ */
+export declare const markObjectAsDeleted: (api: AutoDriveApi, query: ArgsWithoutPagination<{
+    cid: string;
+}>) => Promise<void>;
+/**
+ * Restores an object that has been marked as deleted by sending a request to the server.
+ *
+ * This function sends a request to the server to restore an object identified
+ * by its CID. The restoration process may depend on the server's implementation
+ * and the object's current state.
+ *
+ * @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 restore.
+ * @returns {Promise<void>} - A promise that resolves when the object has been successfully restored.
+ * @throws {Error} - Throws an error if the restoration process fails.
+ */
+export declare const restoreObject: (api: AutoDriveApi, query: ArgsWithoutPagination<{
+    cid: string;
+}>) => Promise<void>;

package/dist/cjs/api/connection.d.ts

@@ -0,0 +1,7 @@
+export interface AutoDriveApi {
+    sendRequest: (relativeUrl: string, request: Partial<Request>, body?: BodyInit) => Promise<Response>;
+}
+export declare const createAutoDriveApi: ({ apiKey, url, }: {
+    apiKey: string;
+    url?: string;
+}) => AutoDriveApi;

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

@@ -0,0 +1,4 @@
+export * from './calls/index.js';
+export * from './connection.js';
+export * from './models/index.js';
+export * from './wrappers.js';

package/dist/cjs/api/models/folderTree.d.ts

@@ -0,0 +1,29 @@
+import { z } from 'zod';
+export type FolderTreeFolder = {
+    name: string;
+    type: 'folder';
+    children: FolderTree[];
+    id: string;
+};
+export type FolderTreeFile = {
+    name: string;
+    type: 'file';
+    id: string;
+};
+export type FolderTree = FolderTreeFolder | FolderTreeFile;
+export declare const FolderTreeFolderSchema: any;
+export declare const FolderTreeFileSchema: z.ZodObject<{
+    name: z.ZodString;
+    type: z.ZodLiteral<"file">;
+    id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name?: string;
+    type?: "file";
+    id?: string;
+}, {
+    name?: string;
+    type?: "file";
+    id?: string;
+}>;
+export declare const FolderTreeSchema: any;
+export declare const constructFromFileSystemEntries: (entries: string[]) => FolderTree;

package/dist/cjs/api/models/index.d.ts

@@ -0,0 +1,2 @@
+export * from './objects.js';
+export * from './uploads.js';

package/dist/cjs/api/models/objects.d.ts

@@ -0,0 +1,40 @@
+import { OffchainMetadata } from '@autonomys/auto-dag-data';
+export declare enum Scope {
+    Global = "global",
+    User = "user"
+}
+export interface Owner {
+    publicId: string;
+    role: OwnerRole;
+}
+export declare enum OwnerRole {
+    ADMIN = "admin",
+    VIEWER = "viewer"
+}
+export interface ObjectUploadStatus {
+    uploadedNodes: number | null;
+    totalNodes: number | null;
+    minimumBlockDepth: number | null;
+    maximumBlockDepth: number | null;
+}
+export type ObjectSummary = {
+    headCid: string;
+    name?: string;
+    size: number;
+    owners: Owner[];
+    uploadStatus: ObjectUploadStatus;
+} & ({
+    type: 'file';
+    mimeType?: string;
+} | {
+    type: 'folder';
+    children: (OffchainMetadata & {
+        type: 'folder';
+    })['children'];
+});
+export interface ObjectInformation {
+    cid: string;
+    metadata: OffchainMetadata;
+    uploadStatus: ObjectUploadStatus;
+    owners: Owner[];
+}

package/dist/cjs/api/models/uploads.d.ts

@@ -0,0 +1,113 @@
+import { FileUploadOptions } from '@autonomys/auto-dag-data';
+import { z } from 'zod';
+export declare enum UploadType {
+    FILE = "file",
+    FOLDER = "folder"
+}
+export declare enum UploadStatus {
+    PENDING = "pending",
+    COMPLETED = "completed",
+    MIGRATING = "migrating",
+    CANCELLED = "cancelled",
+    FAILED = "failed"
+}
+export declare const fileUploadSchema: z.ZodObject<{
+    id: z.ZodString;
+    rootId: z.ZodString;
+    relativeId: z.ZodNullable<z.ZodString>;
+    type: z.ZodNativeEnum<typeof UploadType>;
+    status: z.ZodNativeEnum<typeof UploadStatus>;
+    fileTree: z.ZodNull;
+    name: z.ZodString;
+    mimeType: z.ZodNullable<z.ZodString>;
+    oauthProvider: z.ZodString;
+    oauthUserId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id?: string;
+    rootId?: string;
+    relativeId?: string;
+    type?: UploadType;
+    status?: UploadStatus;
+    fileTree?: null;
+    name?: string;
+    mimeType?: string;
+    oauthProvider?: string;
+    oauthUserId?: string;
+}, {
+    id?: string;
+    rootId?: string;
+    relativeId?: string;
+    type?: UploadType;
+    status?: UploadStatus;
+    fileTree?: null;
+    name?: string;
+    mimeType?: string;
+    oauthProvider?: string;
+    oauthUserId?: string;
+}>;
+export type FileUpload = z.infer<typeof fileUploadSchema> & {
+    uploadOptions: FileUploadOptions | null;
+};
+export declare const folderUploadSchema: z.ZodObject<{
+    id: z.ZodString;
+    rootId: z.ZodString;
+    relativeId: z.ZodNullable<z.ZodString>;
+    type: z.ZodNativeEnum<typeof UploadType>;
+    status: z.ZodNativeEnum<typeof UploadStatus>;
+    fileTree: z.ZodObject<{
+        name: z.ZodString;
+        type: z.ZodLiteral<"folder">;
+        children: z.ZodArray<z.ZodLazy<any>, "many">;
+        id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id?: string;
+        type?: "folder";
+        name?: string;
+        children?: any[];
+    }, {
+        id?: string;
+        type?: "folder";
+        name?: string;
+        children?: any[];
+    }>;
+    name: z.ZodString;
+    mimeType: z.ZodNull;
+    oauthProvider: z.ZodString;
+    oauthUserId: z.ZodString;
+    uploadOptions: z.ZodNull;
+}, "strip", z.ZodTypeAny, {
+    id?: string;
+    rootId?: string;
+    relativeId?: string;
+    type?: UploadType;
+    status?: UploadStatus;
+    fileTree?: {
+        id?: string;
+        type?: "folder";
+        name?: string;
+        children?: any[];
+    };
+    name?: string;
+    mimeType?: null;
+    oauthProvider?: string;
+    oauthUserId?: string;
+    uploadOptions?: null;
+}, {
+    id?: string;
+    rootId?: string;
+    relativeId?: string;
+    type?: UploadType;
+    status?: UploadStatus;
+    fileTree?: {
+        id?: string;
+        type?: "folder";
+        name?: string;
+        children?: any[];
+    };
+    name?: string;
+    mimeType?: null;
+    oauthProvider?: string;
+    oauthUserId?: string;
+    uploadOptions?: null;
+}>;
+export type FolderUpload = z.infer<typeof folderUploadSchema>;

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

@@ -0,0 +1,66 @@
+import { AutoDriveApi } from './connection.js';
+type UploadFileOptions = {
+    password?: string;
+    compression?: boolean;
+};
+/**
+ * Uploads a file to the server with optional encryption and compression.
+ *
+ * This function reads a file from the specified file path, optionally encrypts it
+ * using the provided password, and compresses it using the ZLIB algorithm if specified.
+ * It then uploads the file in chunks to the server, creating an upload session and
+ * completing it once all chunks have been uploaded.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {string} filePath - The path to 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).
+ * @returns {Promise<void>} - A promise that resolves when the upload is complete.
+ * @throws {Error} - Throws an error if the upload fails at any stage.
+ */
+export declare const uploadFile: (api: AutoDriveApi, filePath: string, { password, compression }: UploadFileOptions, uploadChunkSize?: number) => Promise<void>;
+/**
+ * Uploads an entire folder to the server.
+ *
+ * This function retrieves all files within the specified folder,
+ * constructs a file tree representation, and initiates the upload
+ * process. It also handles optional compression of the files during
+ * the upload.
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {string} folderPath - The path of the folder to be uploaded.
+ * @returns {Promise<void>} - A promise that resolves when the folder upload is complete.
+ * @throws {Error} - Throws an error if the upload fails at any stage.
+ */
+export declare const uploadFolder: (api: AutoDriveApi, folderPath: string, uploadChunkSize?: number) => Promise<void>;
+/**
+ * Uploads a file within an existing folder upload session.
+ *
+ * @param {AutoDriveApi} api - The API instance to interact with the AutoDrive service.
+ * @param {string} uploadId - The ID of the folder upload session to which the file will be added.
+ * @param {string} filepath - The path of the file to be uploaded.
+ *
+ * @returns {Promise<void>} A promise that resolves when the file upload is complete.
+ */
+export declare const uploadFileWithinFolderUpload: (api: AutoDriveApi, uploadId: string, filepath: string, uploadChunkSize?: number) => Promise<void>;
+/**
+ * Downloads a file from the AutoDrive service.
+ *
+ * @param {AutoDriveApi} api - The API instance to interact with the AutoDrive service.
+ * @param {string} cid - The CID of the file to be downloaded.
+ * @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>>;
+/**
+ * Downloads a folder from the AutoDrive service without encryption.
+ *
+ * @param {AutoDriveApi} api - The API instance to interact with the AutoDrive service.
+ * @param {string} cid - The CID of the folder to be downloaded.
+ *
+ * @returns {Promise<ReadableStream<Uint8Array>>} A promise that resolves to a ReadableStream of the downloaded folder.
+ *
+ * @warning If the folder is encrypted, a warning will be logged, but the download will proceed without decryption.
+ */
+export declare const downloadFolderWithoutEncryption: (api: AutoDriveApi, cid: string) => Promise<ReadableStream<Uint8Array>>;
+export {};

package/dist/cjs/index.d.ts

@@ -0,0 +1,2 @@
+export * from './api/index.js';
+export * from './utils/index.js';