@autonomys/auto-drive 1.2.7 → 1.3.0

package/src/api/calls/download.ts

@@ -1,8 +1,8 @@
 import { ArgsWithoutPagination } from '../../utils/types'
-import { AutoDriveApi } from '../connection'
+import { AutoDriveApiHandler } from '../types'
 
 export const downloadObject = async (
-  api: AutoDriveApi,
+  api: AutoDriveApiHandler,
   query: ArgsWithoutPagination<{ cid: string }>,
 ): Promise<ReadableStream<Uint8Array>> => {
   const response = await api.sendRequest(`/objects/${query.cid}/download`, {
@@ -20,6 +20,6 @@ export const downloadObject = async (
   return response.body
 }
 
-export const publicDownloadUrl = (api: AutoDriveApi, cid: string): string => {
+export const publicDownloadUrl = (api: AutoDriveApiHandler, cid: string): string => {
   return `${api.baseUrl}/objects/${cid}/public`
 }

package/src/api/calls/read.ts

@@ -1,19 +1,19 @@
 import { ArgsWithoutPagination, ArgsWithPagination } from '../../utils/types'
-import { AutoDriveApi } from '../connection'
 import { PaginatedResult } from '../models/common'
-import { ObjectInformation, ObjectSummary, Scope } from '../models/objects'
+import { ObjectInformation, ObjectSearchResult, ObjectSummary, Scope } from '../models/objects'
 import { UserInfo } from '../models/user'
+import { AutoDriveApiHandler } from '../types'
 
 /**
  * Retrieves the root objects based on the specified scope.
  *
- * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {AutoDriveApiHandler} 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: AutoDriveApi,
+  api: AutoDriveApiHandler,
   query: ArgsWithPagination<{ scope: Scope }>,
 ): Promise<PaginatedResult<ObjectSummary>> => {
   const response = await api.sendRequest(
@@ -36,13 +36,13 @@ export const getRoots = async (
  * 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 {AutoDriveApiHandler} 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: AutoDriveApi,
+  api: AutoDriveApiHandler,
   query: ArgsWithPagination,
 ): Promise<PaginatedResult<ObjectSummary>> => {
   const response = await api.sendRequest(
@@ -59,19 +59,37 @@ export const getSharedWithMe = async (
   return response.json()
 }
 
+export const searchByNameOrCID = async (
+  api: AutoDriveApiHandler,
+  query: ArgsWithoutPagination<{ value: string; scope: Scope }>,
+): Promise<ObjectSearchResult[]> => {
+  const response = await api.sendRequest(
+    `/objects/search?cid=${encodeURIComponent(query.value)}&scope=${query.scope}`,
+    {
+      method: 'GET',
+    },
+  )
+
+  if (!response.ok) {
+    throw new Error(`Failed to search by name or CID: ${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 {AutoDriveApiHandler} 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: AutoDriveApi,
+  api: AutoDriveApiHandler,
   query: ArgsWithPagination,
 ): Promise<PaginatedResult<ObjectSummary>> => {
   const response = await api.sendRequest(
@@ -94,13 +112,13 @@ export const getDeleted = async (
  * 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 {AutoDriveApiHandler} 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: AutoDriveApi,
+  api: AutoDriveApiHandler,
   query: ArgsWithoutPagination<{ cid: string }>,
 ): Promise<ObjectInformation> => {
   const response = await api.sendRequest(`/objects/${query.cid}`, {
@@ -114,6 +132,31 @@ export const getObject = async (
   return response.json()
 }
 
+/**
+ * Retrieves the summary of a specific object identified by its CID.
+ *
+ * This method sends a request to the server to fetch the summary of the object.
+ *
+ * @param {AutoDriveApiHandler} 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<ObjectSummary>} - A promise that resolves to the summary of the requested object.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export const getObjectSummary = async (
+  api: AutoDriveApiHandler,
+  query: ArgsWithoutPagination<{ cid: string }>,
+): Promise<ObjectSummary> => {
+  const response = await api.sendRequest(`/objects/${query.cid}/summary`, {
+    method: 'GET',
+  })
+
+  if (!response.ok) {
+    throw new Error(`Failed to get object summary: ${response.statusText}`)
+  }
+
+  return response.json()
+}
+
 /**
  * Retrieves the upload status of a specific object identified by its CID.
  *
@@ -121,13 +164,13 @@ export const getObject = async (
  * 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 {AutoDriveApiHandler} 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: AutoDriveApi,
+  api: AutoDriveApiHandler,
   query: ArgsWithoutPagination<{ cid: string }>,
 ): Promise<ObjectInformation['uploadStatus']> => {
   const response = await api.sendRequest(`/objects/${query.cid}/status`, {
@@ -148,13 +191,13 @@ export const getObjectUploadStatus = async (
  * 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 {AutoDriveApiHandler} 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: AutoDriveApi,
+  api: AutoDriveApiHandler,
   query: ArgsWithoutPagination<{ cid: string }>,
 ): Promise<ObjectInformation['owners']> => {
   const response = await api.sendRequest(`/objects/${query.cid}/owners`, {
@@ -175,13 +218,13 @@ export const getObjectOwners = async (
  * 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 {AutoDriveApiHandler} 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: AutoDriveApi,
+  api: AutoDriveApiHandler,
   query: ArgsWithoutPagination<{ cid: string }>,
 ): Promise<ObjectInformation['metadata']> => {
   const response = await api.sendRequest(`/objects/${query.cid}/metadata`, {
@@ -198,11 +241,11 @@ export const getObjectMetadata = async (
 /**
  * Get upload and download limits of the user
  *
- * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {AutoDriveApiHandler} api - The API instance used to send requests.
  * @returns {Promise<UserInfo>} - A promise that resolves to the user info.
  * @throws {Error} - Throws an error if the request fails.
  */
-export const getMe = async (api: AutoDriveApi): Promise<UserInfo> => {
+export const getMe = async (api: AutoDriveApiHandler): Promise<UserInfo> => {
   const response = await api.sendRequest('@me', {
     method: 'GET',
   })

package/src/api/calls/upload.ts

@@ -1,5 +1,4 @@
 import { ArgsWithoutPagination } from '../../utils/types'
-import { AutoDriveApi } from '../connection'
 import { FolderTree } from '../models/folderTree'
 import {
   CompleteUploadResponse,
@@ -7,11 +6,12 @@ import {
   FileUploadOptions,
   FolderUpload,
 } from '../models/uploads'
+import { AutoDriveApiHandler } from '../types'
 
 /**
  * Initiates a file upload to the server.
  *
- * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {AutoDriveApiHandler} 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.
@@ -20,7 +20,7 @@ import {
  * @throws {Error} - Throws an error if the upload fails.
  */
 export const createFileUpload = async (
-  api: AutoDriveApi,
+  api: AutoDriveApiHandler,
   {
     mimeType,
     filename,
@@ -52,7 +52,7 @@ export const createFileUpload = async (
 /**
  * Initiates a folder upload to the server.
  *
- * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {AutoDriveApiHandler} 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.
@@ -60,7 +60,7 @@ export const createFileUpload = async (
  * @throws {Error} - Throws an error if the upload fails.
  */
 export const createFolderUpload = async (
-  api: AutoDriveApi,
+  api: AutoDriveApiHandler,
   {
     fileTree,
     uploadOptions = {},
@@ -87,7 +87,7 @@ export const createFolderUpload = async (
 /**
  * Creates a file upload within an existing folder upload.
  *
- * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @param {AutoDriveApiHandler} 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.
@@ -98,7 +98,7 @@ export const createFolderUpload = async (
  * @throws {Error} - Throws an error if the upload fails.
  */
 export const createFileUploadWithinFolderUpload = async (
-  api: AutoDriveApi,
+  api: AutoDriveApiHandler,
   {
     uploadId,
     name,
@@ -139,7 +139,7 @@ export const createFileUploadWithinFolderUpload = async (
  * 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 {AutoDriveApiHandler} 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.
@@ -148,7 +148,7 @@ export const createFileUploadWithinFolderUpload = async (
  * @throws {Error} - Throws an error if the upload fails.
  */
 export const uploadFileChunk = async (
-  api: AutoDriveApi,
+  api: AutoDriveApiHandler,
   {
     uploadId,
     chunk,
@@ -180,14 +180,14 @@ export const uploadFileChunk = async (
  * 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 {AutoDriveApiHandler} 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 const completeUpload = async (
-  api: AutoDriveApi,
+  api: AutoDriveApiHandler,
   { uploadId }: ArgsWithoutPagination<{ uploadId: string }>,
 ): Promise<CompleteUploadResponse> => {
   const response = await api.sendRequest(`/uploads/${uploadId}/complete`, {

package/src/api/calls/write.ts

@@ -1,5 +1,5 @@
-import { ArgsWithoutPagination } from '../../utils/types';
-import { AutoDriveApi } from '../connection';
+import { ArgsWithoutPagination } from '../../utils/types'
+import { AutoDriveApiHandler } from '../types'
 
 /**
  * Shares an object with a specified public ID.
@@ -8,13 +8,13 @@ import { AutoDriveApi } from '../connection';
  * 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 {AutoDriveApiHandler} 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 const shareObject = async (
-  api: AutoDriveApi,
+  api: AutoDriveApiHandler,
   query: ArgsWithoutPagination<{ cid: string; publicId: string }>,
 ) => {
   const response = await api.sendRequest(
@@ -42,13 +42,13 @@ export const shareObject = async (
  * 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 {AutoDriveApiHandler} 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 const markObjectAsDeleted = async (
-  api: AutoDriveApi,
+  api: AutoDriveApiHandler,
   query: ArgsWithoutPagination<{ cid: string }>,
 ): Promise<void> => {
   const response = await api.sendRequest(`/objects/${query.cid}/delete`, {
@@ -67,13 +67,13 @@ export const markObjectAsDeleted = async (
  * 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 {AutoDriveApiHandler} 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 const restoreObject = async (
-  api: AutoDriveApi,
+  api: AutoDriveApiHandler,
   query: ArgsWithoutPagination<{ cid: string }>,
 ): Promise<void> => {
   const response = await api.sendRequest(`/objects/${query.cid}/restore`, {
@@ -94,13 +94,13 @@ export const restoreObject = async (
  * by its CID. The publication 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 {AutoDriveApiHandler} api - The API instance used to send requests.
  * @param {ArgsWithoutPagination<{ cid: string }>} query - The query parameters containing the CID of the object to publish.
  * @returns {Promise<void>} - A promise that resolves when the object has been successfully published.
  * @throws {Error} - Throws an error if the publication process fails.
  */
 export const publishObject = async (
-  api: AutoDriveApi,
+  api: AutoDriveApiHandler,
   query: ArgsWithoutPagination<{ cid: string }>,
 ): Promise<{ result: string }> => {
   const response = await api.sendRequest(`/objects/${query.cid}/publish`, {

package/src/api/connection.ts

@@ -1,63 +1,8 @@
-import { NetworkId } from '@autonomys/auto-utils'
-import { AutoDriveNetwork, getNetworkUrl, networks } from './networks'
+import { createApiRequestHandler } from './handler'
+import { AutoDriveApi, ConnectionOptions } from './types'
+import { createApiInterface } from './wrappers'
 
-export interface AutoDriveApi {
-  sendRequest: (
-    relativeUrl: string,
-    request: Partial<Request>,
-    body?: BodyInit,
-  ) => Promise<Response>
-  baseUrl: string
-}
-
-export enum OAuthProvider {
-  GOOGLE = 'google',
-  DISCORD = 'discord',
-}
-
-export type ApiKeyAuthProvider = 'apikey'
-export type AuthProvider = ApiKeyAuthProvider | 'oauth'
-
-type ConnectionOptions =
-  | {
-      provider?: AuthProvider
-      apiKey?: string
-      url?: null
-      network: AutoDriveNetwork
-    }
-  | {
-      provider?: AuthProvider
-      apiKey?: string
-      url: string
-      network?: null
-    }
-
-export const createAutoDriveApi = ({
-  provider = 'apikey',
-  apiKey,
-  url = null,
-  network,
-}: ConnectionOptions): AutoDriveApi => {
-  const baseUrl = !network ? url : getNetworkUrl(network)
-  if (!baseUrl) {
-    throw new Error('No base URL provided')
-  }
-
-  return {
-    sendRequest: async (relativeUrl: string, request: Partial<Request>, body?: BodyInit) => {
-      const headers = new Headers({
-        ...Object.fromEntries(request.headers?.entries() || []),
-        'x-auth-provider': provider,
-        Authorization: `Bearer ${apiKey}`,
-      })
-      const fullRequest = {
-        ...request,
-        headers: new Headers(headers),
-        body,
-      }
-
-      return fetch(`${baseUrl}${relativeUrl}`, fullRequest)
-    },
-    baseUrl,
-  }
+export const createAutoDriveApi = (options: ConnectionOptions): AutoDriveApi => {
+  const apiHandler = createApiRequestHandler(options)
+  return createApiInterface(apiHandler)
 }

package/src/api/handler.ts

@@ -0,0 +1,34 @@
+import { getNetworkUrl } from './networks'
+import { AutoDriveApiHandler, ConnectionOptions } from './types'
+
+export const createApiRequestHandler = ({
+  provider = 'apikey',
+  apiKey,
+  url = null,
+  network,
+}: ConnectionOptions): AutoDriveApiHandler => {
+  const baseUrl = !network ? url : getNetworkUrl(network)
+  if (!baseUrl) {
+    throw new Error('No base URL provided')
+  }
+
+  const api = {
+    sendRequest: async (relativeUrl: string, request: Partial<Request>, body?: BodyInit) => {
+      const headers = new Headers({
+        ...Object.fromEntries(request.headers?.entries() || []),
+        'x-auth-provider': provider,
+        Authorization: `Bearer ${apiKey}`,
+      })
+      const fullRequest = {
+        ...request,
+        headers: new Headers(headers),
+        body,
+      }
+
+      return fetch(`${baseUrl}${relativeUrl}`, fullRequest)
+    },
+    baseUrl,
+  }
+
+  return api
+}

package/src/api/index.ts

@@ -1,4 +1,6 @@
 export * from './calls/index'
 export * from './connection'
+export * from './handler'
 export * from './models/index'
+export * from './types'
 export * from './wrappers'

package/src/api/models/objects.ts

@@ -56,6 +56,11 @@ export interface ObjectUploadStatus {
   maximumBlockDepth: number | null
 }
 
+export interface ObjectSearchResult {
+  cid: string
+  name: string
+}
+
 export type ObjectSummary = {
   headCid: string
   name?: string