@plugable-io/js 0.0.5 → 0.0.6

package/README.md

@@ -147,6 +147,14 @@ const updatedFile = await client.update('file_id', {
 await client.delete('file_id');
 ```
 
+## Performance & Caching
+
+The client automatically leverages browser HTTP caching based on file checksums:
+- File list responses are cached for 5 minutes in the browser
+- Cache is validated using ETags based on file checksums
+- If files haven't changed, the browser returns cached data instantly
+- No manual cache management needed - it just works!
+
 ## License
 
 MIT

package/dist/index.d.mts

@@ -3,7 +3,7 @@ interface BucketClientConfig {
     getToken: () => Promise<string> | string;
     baseUrl?: string;
 }
-interface FileObject {
+declare class FileObject {
     id: string;
     name: string;
     metadata: Record<string, any>;
@@ -13,6 +13,11 @@ interface FileObject {
     download_url?: string;
     created_at: string;
     updated_at: string;
+    private _client?;
+    constructor(data: any, client?: any);
+    update(metadata?: Record<string, any>, name?: string): Promise<FileObject>;
+    delete(): Promise<void>;
+    download(): Promise<void>;
 }
 interface ListResponse {
     files: FileObject[];
@@ -45,6 +50,7 @@ declare class BucketClient {
     private config;
     constructor(config: BucketClientConfig);
     private request;
+    private wrapFileObject;
     list(options?: SearchOptions): Promise<ListResponse>;
     get(id: string): Promise<FileObject>;
     find(options: SearchOptions): Promise<FileObject | null>;
@@ -53,4 +59,4 @@ declare class BucketClient {
     upload(file: File, options?: UploadOptions): Promise<FileObject>;
 }
 
-export { BucketClient, type BucketClientConfig, type FileObject, type ListResponse, type SearchOptions, type UpdateOptions, type UploadOptions };
+export { BucketClient, type BucketClientConfig, FileObject, type ListResponse, type SearchOptions, type UpdateOptions, type UploadOptions };

package/dist/index.d.ts

@@ -3,7 +3,7 @@ interface BucketClientConfig {
     getToken: () => Promise<string> | string;
     baseUrl?: string;
 }
-interface FileObject {
+declare class FileObject {
     id: string;
     name: string;
     metadata: Record<string, any>;
@@ -13,6 +13,11 @@ interface FileObject {
     download_url?: string;
     created_at: string;
     updated_at: string;
+    private _client?;
+    constructor(data: any, client?: any);
+    update(metadata?: Record<string, any>, name?: string): Promise<FileObject>;
+    delete(): Promise<void>;
+    download(): Promise<void>;
 }
 interface ListResponse {
     files: FileObject[];
@@ -45,6 +50,7 @@ declare class BucketClient {
     private config;
     constructor(config: BucketClientConfig);
     private request;
+    private wrapFileObject;
     list(options?: SearchOptions): Promise<ListResponse>;
     get(id: string): Promise<FileObject>;
     find(options: SearchOptions): Promise<FileObject | null>;
@@ -53,4 +59,4 @@ declare class BucketClient {
     upload(file: File, options?: UploadOptions): Promise<FileObject>;
 }
 
-export { BucketClient, type BucketClientConfig, type FileObject, type ListResponse, type SearchOptions, type UpdateOptions, type UploadOptions };
+export { BucketClient, type BucketClientConfig, FileObject, type ListResponse, type SearchOptions, type UpdateOptions, type UploadOptions };

package/dist/index.js

@@ -32,7 +32,8 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  BucketClient: () => BucketClient
+  BucketClient: () => BucketClient,
+  FileObject: () => FileObject
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -72,6 +73,68 @@ var calculateChecksum = (file) => {
   });
 };
 
+// src/types.ts
+var FileObject = class {
+  constructor(data, client) {
+    __publicField(this, "id");
+    __publicField(this, "name");
+    __publicField(this, "metadata");
+    __publicField(this, "checksum");
+    __publicField(this, "byte_size");
+    __publicField(this, "content_type");
+    __publicField(this, "download_url");
+    __publicField(this, "created_at");
+    __publicField(this, "updated_at");
+    __publicField(this, "_client");
+    this.id = data.id;
+    this.name = data.name;
+    this.metadata = data.metadata;
+    this.checksum = data.checksum;
+    this.byte_size = data.byte_size;
+    this.content_type = data.content_type;
+    this.download_url = data.download_url;
+    this.created_at = data.created_at;
+    this.updated_at = data.updated_at;
+    this._client = client;
+  }
+  async update(metadata, name) {
+    if (!this._client) {
+      throw new Error("Cannot update: File object not associated with a client");
+    }
+    const updates = {};
+    if (metadata !== void 0) updates.metadata = metadata;
+    if (name !== void 0) updates.filename = name;
+    const updated = await this._client.update(this.id, updates);
+    Object.assign(this, updated);
+    return this;
+  }
+  async delete() {
+    if (!this._client) {
+      throw new Error("Cannot delete: File object not associated with a client");
+    }
+    await this._client.delete(this.id);
+  }
+  async download() {
+    if (!this._client) {
+      throw new Error("Cannot download: File object not associated with a client");
+    }
+    const refreshed = await this._client.get(this.id);
+    Object.assign(this, refreshed);
+    if (!this.download_url) {
+      throw new Error("No download URL available");
+    }
+    if (typeof window !== "undefined") {
+      const link = document.createElement("a");
+      link.href = this.download_url;
+      link.download = this.name;
+      link.target = "_blank";
+      document.body.appendChild(link);
+      link.click();
+      document.body.removeChild(link);
+    }
+  }
+};
+
 // src/client.ts
 var BucketClient = class {
   constructor(config) {
@@ -79,7 +142,10 @@ var BucketClient = class {
     __publicField(this, "config");
     this.config = config;
     this.client = import_axios.default.create({
-      baseURL: config.baseUrl || "http://localhost:3000/v1"
+      baseURL: config.baseUrl || "http://localhost:3000/v1",
+      // Enable axios to respect cache headers
+      adapter: "fetch"
+      // Use fetch adapter which respects browser cache
     });
     this.client.interceptors.request.use(async (req) => {
       const token = await Promise.resolve(this.config.getToken());
@@ -105,24 +171,32 @@ var BucketClient = class {
       throw error;
     }
   }
+  wrapFileObject(data) {
+    return new FileObject(data, this);
+  }
   async list(options) {
-    return this.request("POST", `/buckets/${this.config.bucketId}/files/search`, {
+    const response = await this.request("POST", `/buckets/${this.config.bucketId}/files/search`, {
       ...options
     });
+    return {
+      files: response.files.map((f) => this.wrapFileObject(f)),
+      paging: response.paging
+    };
   }
   async get(id) {
     const file = await this.request("GET", `/buckets/${this.config.bucketId}/files/${id}`);
     if (!file.checksum) {
       console.warn(`File ${id} missing checksum`);
     }
-    return file;
+    return this.wrapFileObject(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);
+    const updated = await this.request("PATCH", `/buckets/${this.config.bucketId}/files/${id}`, updates);
+    return this.wrapFileObject(updated);
   }
   async delete(id) {
     await this.request("DELETE", `/buckets/${this.config.bucketId}/files/${id}`);
@@ -149,10 +223,11 @@ var BucketClient = class {
           }
         }
       });
-      const confirmedFile = await this.request("POST", `/buckets/${this.config.bucketId}/files/confirm`, {
+      const confirmedFileData = await this.request("POST", `/buckets/${this.config.bucketId}/files/confirm`, {
         signed_id: uploadInit.sid,
         metadata: options?.metadata
       });
+      const confirmedFile = this.wrapFileObject(confirmedFileData);
       if (options?.onCompleted) {
         options.onCompleted(confirmedFile);
       }
@@ -167,5 +242,6 @@ var BucketClient = class {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  BucketClient
+  BucketClient,
+  FileObject
 });

package/dist/index.mjs

@@ -38,6 +38,68 @@ var calculateChecksum = (file) => {
   });
 };
 
+// src/types.ts
+var FileObject = class {
+  constructor(data, client) {
+    __publicField(this, "id");
+    __publicField(this, "name");
+    __publicField(this, "metadata");
+    __publicField(this, "checksum");
+    __publicField(this, "byte_size");
+    __publicField(this, "content_type");
+    __publicField(this, "download_url");
+    __publicField(this, "created_at");
+    __publicField(this, "updated_at");
+    __publicField(this, "_client");
+    this.id = data.id;
+    this.name = data.name;
+    this.metadata = data.metadata;
+    this.checksum = data.checksum;
+    this.byte_size = data.byte_size;
+    this.content_type = data.content_type;
+    this.download_url = data.download_url;
+    this.created_at = data.created_at;
+    this.updated_at = data.updated_at;
+    this._client = client;
+  }
+  async update(metadata, name) {
+    if (!this._client) {
+      throw new Error("Cannot update: File object not associated with a client");
+    }
+    const updates = {};
+    if (metadata !== void 0) updates.metadata = metadata;
+    if (name !== void 0) updates.filename = name;
+    const updated = await this._client.update(this.id, updates);
+    Object.assign(this, updated);
+    return this;
+  }
+  async delete() {
+    if (!this._client) {
+      throw new Error("Cannot delete: File object not associated with a client");
+    }
+    await this._client.delete(this.id);
+  }
+  async download() {
+    if (!this._client) {
+      throw new Error("Cannot download: File object not associated with a client");
+    }
+    const refreshed = await this._client.get(this.id);
+    Object.assign(this, refreshed);
+    if (!this.download_url) {
+      throw new Error("No download URL available");
+    }
+    if (typeof window !== "undefined") {
+      const link = document.createElement("a");
+      link.href = this.download_url;
+      link.download = this.name;
+      link.target = "_blank";
+      document.body.appendChild(link);
+      link.click();
+      document.body.removeChild(link);
+    }
+  }
+};
+
 // src/client.ts
 var BucketClient = class {
   constructor(config) {
@@ -45,7 +107,10 @@ var BucketClient = class {
     __publicField(this, "config");
     this.config = config;
     this.client = axios.create({
-      baseURL: config.baseUrl || "http://localhost:3000/v1"
+      baseURL: config.baseUrl || "http://localhost:3000/v1",
+      // Enable axios to respect cache headers
+      adapter: "fetch"
+      // Use fetch adapter which respects browser cache
     });
     this.client.interceptors.request.use(async (req) => {
       const token = await Promise.resolve(this.config.getToken());
@@ -71,24 +136,32 @@ var BucketClient = class {
       throw error;
     }
   }
+  wrapFileObject(data) {
+    return new FileObject(data, this);
+  }
   async list(options) {
-    return this.request("POST", `/buckets/${this.config.bucketId}/files/search`, {
+    const response = await this.request("POST", `/buckets/${this.config.bucketId}/files/search`, {
       ...options
     });
+    return {
+      files: response.files.map((f) => this.wrapFileObject(f)),
+      paging: response.paging
+    };
   }
   async get(id) {
     const file = await this.request("GET", `/buckets/${this.config.bucketId}/files/${id}`);
     if (!file.checksum) {
       console.warn(`File ${id} missing checksum`);
     }
-    return file;
+    return this.wrapFileObject(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);
+    const updated = await this.request("PATCH", `/buckets/${this.config.bucketId}/files/${id}`, updates);
+    return this.wrapFileObject(updated);
   }
   async delete(id) {
     await this.request("DELETE", `/buckets/${this.config.bucketId}/files/${id}`);
@@ -115,10 +188,11 @@ var BucketClient = class {
           }
         }
       });
-      const confirmedFile = await this.request("POST", `/buckets/${this.config.bucketId}/files/confirm`, {
+      const confirmedFileData = await this.request("POST", `/buckets/${this.config.bucketId}/files/confirm`, {
         signed_id: uploadInit.sid,
         metadata: options?.metadata
       });
+      const confirmedFile = this.wrapFileObject(confirmedFileData);
       if (options?.onCompleted) {
         options.onCompleted(confirmedFile);
       }
@@ -132,5 +206,6 @@ var BucketClient = class {
   }
 };
 export {
-  BucketClient
+  BucketClient,
+  FileObject
 };

package/package.json

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