@autonomys/auto-drive 0.8.2 → 1.0.1

package/dist/api/wrappers.js

@@ -1,158 +0,0 @@
-import { compressFile, CompressionAlgorithm, decompressFile, decryptFile, encryptFile, EncryptionAlgorithm, } from '@autonomys/auto-dag-data';
-import fs from 'fs';
-import mime from 'mime-types';
-import { asyncByChunk, asyncFromStream } from '../utils/async.js';
-import { getFiles } from '../utils/folder.js';
-import { completeUpload, createFileUpload, createFileUploadWithinFolderUpload, createFolderUpload, downloadObject, getObjectMetadata, uploadFileChunk, } from './calls/index.js';
-import { constructFromFileSystemEntries } from './models/folderTree.js';
-const UPLOAD_FILE_CHUNK_SIZE = 1024 * 1024;
-const uploadFileChunks = async (api, fileUploadId, asyncIterable, uploadChunkSize = UPLOAD_FILE_CHUNK_SIZE) => {
-    let index = 0;
-    for await (const chunk of asyncByChunk(asyncIterable, uploadChunkSize)) {
-        await uploadFileChunk(api, { uploadId: fileUploadId, chunk, index });
-        index++;
-    }
-};
-/**
- * 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 const uploadFile = async (api, filePath, { password, compression = true }, uploadChunkSize) => {
-    let asyncIterable = fs.createReadStream(filePath);
-    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(filePath) || undefined,
-        filename: filePath.split('/').pop(),
-        uploadOptions,
-    });
-    await uploadFileChunks(api, fileUpload.id, asyncIterable, uploadChunkSize);
-    await completeUpload(api, { uploadId: fileUpload.id });
-};
-/**
- * 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 const uploadFolder = async (api, folderPath, uploadChunkSize) => {
-    const files = await getFiles(folderPath);
-    const fileTree = constructFromFileSystemEntries(files);
-    const folderUpload = await createFolderUpload(api, {
-        fileTree,
-        uploadOptions: {
-            compression: {
-                algorithm: CompressionAlgorithm.ZLIB,
-                level: 9,
-            },
-        },
-    });
-    for (const file of files) {
-        await uploadFileWithinFolderUpload(api, folderUpload.id, file, uploadChunkSize);
-    }
-    await completeUpload(api, { uploadId: folderUpload.id });
-};
-/**
- * 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 const uploadFileWithinFolderUpload = async (api, uploadId, filepath, uploadChunkSize) => {
-    const name = filepath.split('/').pop();
-    const fileUpload = await createFileUploadWithinFolderUpload(api, {
-        uploadId,
-        name,
-        mimeType: mime.lookup(name) || undefined,
-        relativeId: filepath,
-        uploadOptions: {},
-    });
-    await uploadFileChunks(api, fileUpload.id, fs.createReadStream(filepath), uploadChunkSize);
-    await completeUpload(api, { uploadId: fileUpload.id });
-};
-/**
- * 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 const downloadFile = async (api, cid, password) => {
-    const metadata = await getObjectMetadata(api, { cid });
-    let iterable = asyncFromStream(await downloadObject(api, { cid }));
-    if (metadata.uploadOptions?.encryption) {
-        if (!password) {
-            throw new Error('Password is required to decrypt the file');
-        }
-        iterable = decryptFile(iterable, password, {
-            algorithm: EncryptionAlgorithm.AES_256_GCM,
-        });
-    }
-    if (metadata.uploadOptions?.compression) {
-        iterable = decompressFile(iterable, {
-            algorithm: CompressionAlgorithm.ZLIB,
-        });
-    }
-    return iterable;
-};
-/**
- * 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 const downloadFolderWithoutEncryption = async (api, cid) => {
-    const metadata = await getObjectMetadata(api, { cid });
-    if (metadata.uploadOptions?.encryption) {
-        console.warn('Downloading encrypted folder. Folder support encryption but it is not recommended.');
-    }
-    return downloadObject(api, { cid });
-};

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-export * from './api/index.js';
-export * from './utils/index.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,kBAAkB,CAAA"}

package/dist/index.js

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

package/dist/utils/async.d.ts

@@ -1,3 +0,0 @@
-export declare const asyncByChunk: (asyncIterable: AsyncIterable<Buffer>, chunkSize: number) => AsyncGenerator<Buffer, void, unknown>;
-export declare const asyncFromStream: (stream: ReadableStream<Uint8Array>) => AsyncIterable<Buffer>;
-//# sourceMappingURL=async.d.ts.map

package/dist/utils/async.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"async.d.ts","sourceRoot":"","sources":["../../src/utils/async.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY,kBACR,aAAa,CAAC,MAAM,CAAC,aACzB,MAAM,0CAelB,CAAA;AAED,eAAO,MAAM,eAAe,WAClB,cAAc,CAAC,UAAU,CAAC,KACjC,aAAa,CAAC,MAAM,CAOtB,CAAA"}

package/dist/utils/async.js

@@ -1,21 +0,0 @@
-export const asyncByChunk = async function* (asyncIterable, chunkSize) {
-    let buffer = Buffer.alloc(0);
-    for await (const chunk of asyncIterable) {
-        buffer = Buffer.concat([buffer, chunk]);
-        while (buffer.length >= chunkSize) {
-            yield buffer.subarray(0, chunkSize);
-            buffer = buffer.subarray(chunkSize);
-        }
-    }
-    if (buffer.length > 0) {
-        yield buffer;
-    }
-};
-export const asyncFromStream = async function* (stream) {
-    const reader = stream.getReader();
-    let result = await reader.read();
-    while (!result.done) {
-        yield Buffer.from(result.value);
-        result = await reader.read();
-    }
-};

package/dist/utils/folder.d.ts

@@ -1,2 +0,0 @@
-export declare const getFiles: (folderPath: string) => Promise<string[]>;
-//# sourceMappingURL=folder.d.ts.map

package/dist/utils/folder.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"folder.d.ts","sourceRoot":"","sources":["../../src/utils/folder.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,QAAQ,eAAsB,MAAM,KAAG,OAAO,CAAC,MAAM,EAAE,CAWnE,CAAA"}

package/dist/utils/folder.js

@@ -1,14 +0,0 @@
-import fs from 'fs/promises';
-import path from 'path';
-export const getFiles = async (folderPath) => {
-    const stat = await fs.stat(folderPath);
-    if (stat.isDirectory()) {
-        const files = await fs.readdir(folderPath);
-        const promises = files.map((file) => getFiles(path.join(folderPath, file)));
-        const allFiles = await Promise.all(promises);
-        return allFiles.flat();
-    }
-    else {
-        return [folderPath];
-    }
-};

package/dist/utils/index.d.ts

@@ -1,5 +0,0 @@
-export * from './async.js';
-export * from './folder.js';
-export * from './stream.js';
-export * from './types.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

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

package/dist/utils/index.js

@@ -1,4 +0,0 @@
-export * from './async.js';
-export * from './folder.js';
-export * from './stream.js';
-export * from './types.js';

package/dist/utils/stream.d.ts

@@ -1,3 +0,0 @@
-import { WriteStream } from 'fs';
-export declare const createWriteStreamAdapter: (nodeWriteStream: WriteStream) => WritableStream<Uint8Array>;
-//# sourceMappingURL=stream.d.ts.map

package/dist/utils/stream.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../../src/utils/stream.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,IAAI,CAAA;AAEhC,eAAO,MAAM,wBAAwB,oBAClB,WAAW,KAC3B,cAAc,CAAC,UAAU,CAoB3B,CAAA"}

package/dist/utils/stream.js

@@ -1,22 +0,0 @@
-export const createWriteStreamAdapter = (nodeWriteStream) => {
-    return new WritableStream({
-        write(chunk) {
-            return new Promise((resolve, reject) => {
-                nodeWriteStream.write(chunk, (err) => {
-                    if (err) {
-                        reject(err);
-                    }
-                    else {
-                        resolve();
-                    }
-                });
-            });
-        },
-        close() {
-            nodeWriteStream.end();
-        },
-        abort(err) {
-            nodeWriteStream.destroy(err);
-        },
-    });
-};

package/dist/utils/types.d.ts

@@ -1,6 +0,0 @@
-export type ArgsWithPagination<T = {}> = T & {
-    limit: number;
-    offset: number;
-};
-export type ArgsWithoutPagination<T = {}> = T;
-//# sourceMappingURL=types.d.ts.map

package/dist/utils/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/utils/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,kBAAkB,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,qBAAqB,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA"}

package/dist/utils/types.js

@@ -1 +0,0 @@
-export {};