@plugable-io/js 0.0.3 → 0.0.4

package/README.md

@@ -72,6 +72,12 @@ try {
     },
     onProgress: (percent) => {
       console.log(`Upload progress: ${percent}%`);
+    },
+    onCompleted: (file) => {
+      console.log('Upload completed:', file);
+    },
+    onFailed: (error) => {
+      console.error('Upload failed:', error);
     }
   });
   console.log('File uploaded:', uploadedFile);
@@ -98,7 +104,24 @@ const response = await client.list({
 });
 
 console.log('Files:', response.files);
+```
 
+### Finding a File
+
+You can find a single file using `find`. This is a convenience method that searches for files and returns the first match. It's useful for finding files by metadata or other criteria.
+
+```typescript
+const file = await client.find({
+  metadata: {
+    external_id: 'user_123_avatar'
+  }
+});
+
+if (file) {
+  console.log('Found file:', file);
+} else {
+  console.log('File not found');
+}
 ```
 
 ### Getting a File

package/dist/index.d.mts

@@ -32,6 +32,8 @@ interface SearchOptions {
 interface UploadOptions {
     metadata?: Record<string, any>;
     onProgress?: (progress: number) => void;
+    onCompleted?: (file: FileObject) => void;
+    onFailed?: (error: Error) => void;
 }
 interface UpdateOptions {
     filename?: string;
@@ -45,6 +47,7 @@ declare class BucketClient {
     private request;
     list(options?: SearchOptions): Promise<ListResponse>;
     get(id: string): Promise<FileObject>;
+    find(options: SearchOptions): Promise<FileObject | null>;
     update(id: string, updates: UpdateOptions): Promise<FileObject>;
     delete(id: string): Promise<void>;
     upload(file: File, options?: UploadOptions): Promise<FileObject>;

package/dist/index.d.ts

@@ -32,6 +32,8 @@ interface SearchOptions {
 interface UploadOptions {
     metadata?: Record<string, any>;
     onProgress?: (progress: number) => void;
+    onCompleted?: (file: FileObject) => void;
+    onFailed?: (error: Error) => void;
 }
 interface UpdateOptions {
     filename?: string;
@@ -45,6 +47,7 @@ declare class BucketClient {
     private request;
     list(options?: SearchOptions): Promise<ListResponse>;
     get(id: string): Promise<FileObject>;
+    find(options: SearchOptions): Promise<FileObject | null>;
     update(id: string, updates: UpdateOptions): Promise<FileObject>;
     delete(id: string): Promise<void>;
     upload(file: File, options?: UploadOptions): Promise<FileObject>;

package/dist/index.js

@@ -111,7 +111,15 @@ var BucketClient = class {
     });
   }
   async get(id) {
-    return this.request("GET", `/buckets/${this.config.bucketId}/files/${id}`);
+    const file = await this.request("GET", `/buckets/${this.config.bucketId}/files/${id}`);
+    if (!file.checksum) {
+      console.warn(`File ${id} missing checksum`);
+    }
+    return file;
+  }
+  async find(options) {
+    const response = await this.list({ ...options, per_page: 1 });
+    return response.files.length > 0 ? response.files[0] : null;
   }
   async update(id, updates) {
     return this.request("PATCH", `/buckets/${this.config.bucketId}/files/${id}`, updates);
@@ -120,30 +128,41 @@ var BucketClient = class {
     await this.request("DELETE", `/buckets/${this.config.bucketId}/files/${id}`);
   }
   async upload(file, options) {
-    const checksum = await calculateChecksum(file);
-    const uploadInit = await this.request(
-      "POST",
-      `/buckets/${this.config.bucketId}/files`,
-      {
-        filename: file.name,
-        byte_size: file.size,
-        checksum,
-        content_type: file.type
-      }
-    );
-    await import_axios.default.put(uploadInit.url, file, {
-      headers: uploadInit.headers,
-      onUploadProgress: (progressEvent) => {
-        if (options?.onProgress && progressEvent.total) {
-          const percentCompleted = Math.round(progressEvent.loaded * 100 / progressEvent.total);
-          options.onProgress(percentCompleted);
+    try {
+      const checksum = await calculateChecksum(file);
+      const uploadInit = await this.request(
+        "POST",
+        `/buckets/${this.config.bucketId}/files`,
+        {
+          filename: file.name,
+          byte_size: file.size,
+          checksum,
+          content_type: file.type
         }
+      );
+      await import_axios.default.put(uploadInit.url, file, {
+        headers: uploadInit.headers,
+        onUploadProgress: (progressEvent) => {
+          if (options?.onProgress && progressEvent.total) {
+            const percentCompleted = Math.round(progressEvent.loaded * 100 / progressEvent.total);
+            options.onProgress(percentCompleted);
+          }
+        }
+      });
+      const confirmedFile = await this.request("POST", `/buckets/${this.config.bucketId}/files/confirm`, {
+        signed_id: uploadInit.sid,
+        metadata: options?.metadata
+      });
+      if (options?.onCompleted) {
+        options.onCompleted(confirmedFile);
       }
-    });
-    return this.request("POST", `/buckets/${this.config.bucketId}/files/confirm`, {
-      signed_id: uploadInit.sid,
-      metadata: options?.metadata
-    });
+      return confirmedFile;
+    } catch (error) {
+      if (options?.onFailed) {
+        options.onFailed(error);
+      }
+      throw error;
+    }
   }
 };
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.mjs

@@ -77,7 +77,15 @@ var BucketClient = class {
     });
   }
   async get(id) {
-    return this.request("GET", `/buckets/${this.config.bucketId}/files/${id}`);
+    const file = await this.request("GET", `/buckets/${this.config.bucketId}/files/${id}`);
+    if (!file.checksum) {
+      console.warn(`File ${id} missing checksum`);
+    }
+    return file;
+  }
+  async find(options) {
+    const response = await this.list({ ...options, per_page: 1 });
+    return response.files.length > 0 ? response.files[0] : null;
   }
   async update(id, updates) {
     return this.request("PATCH", `/buckets/${this.config.bucketId}/files/${id}`, updates);
@@ -86,30 +94,41 @@ var BucketClient = class {
     await this.request("DELETE", `/buckets/${this.config.bucketId}/files/${id}`);
   }
   async upload(file, options) {
-    const checksum = await calculateChecksum(file);
-    const uploadInit = await this.request(
-      "POST",
-      `/buckets/${this.config.bucketId}/files`,
-      {
-        filename: file.name,
-        byte_size: file.size,
-        checksum,
-        content_type: file.type
-      }
-    );
-    await axios.put(uploadInit.url, file, {
-      headers: uploadInit.headers,
-      onUploadProgress: (progressEvent) => {
-        if (options?.onProgress && progressEvent.total) {
-          const percentCompleted = Math.round(progressEvent.loaded * 100 / progressEvent.total);
-          options.onProgress(percentCompleted);
+    try {
+      const checksum = await calculateChecksum(file);
+      const uploadInit = await this.request(
+        "POST",
+        `/buckets/${this.config.bucketId}/files`,
+        {
+          filename: file.name,
+          byte_size: file.size,
+          checksum,
+          content_type: file.type
         }
+      );
+      await axios.put(uploadInit.url, file, {
+        headers: uploadInit.headers,
+        onUploadProgress: (progressEvent) => {
+          if (options?.onProgress && progressEvent.total) {
+            const percentCompleted = Math.round(progressEvent.loaded * 100 / progressEvent.total);
+            options.onProgress(percentCompleted);
+          }
+        }
+      });
+      const confirmedFile = await this.request("POST", `/buckets/${this.config.bucketId}/files/confirm`, {
+        signed_id: uploadInit.sid,
+        metadata: options?.metadata
+      });
+      if (options?.onCompleted) {
+        options.onCompleted(confirmedFile);
       }
-    });
-    return this.request("POST", `/buckets/${this.config.bucketId}/files/confirm`, {
-      signed_id: uploadInit.sid,
-      metadata: options?.metadata
-    });
+      return confirmedFile;
+    } catch (error) {
+      if (options?.onFailed) {
+        options.onFailed(error);
+      }
+      throw error;
+    }
   }
 };
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@plugable-io/js",
-    "version": "0.0.3",
+    "version": "0.0.4",
     "description": "JavaScript client for Plugable File Management API",
     "main": "dist/index.js",
     "module": "dist/index.mjs",