@autonomys/auto-drive 1.1.3 → 1.2.0

package/.env

@@ -0,0 +1,6 @@
+OBJECT_MAPPING_ARCHIVER_URL=ws://127.0.0.1:1234
+RPC_ENDPOINT=ws://127.0.0.1:1234
+PRIVATE_KEYS_PATH=//Alice
+CORS_ALLOW_ORIGINS=*
+DATABASE_URL=postgres://postgres:postgres@postgres:5432/postgres
+MAX_CACHE_SIZE=1073741824

package/LICENSE

@@ -0,0 +1,18 @@
+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.
+
+---

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/download.d.ts

@@ -0,0 +1,6 @@
+import { ArgsWithoutPagination } from '../../utils/types';
+import { AutoDriveApi } from '../connection';
+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,mBAAmB,CAAA;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE5C,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,25 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadObject = void 0;
+const downloadObject = (api, query) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield 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;
+});
+exports.downloadObject = downloadObject;

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

@@ -0,0 +1,57 @@
+export declare const apiCalls: {
+    shareObject: (api: import("..").AutoDriveApi, query: import("../../utils").ArgsWithoutPagination<{
+        cid: string;
+        publicId: string;
+    }>) => Promise<any>;
+    markObjectAsDeleted: (api: import("..").AutoDriveApi, query: import("../../utils").ArgsWithoutPagination<{
+        cid: string;
+    }>) => Promise<void>;
+    restoreObject: (api: import("..").AutoDriveApi, query: import("../../utils").ArgsWithoutPagination<{
+        cid: string;
+    }>) => Promise<void>;
+    createFileUpload: (api: import("..").AutoDriveApi, { mimeType, filename, uploadOptions, }: import("../../utils").ArgsWithoutPagination<{
+        mimeType?: string;
+        filename: string;
+        uploadOptions: import("..").FileUploadOptions | null;
+    }>) => Promise<import("..").FileUpload>;
+    createFolderUpload: (api: import("..").AutoDriveApi, { fileTree, uploadOptions, }: import("../../utils").ArgsWithoutPagination<{
+        fileTree: import("../models/folderTree").FolderTree;
+        uploadOptions?: import("..").FileUploadOptions;
+    }>) => Promise<import("..").FolderUpload>;
+    createFileUploadWithinFolderUpload: (api: import("..").AutoDriveApi, { uploadId, name, mimeType, relativeId, uploadOptions, }: import("../../utils").ArgsWithoutPagination<{
+        uploadId: string;
+        name: string;
+        mimeType?: string;
+        relativeId: string;
+        uploadOptions: import("..").FileUploadOptions;
+    }>) => Promise<import("..").FileUpload>;
+    uploadFileChunk: (api: import("..").AutoDriveApi, { uploadId, chunk, index, }: import("../../utils").ArgsWithoutPagination<{
+        uploadId: string;
+        chunk: Buffer;
+        index: number;
+    }>) => Promise<void>;
+    completeUpload: (api: import("..").AutoDriveApi, { uploadId }: import("../../utils").ArgsWithoutPagination<{
+        uploadId: string;
+    }>) => Promise<import("..").CompleteUploadResponse>;
+    getRoots: (api: import("..").AutoDriveApi, query: import("../../utils").ArgsWithPagination<{
+        scope: import("..").Scope;
+    }>) => Promise<import("../models/common").PaginatedResult<import("..").ObjectSummary>>;
+    getSharedWithMe: (api: import("..").AutoDriveApi, query: import("../../utils").ArgsWithPagination) => Promise<import("../models/common").PaginatedResult<import("..").ObjectSummary>>;
+    getDeleted: (api: import("..").AutoDriveApi, query: import("../../utils").ArgsWithPagination) => Promise<import("../models/common").PaginatedResult<import("..").ObjectSummary>>;
+    getObject: (api: import("..").AutoDriveApi, query: import("../../utils").ArgsWithoutPagination<{
+        cid: string;
+    }>) => Promise<import("..").ObjectInformation>;
+    getObjectUploadStatus: (api: import("..").AutoDriveApi, query: import("../../utils").ArgsWithoutPagination<{
+        cid: string;
+    }>) => Promise<import("..").ObjectInformation["uploadStatus"]>;
+    getObjectOwners: (api: import("..").AutoDriveApi, query: import("../../utils").ArgsWithoutPagination<{
+        cid: string;
+    }>) => Promise<import("..").ObjectInformation["owners"]>;
+    getObjectMetadata: (api: import("..").AutoDriveApi, query: import("../../utils").ArgsWithoutPagination<{
+        cid: string;
+    }>) => Promise<import("..").ObjectInformation["metadata"]>;
+    downloadObject: (api: import("..").AutoDriveApi, query: import("../../utils").ArgsWithoutPagination<{
+        cid: string;
+    }>) => Promise<ReadableStream<Uint8Array>>;
+};
+//# 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":"AAKA,eAAO,MAAM,QAAQ;;;;;;;;;;;;gBAMg0B,CAAC;;;;;;qBAAgvC,CAAC;;;;;gBAAkiD,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CADzmH,CAAA"}

package/dist/api/calls/index.js

@@ -0,0 +1,41 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apiCalls = void 0;
+const downloadCalls = __importStar(require("./download"));
+const readCalls = __importStar(require("./read"));
+const uploadCalls = __importStar(require("./upload"));
+const writeCalls = __importStar(require("./write"));
+exports.apiCalls = Object.assign(Object.assign(Object.assign(Object.assign({}, downloadCalls), readCalls), uploadCalls), writeCalls);

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

@@ -0,0 +1,99 @@
+import { ArgsWithoutPagination, ArgsWithPagination } from '../../utils/types';
+import { AutoDriveApi } from '../connection';
+import { PaginatedResult } from '../models/common';
+import { ObjectInformation, ObjectSummary, Scope } from '../models/objects';
+/**
+ * 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<PaginatedResult<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<PaginatedResult<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<PaginatedResult<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,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"}

package/dist/api/calls/read.js

@@ -0,0 +1,159 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+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.
+ *
+ * @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.
+ */
+const getRoots = (api, query) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield 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();
+});
+exports.getRoots = getRoots;
+/**
+ * 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.
+ */
+const getSharedWithMe = (api, query) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield 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();
+});
+exports.getSharedWithMe = getSharedWithMe;
+/**
+ * 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.
+ */
+const getDeleted = (api, query) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield 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();
+});
+exports.getDeleted = getDeleted;
+/**
+ * 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.
+ */
+const getObject = (api, query) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield api.sendRequest(`/objects/${query.cid}`, {
+        method: 'GET',
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to get object: ${response.statusText}`);
+    }
+    return response.json();
+});
+exports.getObject = getObject;
+/**
+ * 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.
+ */
+const getObjectUploadStatus = (api, query) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield api.sendRequest(`/objects/${query.cid}/status`, {
+        method: 'GET',
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to get object: ${response.statusText}`);
+    }
+    return response.json();
+});
+exports.getObjectUploadStatus = getObjectUploadStatus;
+/**
+ * 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.
+ */
+const getObjectOwners = (api, query) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield api.sendRequest(`/objects/${query.cid}/owners`, {
+        method: 'GET',
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to get object: ${response.statusText}`);
+    }
+    return response.json();
+});
+exports.getObjectOwners = getObjectOwners;
+/**
+ * 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.
+ */
+const getObjectMetadata = (api, query) => __awaiter(void 0, void 0, void 0, function* () {
+    const response = yield api.sendRequest(`/objects/${query.cid}/metadata`, {
+        method: 'GET',
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to get object: ${response.statusText}`);
+    }
+    return response.json();
+});
+exports.getObjectMetadata = getObjectMetadata;