@plugable-io/js 0.0.1

package/dist/index.d.mts

@@ -0,0 +1,53 @@
+interface BucketClientConfig {
+    bucketId: string;
+    getToken: () => Promise<string> | string;
+    baseUrl?: string;
+}
+interface FileObject {
+    id: string;
+    name: string;
+    metadata: Record<string, any>;
+    checksum: string;
+    byte_size: number;
+    content_type: string;
+    download_url?: string;
+    created_at: string;
+    updated_at: string;
+}
+interface ListResponse {
+    files: FileObject[];
+    paging: {
+        has_next_page: boolean;
+        has_previous_page: boolean;
+        current_page: number;
+    };
+}
+interface SearchOptions {
+    media_type?: string;
+    metadata?: Record<string, any>;
+    page?: number;
+    per_page?: number;
+    with_download_url?: boolean;
+}
+interface UploadOptions {
+    metadata?: Record<string, any>;
+    onProgress?: (progress: number) => void;
+}
+interface UpdateOptions {
+    filename?: string;
+    metadata?: Record<string, any>;
+}
+
+declare class BucketClient {
+    private client;
+    private config;
+    constructor(config: BucketClientConfig);
+    private request;
+    list(options?: SearchOptions): Promise<ListResponse>;
+    get(id: string): Promise<FileObject>;
+    update(id: string, updates: UpdateOptions): Promise<FileObject>;
+    delete(id: string): Promise<void>;
+    upload(file: File, options?: UploadOptions): Promise<FileObject>;
+}
+
+export { BucketClient, type BucketClientConfig, type FileObject, type ListResponse, type SearchOptions, type UpdateOptions, type UploadOptions };

package/dist/index.d.ts

@@ -0,0 +1,53 @@
+interface BucketClientConfig {
+    bucketId: string;
+    getToken: () => Promise<string> | string;
+    baseUrl?: string;
+}
+interface FileObject {
+    id: string;
+    name: string;
+    metadata: Record<string, any>;
+    checksum: string;
+    byte_size: number;
+    content_type: string;
+    download_url?: string;
+    created_at: string;
+    updated_at: string;
+}
+interface ListResponse {
+    files: FileObject[];
+    paging: {
+        has_next_page: boolean;
+        has_previous_page: boolean;
+        current_page: number;
+    };
+}
+interface SearchOptions {
+    media_type?: string;
+    metadata?: Record<string, any>;
+    page?: number;
+    per_page?: number;
+    with_download_url?: boolean;
+}
+interface UploadOptions {
+    metadata?: Record<string, any>;
+    onProgress?: (progress: number) => void;
+}
+interface UpdateOptions {
+    filename?: string;
+    metadata?: Record<string, any>;
+}
+
+declare class BucketClient {
+    private client;
+    private config;
+    constructor(config: BucketClientConfig);
+    private request;
+    list(options?: SearchOptions): Promise<ListResponse>;
+    get(id: string): Promise<FileObject>;
+    update(id: string, updates: UpdateOptions): Promise<FileObject>;
+    delete(id: string): Promise<void>;
+    upload(file: File, options?: UploadOptions): Promise<FileObject>;
+}
+
+export { BucketClient, type BucketClientConfig, type FileObject, type ListResponse, type SearchOptions, type UpdateOptions, type UploadOptions };

package/dist/index.js

@@ -0,0 +1,152 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  BucketClient: () => BucketClient
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/client.ts
+var import_axios = __toESM(require("axios"));
+
+// src/utils.ts
+var import_spark_md5 = __toESM(require("spark-md5"));
+var calculateChecksum = (file) => {
+  return new Promise((resolve, reject) => {
+    const blobSlice = File.prototype.slice || File.prototype.mozSlice || File.prototype.webkitSlice;
+    const chunkSize = 2097152;
+    const chunks = Math.ceil(file.size / chunkSize);
+    const spark = new import_spark_md5.default.ArrayBuffer();
+    const fileReader = new FileReader();
+    let currentChunk = 0;
+    fileReader.onload = function(e) {
+      spark.append(e.target?.result);
+      currentChunk++;
+      if (currentChunk < chunks) {
+        loadNext();
+      } else {
+        const md5Hash = spark.end(true);
+        const base64Hash = btoa(md5Hash);
+        resolve(base64Hash);
+      }
+    };
+    fileReader.onerror = function() {
+      reject(new Error("Failed to read file for checksum calculation."));
+    };
+    function loadNext() {
+      const start = currentChunk * chunkSize;
+      const end = start + chunkSize >= file.size ? file.size : start + chunkSize;
+      fileReader.readAsArrayBuffer(blobSlice.call(file, start, end));
+    }
+    loadNext();
+  });
+};
+
+// src/client.ts
+var BucketClient = class {
+  constructor(config) {
+    __publicField(this, "client");
+    __publicField(this, "config");
+    this.config = config;
+    this.client = import_axios.default.create({
+      baseURL: config.baseUrl || "http://localhost:3000/v1"
+    });
+    this.client.interceptors.request.use(async (req) => {
+      const token = await Promise.resolve(this.config.getToken());
+      if (token) {
+        req.headers.Authorization = `Bearer ${token}`;
+      }
+      return req;
+    });
+  }
+  async request(method, url, data, params) {
+    try {
+      const response = await this.client.request({
+        method,
+        url,
+        data,
+        params
+      });
+      return response.data;
+    } catch (error) {
+      if (error.response) {
+        throw new Error(`API Error: ${error.response.status} - ${JSON.stringify(error.response.data)}`);
+      }
+      throw error;
+    }
+  }
+  async list(options) {
+    return this.request("POST", `/buckets/${this.config.bucketId}/files/search`, {
+      ...options
+    });
+  }
+  async get(id) {
+    return this.request("GET", `/buckets/${this.config.bucketId}/files/${id}`);
+  }
+  async update(id, updates) {
+    return this.request("PATCH", `/buckets/${this.config.bucketId}/files/${id}`, updates);
+  }
+  async delete(id) {
+    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);
+        }
+      }
+    });
+    return this.request("POST", `/buckets/${this.config.bucketId}/files/confirm`, {
+      signed_id: uploadInit.sid,
+      metadata: options?.metadata
+    });
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BucketClient
+});

package/dist/index.mjs

@@ -0,0 +1,117 @@
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+
+// src/client.ts
+import axios from "axios";
+
+// src/utils.ts
+import SparkMD5 from "spark-md5";
+var calculateChecksum = (file) => {
+  return new Promise((resolve, reject) => {
+    const blobSlice = File.prototype.slice || File.prototype.mozSlice || File.prototype.webkitSlice;
+    const chunkSize = 2097152;
+    const chunks = Math.ceil(file.size / chunkSize);
+    const spark = new SparkMD5.ArrayBuffer();
+    const fileReader = new FileReader();
+    let currentChunk = 0;
+    fileReader.onload = function(e) {
+      spark.append(e.target?.result);
+      currentChunk++;
+      if (currentChunk < chunks) {
+        loadNext();
+      } else {
+        const md5Hash = spark.end(true);
+        const base64Hash = btoa(md5Hash);
+        resolve(base64Hash);
+      }
+    };
+    fileReader.onerror = function() {
+      reject(new Error("Failed to read file for checksum calculation."));
+    };
+    function loadNext() {
+      const start = currentChunk * chunkSize;
+      const end = start + chunkSize >= file.size ? file.size : start + chunkSize;
+      fileReader.readAsArrayBuffer(blobSlice.call(file, start, end));
+    }
+    loadNext();
+  });
+};
+
+// src/client.ts
+var BucketClient = class {
+  constructor(config) {
+    __publicField(this, "client");
+    __publicField(this, "config");
+    this.config = config;
+    this.client = axios.create({
+      baseURL: config.baseUrl || "http://localhost:3000/v1"
+    });
+    this.client.interceptors.request.use(async (req) => {
+      const token = await Promise.resolve(this.config.getToken());
+      if (token) {
+        req.headers.Authorization = `Bearer ${token}`;
+      }
+      return req;
+    });
+  }
+  async request(method, url, data, params) {
+    try {
+      const response = await this.client.request({
+        method,
+        url,
+        data,
+        params
+      });
+      return response.data;
+    } catch (error) {
+      if (error.response) {
+        throw new Error(`API Error: ${error.response.status} - ${JSON.stringify(error.response.data)}`);
+      }
+      throw error;
+    }
+  }
+  async list(options) {
+    return this.request("POST", `/buckets/${this.config.bucketId}/files/search`, {
+      ...options
+    });
+  }
+  async get(id) {
+    return this.request("GET", `/buckets/${this.config.bucketId}/files/${id}`);
+  }
+  async update(id, updates) {
+    return this.request("PATCH", `/buckets/${this.config.bucketId}/files/${id}`, updates);
+  }
+  async delete(id) {
+    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);
+        }
+      }
+    });
+    return this.request("POST", `/buckets/${this.config.bucketId}/files/confirm`, {
+      signed_id: uploadInit.sid,
+      metadata: options?.metadata
+    });
+  }
+};
+export {
+  BucketClient
+};

package/package.json

@@ -0,0 +1,29 @@
+{
+    "name": "@plugable-io/js",
+    "version": "0.0.1",
+    "description": "JavaScript client for Plugable File Management API",
+    "main": "dist/index.js",
+    "module": "dist/index.mjs",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "build": "tsup src/index.ts --format cjs,esm --dts",
+        "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+        "lint": "tsc --noEmit"
+    },
+    "keywords": [],
+    "author": "",
+    "license": "MIT",
+    "dependencies": {
+        "axios": "^1.7.0",
+        "spark-md5": "^3.0.2"
+    },
+    "devDependencies": {
+        "@types/node": "^20.0.0",
+        "@types/spark-md5": "^3.0.4",
+        "tsup": "^8.0.0",
+        "typescript": "^5.0.0"
+    }
+}