@palettelab/sdk 0.1.12 → 0.1.14

package/README.md

@@ -122,15 +122,30 @@ import {
   PluginProvider,
   usePlatform,
   createPaletteClient,
+  DataRoomClient,
+  StorageClient,
   usePluginTranslations,
+  translate,
+  normalizePaletteLanguage,
   usePluginTasks,
   usePluginDataRooms,
   usePluginChat,
   apiFetch,
   apiUpload,
+  setBaseUrl,
+  getBaseUrl,
   createSandboxBridge,
+  isSandboxRuntime,
   getInstallConfig,
   updateInstallConfig,
+  hasPermission,
+  hasAnyPermission,
+  hasAllPermissions,
+  PaletteApiError,
+  errorFromResponse,
+  isPaletteApiError,
+  createMockPlatformContext,
+  withPluginProvider,
 } from "@palettelab/sdk"
 ```
 
@@ -142,6 +157,25 @@ import type { PluginManifest } from "@palettelab/sdk/types"
 import { PluginProvider } from "@palettelab/sdk/components"
 ```
 
+## Helper Reference
+
+Public frontend helpers exported by `@palettelab/sdk`:
+
+- Provider/context: `PluginProvider`, `usePlatform`, `PlatformCtx`.
+- Client facade: `createPaletteClient(platform?)`.
+- API: `apiFetch(path, init?)`, `apiUpload(path, file, fieldName?, extraFields?)`, `setBaseUrl(url)`, `getBaseUrl()`.
+- Errors: `PaletteApiError`, `errorFromResponse(response)`, `isPaletteApiError(error)`.
+- Data Rooms: `DataRoomClient`, `dataRooms`, plus `list`, `create`, `get`, `folder`, `ensureRoom`, `requireRoomByName`, `findRoomByName`, `createFolder`, `ensureFolder`, `findFolderByName`, `resolveFolderPath`, `findFileByName`, `requestUpload`, `confirmUpload`, and `uploadFile`.
+- Storage: `StorageClient`, `uploadToSignedUrl(uploadUrl, file, contentType?)`.
+- Install config: `getInstallConfig(pluginId)`, `updateInstallConfig(pluginId, values)`.
+- Organization/user: `UserClient`, `OrganizationClient`, including `current`, `updateProfile`, `listMine`, `listMembers`, `getMember`, `getMemberByEmail`, `inviteMember`, and `updateMemberRole`.
+- Permissions: `hasPermission(ctx, permission)`, `hasAnyPermission(ctx, permissions)`, `hasAllPermissions(ctx, permissions)`.
+- Translations: `normalizePaletteLanguage`, `translate`, `usePluginTranslations`.
+- Hooks: `usePluginTasks`, `usePluginDataRooms`, `usePluginChat`.
+- Sandbox: `createSandboxBridge`, `isSandboxRuntime`.
+- Testing: `createMockPlatformContext`, `withPluginProvider`.
+- Types: `PluginManifest`, `PluginComponentProps`, `PlatformContext`, `PaletteClient`, resource, task, chat, data-room, user, organization, translation, and sandbox bridge types.
+
 ## Plugin Root
 
 The platform passes plugin runtime context into your root component. Wrap your UI with `PluginProvider` so hooks can read it.
@@ -248,7 +282,7 @@ function App() {
 Included clients:
 
 - `palette.user.current()` and `palette.user.updateProfile()`
-- `palette.organization.currentId()`, `currentRole()`, and `listMine()`
+- `palette.organization.currentId()`, `currentRole()`, `listMine()`, `listMembers()`, `getMember()`, `getMemberByEmail()`, `inviteMember()`, and `updateMemberRole()`
 - `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()`
@@ -258,6 +292,12 @@ Included clients:
 These helpers are intentionally thin wrappers over platform APIs. Apps can still
 use `apiFetch()` directly for custom backend routes.
 
+Member helpers operate on the active organisation. Use `members:read` for
+listing or looking up members, and `members:write` for invitations or role
+updates. When the runtime provides declared app permissions, these helpers check
+those permissions before calling the platform API. Member deletion/removal is
+intentionally not exposed through the app SDK.
+
 ### Data Room Folders By Name
 
 Apps can create or reuse custom Data Room folders by name:
@@ -358,8 +398,8 @@ Plugins can read and update their installation configuration through helper APIs
 ```ts
 import { getInstallConfig, updateInstallConfig } from "@palettelab/sdk"
 
-const config = await getInstallConfig()
-await updateInstallConfig({ ...config, enabled: true })
+const config = await getInstallConfig("my-plugin")
+await updateInstallConfig("my-plugin", { ...config, enabled: true })
 ```
 
 ## Sandbox Bridge

package/dist/index.d.mts

@@ -112,6 +112,24 @@ declare class StorageClient {
     uploadToSignedUrl: typeof uploadToSignedUrl;
 }
 
+type OrgMemberRole = "owner" | "admin" | "member" | "viewer";
+interface OrgMember {
+    id: string;
+    name: string;
+    email: string;
+    role: OrgMemberRole;
+    is_active: boolean;
+    joined_at: string;
+}
+interface OrgInviteMemberInput {
+    email: string;
+    role?: OrgMemberRole;
+}
+interface OrgInviteMemberResponse {
+    message: string;
+    email: string;
+    role: OrgMemberRole;
+}
 declare class UserClient {
     private readonly ctx?;
     constructor(ctx?: PlatformContext | undefined);
@@ -124,9 +142,15 @@ declare class UserClient {
 declare class OrganizationClient {
     private readonly ctx?;
     constructor(ctx?: PlatformContext | undefined);
+    private assertPermission;
     currentId(): number | null;
     currentRole(): string | null;
     listMine(): Promise<OrgSummary[]>;
+    listMembers(): Promise<OrgMember[]>;
+    getMember(userId: string): Promise<OrgMember | null>;
+    getMemberByEmail(email: string): Promise<OrgMember | null>;
+    inviteMember(input: OrgInviteMemberInput): Promise<OrgInviteMemberResponse>;
+    updateMemberRole(userId: string, role: OrgMemberRole): Promise<OrgMember>;
 }
 
 declare function createPaletteClient(ctx?: PlatformContext): {
@@ -155,4 +179,4 @@ declare function hasPermission(ctx: PlatformContext, permission: string): boolea
 declare function hasAnyPermission(ctx: PlatformContext, permissions: string[]): boolean;
 declare function hasAllPermissions(ctx: PlatformContext, permissions: string[]): boolean;
 
-export { DataRoom, DataRoomClient, type DataRoomContents, DataRoomFile, DataRoomFolder, type DataRoomUploadOptions, type InstallConfig, OrgSummary, OrganizationClient, PaletteApiError, type PaletteClient, PlatformContext, type SandboxBridge, StorageClient, User, UserClient, apiFetch, apiUpload, createMockPlatformContext, createPaletteClient, createSandboxBridge, dataRooms, errorFromResponse, getBaseUrl, getInstallConfig, hasAllPermissions, hasAnyPermission, hasPermission, isPaletteApiError, isSandboxRuntime, setBaseUrl, updateInstallConfig, uploadToSignedUrl, withPluginProvider };
+export { DataRoom, DataRoomClient, type DataRoomContents, DataRoomFile, DataRoomFolder, type DataRoomUploadOptions, type InstallConfig, type OrgInviteMemberInput, type OrgInviteMemberResponse, type OrgMember, type OrgMemberRole, OrgSummary, OrganizationClient, PaletteApiError, type PaletteClient, PlatformContext, type SandboxBridge, StorageClient, User, UserClient, apiFetch, apiUpload, createMockPlatformContext, createPaletteClient, createSandboxBridge, dataRooms, errorFromResponse, getBaseUrl, getInstallConfig, hasAllPermissions, hasAnyPermission, hasPermission, isPaletteApiError, isSandboxRuntime, setBaseUrl, updateInstallConfig, uploadToSignedUrl, withPluginProvider };

package/dist/index.d.ts

@@ -112,6 +112,24 @@ declare class StorageClient {
     uploadToSignedUrl: typeof uploadToSignedUrl;
 }
 
+type OrgMemberRole = "owner" | "admin" | "member" | "viewer";
+interface OrgMember {
+    id: string;
+    name: string;
+    email: string;
+    role: OrgMemberRole;
+    is_active: boolean;
+    joined_at: string;
+}
+interface OrgInviteMemberInput {
+    email: string;
+    role?: OrgMemberRole;
+}
+interface OrgInviteMemberResponse {
+    message: string;
+    email: string;
+    role: OrgMemberRole;
+}
 declare class UserClient {
     private readonly ctx?;
     constructor(ctx?: PlatformContext | undefined);
@@ -124,9 +142,15 @@ declare class UserClient {
 declare class OrganizationClient {
     private readonly ctx?;
     constructor(ctx?: PlatformContext | undefined);
+    private assertPermission;
     currentId(): number | null;
     currentRole(): string | null;
     listMine(): Promise<OrgSummary[]>;
+    listMembers(): Promise<OrgMember[]>;
+    getMember(userId: string): Promise<OrgMember | null>;
+    getMemberByEmail(email: string): Promise<OrgMember | null>;
+    inviteMember(input: OrgInviteMemberInput): Promise<OrgInviteMemberResponse>;
+    updateMemberRole(userId: string, role: OrgMemberRole): Promise<OrgMember>;
 }
 
 declare function createPaletteClient(ctx?: PlatformContext): {
@@ -155,4 +179,4 @@ declare function hasPermission(ctx: PlatformContext, permission: string): boolea
 declare function hasAnyPermission(ctx: PlatformContext, permissions: string[]): boolean;
 declare function hasAllPermissions(ctx: PlatformContext, permissions: string[]): boolean;
 
-export { DataRoom, DataRoomClient, type DataRoomContents, DataRoomFile, DataRoomFolder, type DataRoomUploadOptions, type InstallConfig, OrgSummary, OrganizationClient, PaletteApiError, type PaletteClient, PlatformContext, type SandboxBridge, StorageClient, User, UserClient, apiFetch, apiUpload, createMockPlatformContext, createPaletteClient, createSandboxBridge, dataRooms, errorFromResponse, getBaseUrl, getInstallConfig, hasAllPermissions, hasAnyPermission, hasPermission, isPaletteApiError, isSandboxRuntime, setBaseUrl, updateInstallConfig, uploadToSignedUrl, withPluginProvider };
+export { DataRoom, DataRoomClient, type DataRoomContents, DataRoomFile, DataRoomFolder, type DataRoomUploadOptions, type InstallConfig, type OrgInviteMemberInput, type OrgInviteMemberResponse, type OrgMember, type OrgMemberRole, OrgSummary, OrganizationClient, PaletteApiError, type PaletteClient, PlatformContext, type SandboxBridge, StorageClient, User, UserClient, apiFetch, apiUpload, createMockPlatformContext, createPaletteClient, createSandboxBridge, dataRooms, errorFromResponse, getBaseUrl, getInstallConfig, hasAllPermissions, hasAnyPermission, hasPermission, isPaletteApiError, isSandboxRuntime, setBaseUrl, updateInstallConfig, uploadToSignedUrl, withPluginProvider };

package/dist/index.js

@@ -395,6 +395,11 @@ var OrganizationClient = class {
   constructor(ctx) {
     this.ctx = ctx;
   }
+  assertPermission(permission) {
+    if (this.ctx?.permissions && !this.ctx.permissions.includes(permission)) {
+      throw new Error(`App does not declare required permission: ${permission}`);
+    }
+  }
   currentId() {
     return this.ctx?.organizationId ?? null;
   }
@@ -406,6 +411,39 @@ var OrganizationClient = class {
     const res = await apiFetch("/api/v1/auth/my-orgs");
     return res.json();
   }
+  async listMembers() {
+    this.assertPermission("members:read");
+    const res = await apiFetch("/api/v1/org/members");
+    return res.json();
+  }
+  async getMember(userId) {
+    const members = await this.listMembers();
+    return members.find((member) => member.id === userId) ?? null;
+  }
+  async getMemberByEmail(email) {
+    const normalizedEmail = email.trim().toLowerCase();
+    const members = await this.listMembers();
+    return members.find((member) => member.email.toLowerCase() === normalizedEmail) ?? null;
+  }
+  async inviteMember(input) {
+    this.assertPermission("members:write");
+    const res = await apiFetch("/api/v1/org/members", {
+      method: "POST",
+      body: JSON.stringify({
+        email: input.email,
+        role: input.role ?? "member"
+      })
+    });
+    return res.json();
+  }
+  async updateMemberRole(userId, role) {
+    this.assertPermission("members:write");
+    const res = await apiFetch(`/api/v1/org/members/${encodeURIComponent(userId)}/role`, {
+      method: "PATCH",
+      body: JSON.stringify({ role })
+    });
+    return res.json();
+  }
 };
 
 // src/palette-client.ts

package/dist/index.mjs

@@ -338,6 +338,11 @@ var OrganizationClient = class {
   constructor(ctx) {
     this.ctx = ctx;
   }
+  assertPermission(permission) {
+    if (this.ctx?.permissions && !this.ctx.permissions.includes(permission)) {
+      throw new Error(`App does not declare required permission: ${permission}`);
+    }
+  }
   currentId() {
     return this.ctx?.organizationId ?? null;
   }
@@ -349,6 +354,39 @@ var OrganizationClient = class {
     const res = await apiFetch("/api/v1/auth/my-orgs");
     return res.json();
   }
+  async listMembers() {
+    this.assertPermission("members:read");
+    const res = await apiFetch("/api/v1/org/members");
+    return res.json();
+  }
+  async getMember(userId) {
+    const members = await this.listMembers();
+    return members.find((member) => member.id === userId) ?? null;
+  }
+  async getMemberByEmail(email) {
+    const normalizedEmail = email.trim().toLowerCase();
+    const members = await this.listMembers();
+    return members.find((member) => member.email.toLowerCase() === normalizedEmail) ?? null;
+  }
+  async inviteMember(input) {
+    this.assertPermission("members:write");
+    const res = await apiFetch("/api/v1/org/members", {
+      method: "POST",
+      body: JSON.stringify({
+        email: input.email,
+        role: input.role ?? "member"
+      })
+    });
+    return res.json();
+  }
+  async updateMemberRole(userId, role) {
+    this.assertPermission("members:write");
+    const res = await apiFetch(`/api/v1/org/members/${encodeURIComponent(userId)}/role`, {
+      method: "PATCH",
+      body: JSON.stringify({ role })
+    });
+    return res.json();
+  }
 };
 
 // src/palette-client.ts

package/package.json

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