@palettelab/sdk 0.1.9 → 0.1.10

package/README.md

@@ -195,7 +195,7 @@ Included clients:
 
 - `palette.user.current()` and `palette.user.updateProfile()`
 - `palette.organization.currentId()`, `currentRole()`, and `listMine()`
-- `palette.dataRooms.list()`, `create()`, `get()`, `folder()`, and `uploadFile()`
+- `palette.dataRooms.list()`, `create()`, `get()`, `folder()`, `createFolder()`, `ensureFolder()`, `findRoomByName()`, `findFolderByName()`, `resolveFolderPath()`, `findFileByName()`, and `uploadFile()`
 - `palette.config.get()` and `palette.config.update(values)`, with optional plugin ID override
 - `palette.permissions.has()`, `hasAny()`, and `hasAll()`
 - `palette.storage.uploadToSignedUrl()`
@@ -204,6 +204,41 @@ Included clients:
 These helpers are intentionally thin wrappers over platform APIs. Apps can still
 use `apiFetch()` directly for custom backend routes.
 
+### Data Room Folders By Name
+
+Apps can create or reuse custom Data Room folders by name:
+
+```tsx
+const palette = createPaletteClient(usePlatform())
+
+const room = await palette.dataRooms.ensureRoom("Finance")
+const invoices = await palette.dataRooms.ensureFolder(room.id, "Invoices")
+
+await palette.dataRooms.uploadFile(room.id, file, {
+  folderId: invoices.id,
+})
+```
+
+Apps can also resolve nested folders:
+
+```tsx
+const folder = await palette.dataRooms.resolveFolderPath(
+  room.id,
+  "Clients/Acme/Invoices",
+  { create: true },
+)
+```
+
+To read existing files by name:
+
+```tsx
+const room = await palette.dataRooms.requireRoomByName("Finance")
+const folder = await palette.dataRooms.resolveFolderPath(room.id, "Clients/Acme/Invoices")
+const file = folder
+  ? await palette.dataRooms.findFileByName(room.id, "jan.pdf", { folderId: folder.id })
+  : null
+```
+
 ## Permissions
 
 Use permission helpers to keep UI actions aligned with backend permission gates.

package/dist/index.d.mts

@@ -63,7 +63,14 @@ interface DataRoomUploadOptions {
     folderId?: number | null;
     contentType?: string;
 }
+interface FindByNameOptions {
+    caseSensitive?: boolean;
+}
+interface EnsureFolderOptions extends FindByNameOptions {
+    parentFolderId?: number | null;
+}
 declare class DataRoomClient {
+    private matchesName;
     list(): Promise<DataRoom[]>;
     create(input: {
         name: string;
@@ -71,6 +78,21 @@ declare class DataRoomClient {
     }): Promise<DataRoom>;
     get(roomId: number): Promise<DataRoomContents>;
     folder(roomId: number, folderId: number): Promise<DataRoomContents>;
+    findRoomByName(name: string, options?: FindByNameOptions): Promise<DataRoom | null>;
+    requireRoomByName(name: string, options?: FindByNameOptions): Promise<DataRoom>;
+    ensureRoom(name: string, description?: string | null): Promise<DataRoom>;
+    createFolder(roomId: number, input: {
+        name: string;
+        parentFolderId?: number | null;
+    }): Promise<DataRoomFolder>;
+    findFolderByName(roomId: number, name: string, options?: EnsureFolderOptions): Promise<DataRoomFolder | null>;
+    ensureFolder(roomId: number, name: string, options?: EnsureFolderOptions): Promise<DataRoomFolder>;
+    resolveFolderPath(roomId: number, path: string | string[], options?: FindByNameOptions & {
+        create?: boolean;
+    }): Promise<DataRoomFolder | null>;
+    findFileByName(roomId: number, name: string, options?: FindByNameOptions & {
+        folderId?: number | null;
+    }): Promise<DataRoomFile | null>;
     requestUpload(roomId: number, file: File, options?: DataRoomUploadOptions): Promise<{
         upload_url: string;
         blob_path: string;

package/dist/index.d.ts

@@ -63,7 +63,14 @@ interface DataRoomUploadOptions {
     folderId?: number | null;
     contentType?: string;
 }
+interface FindByNameOptions {
+    caseSensitive?: boolean;
+}
+interface EnsureFolderOptions extends FindByNameOptions {
+    parentFolderId?: number | null;
+}
 declare class DataRoomClient {
+    private matchesName;
     list(): Promise<DataRoom[]>;
     create(input: {
         name: string;
@@ -71,6 +78,21 @@ declare class DataRoomClient {
     }): Promise<DataRoom>;
     get(roomId: number): Promise<DataRoomContents>;
     folder(roomId: number, folderId: number): Promise<DataRoomContents>;
+    findRoomByName(name: string, options?: FindByNameOptions): Promise<DataRoom | null>;
+    requireRoomByName(name: string, options?: FindByNameOptions): Promise<DataRoom>;
+    ensureRoom(name: string, description?: string | null): Promise<DataRoom>;
+    createFolder(roomId: number, input: {
+        name: string;
+        parentFolderId?: number | null;
+    }): Promise<DataRoomFolder>;
+    findFolderByName(roomId: number, name: string, options?: EnsureFolderOptions): Promise<DataRoomFolder | null>;
+    ensureFolder(roomId: number, name: string, options?: EnsureFolderOptions): Promise<DataRoomFolder>;
+    resolveFolderPath(roomId: number, path: string | string[], options?: FindByNameOptions & {
+        create?: boolean;
+    }): Promise<DataRoomFolder | null>;
+    findFileByName(roomId: number, name: string, options?: FindByNameOptions & {
+        folderId?: number | null;
+    }): Promise<DataRoomFile | null>;
     requestUpload(roomId: number, file: File, options?: DataRoomUploadOptions): Promise<{
         upload_url: string;
         blob_path: string;

package/dist/index.js

@@ -231,6 +231,10 @@ function withPluginProvider(element, platform = {}) {
 
 // src/data-rooms.ts
 var DataRoomClient = class {
+  matchesName(actual, expected, options = {}) {
+    if (options.caseSensitive) return actual === expected;
+    return actual.localeCompare(expected, void 0, { sensitivity: "accent" }) === 0;
+  }
   async list() {
     const res = await apiFetch("/api/v1/data-rooms");
     return res.json();
@@ -250,6 +254,50 @@ var DataRoomClient = class {
     const res = await apiFetch(`/api/v1/data-rooms/${roomId}/folders/${folderId}`);
     return res.json();
   }
+  async findRoomByName(name, options = {}) {
+    const rooms = await this.list();
+    return rooms.find((room) => this.matchesName(room.name, name, options)) ?? null;
+  }
+  async requireRoomByName(name, options = {}) {
+    const room = await this.findRoomByName(name, options);
+    if (!room) throw new Error(`Data Room not found: ${name}`);
+    return room;
+  }
+  async ensureRoom(name, description) {
+    return await this.findRoomByName(name) ?? this.create({ name, description });
+  }
+  async createFolder(roomId, input) {
+    const res = await apiFetch(`/api/v1/data-rooms/${roomId}/folders`, {
+      method: "POST",
+      body: JSON.stringify({
+        name: input.name,
+        parent_folder_id: input.parentFolderId ?? null
+      })
+    });
+    return res.json();
+  }
+  async findFolderByName(roomId, name, options = {}) {
+    const contents = options.parentFolderId ? await this.folder(roomId, options.parentFolderId) : await this.get(roomId);
+    return contents.folders.find((folder) => this.matchesName(folder.name, name, options)) ?? null;
+  }
+  async ensureFolder(roomId, name, options = {}) {
+    return await this.findFolderByName(roomId, name, options) ?? this.createFolder(roomId, { name, parentFolderId: options.parentFolderId ?? null });
+  }
+  async resolveFolderPath(roomId, path, options = {}) {
+    const parts = Array.isArray(path) ? path : path.split("/").map((part) => part.trim()).filter(Boolean);
+    let parentFolderId = null;
+    let current = null;
+    for (const part of parts) {
+      current = options.create ? await this.ensureFolder(roomId, part, { ...options, parentFolderId }) : await this.findFolderByName(roomId, part, { ...options, parentFolderId });
+      if (!current) return null;
+      parentFolderId = current.id;
+    }
+    return current;
+  }
+  async findFileByName(roomId, name, options = {}) {
+    const contents = options.folderId ? await this.folder(roomId, options.folderId) : await this.get(roomId);
+    return contents.files.find((file) => this.matchesName(file.original_filename, name, options)) ?? null;
+  }
   async requestUpload(roomId, file, options = {}) {
     const res = await apiFetch(`/api/v1/data-rooms/${roomId}/files/request-upload`, {
       method: "POST",

package/dist/index.mjs

@@ -177,6 +177,10 @@ function withPluginProvider(element, platform = {}) {
 
 // src/data-rooms.ts
 var DataRoomClient = class {
+  matchesName(actual, expected, options = {}) {
+    if (options.caseSensitive) return actual === expected;
+    return actual.localeCompare(expected, void 0, { sensitivity: "accent" }) === 0;
+  }
   async list() {
     const res = await apiFetch("/api/v1/data-rooms");
     return res.json();
@@ -196,6 +200,50 @@ var DataRoomClient = class {
     const res = await apiFetch(`/api/v1/data-rooms/${roomId}/folders/${folderId}`);
     return res.json();
   }
+  async findRoomByName(name, options = {}) {
+    const rooms = await this.list();
+    return rooms.find((room) => this.matchesName(room.name, name, options)) ?? null;
+  }
+  async requireRoomByName(name, options = {}) {
+    const room = await this.findRoomByName(name, options);
+    if (!room) throw new Error(`Data Room not found: ${name}`);
+    return room;
+  }
+  async ensureRoom(name, description) {
+    return await this.findRoomByName(name) ?? this.create({ name, description });
+  }
+  async createFolder(roomId, input) {
+    const res = await apiFetch(`/api/v1/data-rooms/${roomId}/folders`, {
+      method: "POST",
+      body: JSON.stringify({
+        name: input.name,
+        parent_folder_id: input.parentFolderId ?? null
+      })
+    });
+    return res.json();
+  }
+  async findFolderByName(roomId, name, options = {}) {
+    const contents = options.parentFolderId ? await this.folder(roomId, options.parentFolderId) : await this.get(roomId);
+    return contents.folders.find((folder) => this.matchesName(folder.name, name, options)) ?? null;
+  }
+  async ensureFolder(roomId, name, options = {}) {
+    return await this.findFolderByName(roomId, name, options) ?? this.createFolder(roomId, { name, parentFolderId: options.parentFolderId ?? null });
+  }
+  async resolveFolderPath(roomId, path, options = {}) {
+    const parts = Array.isArray(path) ? path : path.split("/").map((part) => part.trim()).filter(Boolean);
+    let parentFolderId = null;
+    let current = null;
+    for (const part of parts) {
+      current = options.create ? await this.ensureFolder(roomId, part, { ...options, parentFolderId }) : await this.findFolderByName(roomId, part, { ...options, parentFolderId });
+      if (!current) return null;
+      parentFolderId = current.id;
+    }
+    return current;
+  }
+  async findFileByName(roomId, name, options = {}) {
+    const contents = options.folderId ? await this.folder(roomId, options.folderId) : await this.get(roomId);
+    return contents.files.find((file) => this.matchesName(file.original_filename, name, options)) ?? null;
+  }
   async requestUpload(roomId, file, options = {}) {
     const res = await apiFetch(`/api/v1/data-rooms/${roomId}/files/request-upload`, {
       method: "POST",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@palettelab/sdk",
-  "version": "0.1.9",
+  "version": "0.1.10",
   "description": "Palette Platform SDK for building plugins and apps",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",