@darseen/vaze 1.2.1 → 2.1.0

package/README.md

@@ -132,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`
@@ -140,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,
 });
 

package/dist/index.cjs

@@ -163,6 +163,22 @@ var Files = class extends Base {
       } : null
     };
   }
+  async getByKey(key) {
+    const url = this.apiUrl("/api/files", { key });
+    const { data, error } = await this.request(
+      "GET",
+      url
+    );
+    return {
+      error,
+      data: data ? {
+        file: constructFileUrls({
+          vazeUrl: this.vazeUrl,
+          files: [data.file]
+        })[0]
+      } : null
+    };
+  }
   async getByName(name, options) {
     const url = this.apiUrl("/api/files", { name, ...options });
     const { error, data } = await this.request(
@@ -180,10 +196,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);
     });
@@ -205,6 +222,21 @@ var Files = class extends Base {
   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
@@ -238,6 +270,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

@@ -494,8 +494,8 @@ declare const files: SQLiteTableWithColumns<{
         }, {}, {
             length: number | undefined;
         }>;
-        type: SQLiteColumn<{
-            name: "type";
+        key: SQLiteColumn<{
+            name: "key";
             tableName: "files";
             dataType: "string";
             columnType: "SQLiteText";
@@ -513,8 +513,8 @@ declare const files: SQLiteTableWithColumns<{
         }, {}, {
             length: number | undefined;
         }>;
-        path: SQLiteColumn<{
-            name: "path";
+        mimeType: SQLiteColumn<{
+            name: "mime_type";
             tableName: "files";
             dataType: "string";
             columnType: "SQLiteText";
@@ -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";
@@ -653,8 +673,8 @@ declare const folders: SQLiteTableWithColumns<{
         }, {}, {
             length: number | undefined;
         }>;
-        path: SQLiteColumn<{
-            name: "path";
+        key: SQLiteColumn<{
+            name: "key";
             tableName: "folders";
             dataType: "string";
             columnType: "SQLiteText";
@@ -726,6 +746,14 @@ declare class Files extends Base {
             file: any;
         } | null;
     }>;
+    getByKey(key: string): Promise<{
+        error: {
+            message: string;
+        } | null;
+        data: {
+            file: any;
+        } | null;
+    }>;
     getByName(name: string, options?: ListOptions): Promise<{
         error: {
             message: string;
@@ -737,6 +765,7 @@ declare class Files extends Base {
     upload(data: {
         files: File[];
         folder?: string;
+        visibility?: Visibility;
     }): Promise<{
         error: {
             message: string;
@@ -754,12 +783,27 @@ declare class Files extends Base {
         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>>;
 }
 
 declare class Folders extends Base {
     get(options?: ListOptions & {
         id?: string;
+        key?: string;
         path?: string;
     }): Promise<{
         error: {
@@ -777,6 +821,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>>;
 }
 
@@ -794,6 +843,16 @@ 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;
+};
 
 declare class Base {
     private apiKey;
@@ -817,4 +876,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 FileWithUrl as File, type Folder, type ListOptions, type SignOptions, type SignedUrl, type VazeOptions, type Visibility, Vaze as default };

package/dist/index.d.ts

@@ -494,8 +494,8 @@ declare const files: SQLiteTableWithColumns<{
         }, {}, {
             length: number | undefined;
         }>;
-        type: SQLiteColumn<{
-            name: "type";
+        key: SQLiteColumn<{
+            name: "key";
             tableName: "files";
             dataType: "string";
             columnType: "SQLiteText";
@@ -513,8 +513,8 @@ declare const files: SQLiteTableWithColumns<{
         }, {}, {
             length: number | undefined;
         }>;
-        path: SQLiteColumn<{
-            name: "path";
+        mimeType: SQLiteColumn<{
+            name: "mime_type";
             tableName: "files";
             dataType: "string";
             columnType: "SQLiteText";
@@ -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";
@@ -653,8 +673,8 @@ declare const folders: SQLiteTableWithColumns<{
         }, {}, {
             length: number | undefined;
         }>;
-        path: SQLiteColumn<{
-            name: "path";
+        key: SQLiteColumn<{
+            name: "key";
             tableName: "folders";
             dataType: "string";
             columnType: "SQLiteText";
@@ -726,6 +746,14 @@ declare class Files extends Base {
             file: any;
         } | null;
     }>;
+    getByKey(key: string): Promise<{
+        error: {
+            message: string;
+        } | null;
+        data: {
+            file: any;
+        } | null;
+    }>;
     getByName(name: string, options?: ListOptions): Promise<{
         error: {
             message: string;
@@ -737,6 +765,7 @@ declare class Files extends Base {
     upload(data: {
         files: File[];
         folder?: string;
+        visibility?: Visibility;
     }): Promise<{
         error: {
             message: string;
@@ -754,12 +783,27 @@ declare class Files extends Base {
         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>>;
 }
 
 declare class Folders extends Base {
     get(options?: ListOptions & {
         id?: string;
+        key?: string;
         path?: string;
     }): Promise<{
         error: {
@@ -777,6 +821,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>>;
 }
 
@@ -794,6 +843,16 @@ 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;
+};
 
 declare class Base {
     private apiKey;
@@ -817,4 +876,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 FileWithUrl as File, type Folder, type ListOptions, type SignOptions, type SignedUrl, type VazeOptions, type Visibility, Vaze as default };

package/dist/index.js

@@ -163,6 +163,22 @@ var Files = class extends Base {
       } : null
     };
   }
+  async getByKey(key) {
+    const url = this.apiUrl("/api/files", { key });
+    const { data, error } = await this.request(
+      "GET",
+      url
+    );
+    return {
+      error,
+      data: data ? {
+        file: constructFileUrls({
+          vazeUrl: this.vazeUrl,
+          files: [data.file]
+        })[0]
+      } : null
+    };
+  }
   async getByName(name, options) {
     const url = this.apiUrl("/api/files", { name, ...options });
     const { error, data } = await this.request(
@@ -180,10 +196,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);
     });
@@ -205,6 +222,21 @@ var Files = class extends Base {
   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
@@ -238,6 +270,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": "1.2.1",
+  "version": "2.1.0",
   "description": "Vaze Self-Hosted file storage and hosting service SDK.",
   "keywords": [
     "api",