@darseen/vaze 2.0.0 → 2.2.0

package/README.md

@@ -109,6 +109,17 @@ if (data) {
 }
 ```
 
+`downloadMany(ids)` Download several files as one zip. Entries keep their paths below the folder the files share.
+
+```ts
+const { data, error } = await vaze.files.downloadMany(["file-id-123", "file-id-456"]);
+
+if (data) {
+  console.log(data.filename); // e.g. "photos.zip"
+  const buffer = Buffer.from(await data.blob.arrayBuffer());
+}
+```
+
 `rename(data)` Rename an existing file.
 
 - data:
@@ -171,6 +182,17 @@ const { data, error } = await vaze.folders.rename({
 });
 ```
 
+`download(options?)` Download a folder and everything below it as one zip. With no `id` or `key`, the root folder is archived.
+
+```ts
+const { data, error } = await vaze.folders.download({ key: "projects/work" });
+
+if (data) {
+  console.log(data.filename); // "work.zip", with every entry under work/
+  const buffer = Buffer.from(await data.blob.arrayBuffer());
+}
+```
+
 `delete(id)` Delete a folder by its ID.
 
 ```ts

package/dist/index.cjs

@@ -92,10 +92,14 @@ var Base = class {
       };
     }
   }
-  async requestBlob(url) {
+  async requestBlob(url, method = "GET", body) {
     try {
+      const headers = { "API-Key": this.apiKey };
+      if (body !== void 0) headers["Content-Type"] = "application/json";
       const response = await fetch(url, {
-        headers: { "API-Key": this.apiKey }
+        method,
+        headers,
+        body: body !== void 0 ? JSON.stringify(body) : null
       });
       const contentType = _nullishCoalesce(response.headers.get("content-type"), () => ( ""));
       if (!response.ok) {
@@ -196,10 +200,11 @@ var Files = class extends Base {
     };
   }
   async upload(data) {
-    const { files, folder } = data;
+    const { files, folder, visibility } = data;
     const url = this.apiUrl("/api/files");
     const formData = new FormData();
     if (folder) formData.append("folder", folder);
+    if (visibility) formData.append("visibility", visibility);
     files.forEach((file) => {
       formData.append("files", file);
     });
@@ -218,14 +223,43 @@ var Files = class extends Base {
     const url = this.apiUrl(`/api/files/download/${encodeURIComponent(id)}`);
     return await this.requestBlob(url);
   }
+  /** Download several files as one zip, with paths below their shared folder. */
+  async downloadMany(ids) {
+    return await this.requestBlob(this.apiUrl("/api/files/download"), "POST", {
+      ids
+    });
+  }
   async rename(data) {
     return await this.request("PUT", this.apiUrl("/api/files"), data);
   }
+  async setVisibility(data) {
+    return await this.request("PUT", this.apiUrl("/api/files"), data);
+  }
+  /** Mint a time-limited URL that reads a file without an API key. */
+  async sign(options) {
+    const { data, error } = await this.request(
+      "POST",
+      this.apiUrl("/api/files/sign"),
+      options
+    );
+    return {
+      error,
+      data: data ? { ...data, url: new URL(data.url, this.vazeUrl).toString() } : null
+    };
+  }
   async delete(id) {
     return await this.request("DELETE", this.apiUrl("/api/files"), {
       id
     });
   }
+  /** Delete several files in one request; each id reports its own outcome. */
+  async deleteMany(ids) {
+    return await this.request(
+      "DELETE",
+      this.apiUrl("/api/files"),
+      { ids }
+    );
+  }
 };
 
 // src/folders.ts
@@ -244,6 +278,12 @@ var Folders = class extends Base {
       } : null
     };
   }
+  /** Download a folder and everything below it as a zip; the root by default. */
+  async download(options) {
+    return await this.requestBlob(
+      this.apiUrl("/api/folders/download", options)
+    );
+  }
   async create(folder) {
     return await this.request(
       "POST",
@@ -254,6 +294,10 @@ var Folders = class extends Base {
   async rename(data) {
     return await this.request("PUT", this.apiUrl("/api/folders"), data);
   }
+  /** Apply a visibility to every file at or below this folder. */
+  async setVisibility(data) {
+    return await this.request("PUT", this.apiUrl("/api/folders"), data);
+  }
   async delete(id) {
     return await this.request("DELETE", this.apiUrl("/api/folders"), {
       id

package/dist/index.d.cts

@@ -568,10 +568,30 @@ declare const files: SQLiteTableWithColumns<{
             identity: undefined;
             generated: undefined;
         }, {}, {}>;
+        visibility: SQLiteColumn<{
+            name: "visibility";
+            tableName: "files";
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: "public" | "private";
+            driverParam: string;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: ["public", "private"];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {
+            length: number | undefined;
+        }>;
     };
     dialect: "sqlite";
 }>;
 type File$1 = InferSelectModel<typeof files>;
+type Visibility = File$1["visibility"];
 
 declare const folders: SQLiteTableWithColumns<{
     name: "folders";
@@ -745,6 +765,7 @@ declare class Files extends Base {
     upload(data: {
         files: File[];
         folder?: string;
+        visibility?: Visibility;
     }): Promise<{
         error: {
             message: string;
@@ -758,11 +779,33 @@ declare class Files extends Base {
         filename: string | null;
         contentType: string;
     }>>;
+    /** Download several files as one zip, with paths below their shared folder. */
+    downloadMany(ids: string[]): Promise<ApiResponse<{
+        blob: Blob;
+        filename: string | null;
+        contentType: string;
+    }>>;
     rename(data: {
         id: string;
         name: string;
     }): Promise<ApiResponse<null>>;
+    setVisibility(data: {
+        id: string;
+        visibility: Visibility;
+    }): Promise<ApiResponse<null>>;
+    /** Mint a time-limited URL that reads a file without an API key. */
+    sign(options: SignOptions): Promise<{
+        error: {
+            message: string;
+        } | null;
+        data: {
+            url: string;
+            expiresAt: string;
+        } | null;
+    }>;
     delete(id: string): Promise<ApiResponse<null>>;
+    /** Delete several files in one request; each id reports its own outcome. */
+    deleteMany(ids: string[]): Promise<ApiResponse<BulkDeleteResult>>;
 }
 
 declare class Folders extends Base {
@@ -779,6 +822,15 @@ declare class Folders extends Base {
             folders: Folder[];
         } | null;
     }>;
+    /** Download a folder and everything below it as a zip; the root by default. */
+    download(options?: {
+        id?: string;
+        key?: string;
+    }): Promise<ApiResponse<{
+        blob: Blob;
+        filename: string | null;
+        contentType: string;
+    }>>;
     create(folder: string): Promise<ApiResponse<{
         folder: Folder;
     }>>;
@@ -786,6 +838,11 @@ declare class Folders extends Base {
         id: string;
         name: string;
     }): Promise<ApiResponse<null>>;
+    /** Apply a visibility to every file at or below this folder. */
+    setVisibility(data: {
+        id: string;
+        visibility: Visibility;
+    }): Promise<ApiResponse<null>>;
     delete(id: string): Promise<ApiResponse<null>>;
 }
 
@@ -803,6 +860,23 @@ type ListOptions = {
     orderBy?: "createdAt" | "updatedAt" | "name" | "size";
     orderDirection?: "ASC" | "DESC";
 };
+type SignOptions = {
+    id?: string;
+    key?: string;
+    /** Seconds the link stays valid. Capped server-side, default one hour. */
+    expiresIn?: number;
+};
+type SignedUrl = {
+    url: string;
+    expiresAt: string;
+};
+type BulkDeleteResult = {
+    deleted: string[];
+    failed: {
+        id: string;
+        message: string;
+    }[];
+};
 
 declare class Base {
     private apiKey;
@@ -810,7 +884,7 @@ declare class Base {
     constructor(options?: VazeOptions);
     protected apiUrl(path: string, params?: Record<string, string | number | undefined>): string;
     protected request<T>(method: string, url: string, body?: Record<string, any> | FormData, headers?: Record<string, string>): Promise<ApiResponse<T>>;
-    protected requestBlob(url: string): Promise<ApiResponse<{
+    protected requestBlob(url: string, method?: string, body?: Record<string, any>): Promise<ApiResponse<{
         blob: Blob;
         filename: string | null;
         contentType: string;
@@ -826,4 +900,4 @@ declare class Vaze extends Base implements IVaze {
     }>>;
 }
 
-export { type ApiResponse, type FileWithUrl as File, type Folder, type ListOptions, type VazeOptions, Vaze as default };
+export { type ApiResponse, type BulkDeleteResult, type FileWithUrl as File, type Folder, type ListOptions, type SignOptions, type SignedUrl, type VazeOptions, type Visibility, Vaze as default };

package/dist/index.d.ts

@@ -568,10 +568,30 @@ declare const files: SQLiteTableWithColumns<{
             identity: undefined;
             generated: undefined;
         }, {}, {}>;
+        visibility: SQLiteColumn<{
+            name: "visibility";
+            tableName: "files";
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: "public" | "private";
+            driverParam: string;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: ["public", "private"];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {
+            length: number | undefined;
+        }>;
     };
     dialect: "sqlite";
 }>;
 type File$1 = InferSelectModel<typeof files>;
+type Visibility = File$1["visibility"];
 
 declare const folders: SQLiteTableWithColumns<{
     name: "folders";
@@ -745,6 +765,7 @@ declare class Files extends Base {
     upload(data: {
         files: File[];
         folder?: string;
+        visibility?: Visibility;
     }): Promise<{
         error: {
             message: string;
@@ -758,11 +779,33 @@ declare class Files extends Base {
         filename: string | null;
         contentType: string;
     }>>;
+    /** Download several files as one zip, with paths below their shared folder. */
+    downloadMany(ids: string[]): Promise<ApiResponse<{
+        blob: Blob;
+        filename: string | null;
+        contentType: string;
+    }>>;
     rename(data: {
         id: string;
         name: string;
     }): Promise<ApiResponse<null>>;
+    setVisibility(data: {
+        id: string;
+        visibility: Visibility;
+    }): Promise<ApiResponse<null>>;
+    /** Mint a time-limited URL that reads a file without an API key. */
+    sign(options: SignOptions): Promise<{
+        error: {
+            message: string;
+        } | null;
+        data: {
+            url: string;
+            expiresAt: string;
+        } | null;
+    }>;
     delete(id: string): Promise<ApiResponse<null>>;
+    /** Delete several files in one request; each id reports its own outcome. */
+    deleteMany(ids: string[]): Promise<ApiResponse<BulkDeleteResult>>;
 }
 
 declare class Folders extends Base {
@@ -779,6 +822,15 @@ declare class Folders extends Base {
             folders: Folder[];
         } | null;
     }>;
+    /** Download a folder and everything below it as a zip; the root by default. */
+    download(options?: {
+        id?: string;
+        key?: string;
+    }): Promise<ApiResponse<{
+        blob: Blob;
+        filename: string | null;
+        contentType: string;
+    }>>;
     create(folder: string): Promise<ApiResponse<{
         folder: Folder;
     }>>;
@@ -786,6 +838,11 @@ declare class Folders extends Base {
         id: string;
         name: string;
     }): Promise<ApiResponse<null>>;
+    /** Apply a visibility to every file at or below this folder. */
+    setVisibility(data: {
+        id: string;
+        visibility: Visibility;
+    }): Promise<ApiResponse<null>>;
     delete(id: string): Promise<ApiResponse<null>>;
 }
 
@@ -803,6 +860,23 @@ type ListOptions = {
     orderBy?: "createdAt" | "updatedAt" | "name" | "size";
     orderDirection?: "ASC" | "DESC";
 };
+type SignOptions = {
+    id?: string;
+    key?: string;
+    /** Seconds the link stays valid. Capped server-side, default one hour. */
+    expiresIn?: number;
+};
+type SignedUrl = {
+    url: string;
+    expiresAt: string;
+};
+type BulkDeleteResult = {
+    deleted: string[];
+    failed: {
+        id: string;
+        message: string;
+    }[];
+};
 
 declare class Base {
     private apiKey;
@@ -810,7 +884,7 @@ declare class Base {
     constructor(options?: VazeOptions);
     protected apiUrl(path: string, params?: Record<string, string | number | undefined>): string;
     protected request<T>(method: string, url: string, body?: Record<string, any> | FormData, headers?: Record<string, string>): Promise<ApiResponse<T>>;
-    protected requestBlob(url: string): Promise<ApiResponse<{
+    protected requestBlob(url: string, method?: string, body?: Record<string, any>): Promise<ApiResponse<{
         blob: Blob;
         filename: string | null;
         contentType: string;
@@ -826,4 +900,4 @@ declare class Vaze extends Base implements IVaze {
     }>>;
 }
 
-export { type ApiResponse, type FileWithUrl as File, type Folder, type ListOptions, type VazeOptions, Vaze as default };
+export { type ApiResponse, type BulkDeleteResult, type FileWithUrl as File, type Folder, type ListOptions, type SignOptions, type SignedUrl, type VazeOptions, type Visibility, Vaze as default };

package/dist/index.js

@@ -92,10 +92,14 @@ var Base = class {
       };
     }
   }
-  async requestBlob(url) {
+  async requestBlob(url, method = "GET", body) {
     try {
+      const headers = { "API-Key": this.apiKey };
+      if (body !== void 0) headers["Content-Type"] = "application/json";
       const response = await fetch(url, {
-        headers: { "API-Key": this.apiKey }
+        method,
+        headers,
+        body: body !== void 0 ? JSON.stringify(body) : null
       });
       const contentType = response.headers.get("content-type") ?? "";
       if (!response.ok) {
@@ -196,10 +200,11 @@ var Files = class extends Base {
     };
   }
   async upload(data) {
-    const { files, folder } = data;
+    const { files, folder, visibility } = data;
     const url = this.apiUrl("/api/files");
     const formData = new FormData();
     if (folder) formData.append("folder", folder);
+    if (visibility) formData.append("visibility", visibility);
     files.forEach((file) => {
       formData.append("files", file);
     });
@@ -218,14 +223,43 @@ var Files = class extends Base {
     const url = this.apiUrl(`/api/files/download/${encodeURIComponent(id)}`);
     return await this.requestBlob(url);
   }
+  /** Download several files as one zip, with paths below their shared folder. */
+  async downloadMany(ids) {
+    return await this.requestBlob(this.apiUrl("/api/files/download"), "POST", {
+      ids
+    });
+  }
   async rename(data) {
     return await this.request("PUT", this.apiUrl("/api/files"), data);
   }
+  async setVisibility(data) {
+    return await this.request("PUT", this.apiUrl("/api/files"), data);
+  }
+  /** Mint a time-limited URL that reads a file without an API key. */
+  async sign(options) {
+    const { data, error } = await this.request(
+      "POST",
+      this.apiUrl("/api/files/sign"),
+      options
+    );
+    return {
+      error,
+      data: data ? { ...data, url: new URL(data.url, this.vazeUrl).toString() } : null
+    };
+  }
   async delete(id) {
     return await this.request("DELETE", this.apiUrl("/api/files"), {
       id
     });
   }
+  /** Delete several files in one request; each id reports its own outcome. */
+  async deleteMany(ids) {
+    return await this.request(
+      "DELETE",
+      this.apiUrl("/api/files"),
+      { ids }
+    );
+  }
 };
 
 // src/folders.ts
@@ -244,6 +278,12 @@ var Folders = class extends Base {
       } : null
     };
   }
+  /** Download a folder and everything below it as a zip; the root by default. */
+  async download(options) {
+    return await this.requestBlob(
+      this.apiUrl("/api/folders/download", options)
+    );
+  }
   async create(folder) {
     return await this.request(
       "POST",
@@ -254,6 +294,10 @@ var Folders = class extends Base {
   async rename(data) {
     return await this.request("PUT", this.apiUrl("/api/folders"), data);
   }
+  /** Apply a visibility to every file at or below this folder. */
+  async setVisibility(data) {
+    return await this.request("PUT", this.apiUrl("/api/folders"), data);
+  }
   async delete(id) {
     return await this.request("DELETE", this.apiUrl("/api/folders"), {
       id

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@darseen/vaze",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "description": "Vaze Self-Hosted file storage and hosting service SDK.",
   "keywords": [
     "api",
@@ -42,10 +42,10 @@
     "dist"
   ],
   "devDependencies": {
-    "@types/node": "^25.5.0",
+    "@repo/types": "1.0.0",
+    "@types/node": "^26.6.2",
     "rimraf": "^6.1.3",
-    "tsup": "^8.5.1",
-    "@repo/types": "1.0.0"
+    "tsup": "^8.5.1"
   },
   "scripts": {
     "lint": "tsc --noEmit",