@darseen/vaze 1.1.1 → 2.0.0

package/README.md

@@ -61,7 +61,7 @@ The SDK is divided into two main modules: `files` and `folders`. All methods are
 ```ts
 const { data, error } = await vaze.files.getAll({
   limit: 10,
-  orderBy: "created_at",
+  orderBy: "createdAt",
   orderDirection: "DESC",
 });
 
@@ -76,7 +76,7 @@ if (data) {
 const { data, error } = await vaze.files.getById("file-id");
 ```
 
-`getByName(name, options?)` Search for files by name.
+`getByName(name, options?)` Search for files by name. Returns an empty `files` array when nothing matches.
 
 ```ts
 const { data, error } = await vaze.files.getByName("document.pdf", {
@@ -87,8 +87,8 @@ const { data, error } = await vaze.files.getByName("document.pdf", {
 `upload(data)` Upload one or multiple files to your Vaze instance.
 
 - data:
-  - `files` (File[]): An array of standard `File` objects.
-  - `folder?` (string): The ID or name of the target folder.
+  - `files` (File[]): An array of standard web [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) objects.
+  - `folder?` (string): The path of the target folder, created if it doesn't exist.
 
 ```ts
 const { data, error } = await vaze.files.upload({
@@ -97,6 +97,18 @@ const { data, error } = await vaze.files.upload({
 });
 ```
 
+`download(id)` Download a file's contents by its ID.
+
+```ts
+const { data, error } = await vaze.files.download("file-id-123");
+
+if (data) {
+  console.log(data.filename); // original file name
+  console.log(data.contentType); // e.g. "image/png"
+  const buffer = Buffer.from(await data.blob.arrayBuffer());
+}
+```
+
 `rename(data)` Rename an existing file.
 
 - data:
@@ -120,7 +132,7 @@ Folders API Access folder-related methods via `vaze.folders`. `get(options?)` Re
 
 - options (optional):
   - `id`
-  - `path` example: "projects/work"
+  - `key` example: "projects/work"
   - `limit`
   - `offset`
   - `orderBy`
@@ -128,7 +140,7 @@ Folders API Access folder-related methods via `vaze.folders`. `get(options?)` Re
 
 ```ts
 const { data, error } = await vaze.folders.get({
-  path: "/documents/work",
+  key: "documents/work",
   limit: 20,
 });
 
@@ -165,6 +177,18 @@ const { data, error } = await vaze.folders.rename({
 const { data, error } = await vaze.folders.delete("folder-id");
 ```
 
+# Health Check
+
+`vaze.health()` pings the instance to verify connectivity.
+
+```ts
+const { data, error } = await vaze.health();
+
+if (data) {
+  console.log(data.message); // "Vaze is running!"
+}
+```
+
 # Types
 
-This SDK is built with TypeScript and exports all necessary types to ensure type safety in your applications. Types such as `FileWithUrl`, `Folder`, and `ApiResponse`.
+This SDK is built with TypeScript and exports all necessary types to ensure type safety in your applications. Types such as `File`, `Folder`, `ApiResponse`, `ListOptions`, and `VazeOptions`.

package/dist/index.cjs

@@ -1,4 +1,28 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/base.ts
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }// src/utils/index.ts
+function constructFileUrls({
+  vazeUrl,
+  files
+}) {
+  const base = vazeUrl.endsWith("/") ? vazeUrl : `${vazeUrl}/`;
+  return files.map((file) => ({
+    ...file,
+    url: new URL(file.url, base).toString()
+  }));
+}
+function parseContentDispositionFilename(header) {
+  if (!header) return null;
+  const utf8Match = header.match(/filename\*=UTF-8''([^;]+)/i);
+  if (_optionalChain([utf8Match, 'optionalAccess', _ => _[1]])) {
+    try {
+      return decodeURIComponent(utf8Match[1]);
+    } catch (e) {
+    }
+  }
+  const plainMatch = header.match(/filename="([^"]*)"/i);
+  return _nullishCoalesce(_optionalChain([plainMatch, 'optionalAccess', _2 => _2[1]]), () => ( null));
+}
+
+// src/base.ts
 var Base = class {
   
   
@@ -16,7 +40,16 @@ var Base = class {
       );
     }
     this.apiKey = apiKey;
-    this.vazeUrl = vazeUrl;
+    this.vazeUrl = vazeUrl.endsWith("/") ? vazeUrl : `${vazeUrl}/`;
+  }
+  apiUrl(path, params) {
+    const url = new URL(path.replace(/^\//, ""), this.vazeUrl);
+    if (params) {
+      for (const [key, value] of Object.entries(params)) {
+        if (value !== void 0) url.searchParams.set(key, String(value));
+      }
+    }
+    return url.toString();
   }
   async request(method, url, body, headers) {
     try {
@@ -25,50 +58,84 @@ var Base = class {
         ...headers
       };
       const isFormData = body instanceof FormData;
-      if (!isFormData && !fetchHeaders["Content-Type"]) {
+      if (body !== void 0 && !isFormData && !fetchHeaders["Content-Type"]) {
         fetchHeaders["Content-Type"] = "application/json";
       }
       const response = await fetch(url, {
         method,
         headers: fetchHeaders,
-        body: isFormData ? body : JSON.stringify(body)
+        body: isFormData ? body : body !== void 0 ? JSON.stringify(body) : null
+      });
+      const contentType = _nullishCoalesce(response.headers.get("content-type"), () => ( ""));
+      if (!contentType.includes("application/json")) {
+        return {
+          data: null,
+          error: {
+            message: `Unexpected non-JSON response from server (status ${response.status}).`
+          }
+        };
+      }
+      const result = await response.json();
+      if (!response.ok && !result.error) {
+        return {
+          data: null,
+          error: { message: `Request failed with status ${response.status}.` }
+        };
+      }
+      return result;
+    } catch (error) {
+      return {
+        data: null,
+        error: {
+          message: error instanceof Error ? error.message : "An error occurred while making the request."
+        }
+      };
+    }
+  }
+  async requestBlob(url) {
+    try {
+      const response = await fetch(url, {
+        headers: { "API-Key": this.apiKey }
       });
-      return await response.json();
+      const contentType = _nullishCoalesce(response.headers.get("content-type"), () => ( ""));
+      if (!response.ok) {
+        if (contentType.includes("application/json")) {
+          const result = await response.json();
+          if (result.error) return { data: null, error: result.error };
+        }
+        return {
+          data: null,
+          error: { message: `Request failed with status ${response.status}.` }
+        };
+      }
+      return {
+        data: {
+          blob: await response.blob(),
+          filename: parseContentDispositionFilename(
+            response.headers.get("content-disposition")
+          ),
+          contentType
+        },
+        error: null
+      };
     } catch (error) {
-      console.log("Request error:", error);
       return {
         data: null,
         error: {
-          message: "An error occurred while making the request."
+          message: error instanceof Error ? error.message : "An error occurred while making the request."
         }
       };
     }
   }
 };
 
-// src/utils/index.ts
-function constructFileUrls({
-  vazeUrl,
-  files
-}) {
-  return files.map((file) => ({
-    ...file,
-    url: `${vazeUrl}/${file.url}`
-  }));
-}
-
 // src/files.ts
 var Files = class extends Base {
   async getAll(options) {
-    const url = new URL("/api/files", this.vazeUrl);
-    if (options) {
-      for (const [key, value] of Object.entries(options)) {
-        url.searchParams.set(key, value.toString());
-      }
-    }
+    const url = this.apiUrl("/api/files", options);
     const { error, data } = await this.request(
       "GET",
-      url.toString()
+      url
     );
     return {
       error,
@@ -81,11 +148,26 @@ var Files = class extends Base {
     };
   }
   async getById(id) {
-    const url = new URL(`/api/files`, this.vazeUrl);
-    url.searchParams.set("id", id);
+    const url = this.apiUrl("/api/files", { id });
+    const { data, error } = await this.request(
+      "GET",
+      url
+    );
+    return {
+      error,
+      data: data ? {
+        file: constructFileUrls({
+          vazeUrl: this.vazeUrl,
+          files: [data.file]
+        })[0]
+      } : null
+    };
+  }
+  async getByKey(key) {
+    const url = this.apiUrl("/api/files", { key });
     const { data, error } = await this.request(
       "GET",
-      url.toString()
+      url
     );
     return {
       error,
@@ -98,16 +180,10 @@ var Files = class extends Base {
     };
   }
   async getByName(name, options) {
-    const url = new URL(`/api/files`, this.vazeUrl);
-    url.searchParams.set("name", name);
-    if (options) {
-      for (const [key, value] of Object.entries(options)) {
-        url.searchParams.set(key, value.toString());
-      }
-    }
+    const url = this.apiUrl("/api/files", { name, ...options });
     const { error, data } = await this.request(
       "GET",
-      url.toString()
+      url
     );
     return {
       error,
@@ -121,17 +197,13 @@ var Files = class extends Base {
   }
   async upload(data) {
     const { files, folder } = data;
-    const url = new URL("/api/files", this.vazeUrl);
+    const url = this.apiUrl("/api/files");
     const formData = new FormData();
     if (folder) formData.append("folder", folder);
     files.forEach((file) => {
       formData.append("files", file);
     });
-    const { error, data: responseData } = await this.request(
-      "POST",
-      url.toString(),
-      formData
-    );
+    const { error, data: responseData } = await this.request("POST", url, formData);
     return {
       error,
       data: responseData ? {
@@ -142,26 +214,25 @@ var Files = class extends Base {
       } : null
     };
   }
+  async download(id) {
+    const url = this.apiUrl(`/api/files/download/${encodeURIComponent(id)}`);
+    return await this.requestBlob(url);
+  }
   async rename(data) {
-    const url = new URL(`/api/files`, this.vazeUrl);
-    return await this.request("PUT", url.toString(), data);
+    return await this.request("PUT", this.apiUrl("/api/files"), data);
   }
   async delete(id) {
-    const url = new URL(`/api/files`, this.vazeUrl);
-    return await this.request("DELETE", url.toString(), { id });
+    return await this.request("DELETE", this.apiUrl("/api/files"), {
+      id
+    });
   }
 };
 
 // src/folders.ts
 var Folders = class extends Base {
   async get(options) {
-    const url = new URL("/api/folders", this.vazeUrl);
-    if (options) {
-      for (const [key, value] of Object.entries(options)) {
-        url.searchParams.set(key, value.toString());
-      }
-    }
-    const { error, data } = await this.request("GET", url.toString());
+    const url = this.apiUrl("/api/folders", options);
+    const { error, data } = await this.request("GET", url);
     return {
       error,
       data: data ? {
@@ -174,18 +245,19 @@ var Folders = class extends Base {
     };
   }
   async create(folder) {
-    const url = new URL("/api/folders", this.vazeUrl);
-    return await this.request("POST", url.toString(), {
-      folder
-    });
+    return await this.request(
+      "POST",
+      this.apiUrl("/api/folders"),
+      { folder }
+    );
   }
   async rename(data) {
-    const url = new URL("/api/folders", this.vazeUrl);
-    return await this.request("PUT", url.toString(), data);
+    return await this.request("PUT", this.apiUrl("/api/folders"), data);
   }
   async delete(id) {
-    const url = new URL("/api/folders", this.vazeUrl);
-    return await this.request("DELETE", url.toString(), { id });
+    return await this.request("DELETE", this.apiUrl("/api/folders"), {
+      id
+    });
   }
 };
 
@@ -195,8 +267,14 @@ var Vaze = class extends Base {
   
   constructor(options = {}) {
     super(options);
-    this.files = new Files();
-    this.folders = new Folders();
+    this.files = new Files(options);
+    this.folders = new Folders(options);
+  }
+  async health() {
+    return await this.request(
+      "GET",
+      this.apiUrl("/api/health")
+    );
   }
 };