@palettelab/sdk 0.1.14 → 0.1.16

package/README.md

@@ -166,7 +166,7 @@ Public frontend helpers exported by `@palettelab/sdk`:
 - 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?)`.
+- Storage: `StorageClient`, `upload(file, options)`, `resume(file, options)`, and `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)`.
@@ -257,6 +257,32 @@ The CLI reads that config in `pltt dev`, `pltt test`, `pltt package`, and
 `NEXT_PUBLIC_*` environment variables, and path aliases from
 `frontend/tsconfig.json`.
 
+## Palette App Router
+
+For OS-native routed apps, set `frontend.framework` to `palette-app` and point
+`frontend.entry` at `frontend/app`. The CLI scans app-directory UI files and
+still publishes one safe browser bundle.
+
+```json
+{
+  "frontend": {
+    "entry": "./frontend/app",
+    "sandbox": true,
+    "framework": "palette-app"
+  }
+}
+```
+
+Supported UI files are `layout.tsx`, `page.tsx`, `loading.tsx`, `error.tsx`,
+and `not-found.tsx`. Static routes, route groups, `[id]`, `[...slug]`, and
+`[[...slug]]` are supported. Use `Link`, `useRouter`, `usePathname`,
+`useSearchParams`, and `useParams` from `@palettelab/sdk`, or use the
+`next/link` and `next/navigation` compatibility imports in `palette-app`
+projects.
+
+Server-side Next features are intentionally not part of this mode. Put APIs,
+database access, permissions, and secrets in the plugin backend.
+
 ## Palette Client
 
 Use `createPaletteClient()` when an app needs common Palette OS services without
@@ -286,12 +312,30 @@ Included clients:
 - `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()`
+- `palette.storage.upload(file, options)`, `resume(file, options)`, and `uploadToSignedUrl()`
 - `palette.toast.success()`, `error()`, and `info()`
 
 These helpers are intentionally thin wrappers over platform APIs. Apps can still
 use `apiFetch()` directly for custom backend routes.
 
+App storage uploads are scoped by Palette to:
+
+```text
+uploads/apps/{app_name}_{plugin_id}/{organisation_slug}_{organisation_id}/{file}
+```
+
+Declare `"storage"` in `platform_services`, then upload directly from the
+browser with resumable chunking and progress:
+
+```tsx
+const palette = createPaletteClient(usePlatform())
+
+await palette.storage.upload(file, {
+  key: `receipts/${file.name}`,
+  onProgress: (p) => setPercent(p.percentage),
+})
+```
+
 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

package/dist/components/index.d.mts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import react__default from 'react';
-import { P as PlatformContext } from '../plugin-UV46q1mU.mjs';
+import { P as PlatformContext } from '../plugin-CG6spHKI.mjs';
 
 /**
  * Provider that wraps plugin components with the platform context.

package/dist/components/index.d.ts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import react__default from 'react';
-import { P as PlatformContext } from '../plugin-UV46q1mU.js';
+import { P as PlatformContext } from '../plugin-CG6spHKI.js';
 
 /**
  * Provider that wraps plugin components with the platform context.

package/dist/hooks/index.d.mts

@@ -1,4 +1,4 @@
-export { P as PlatformCtx, u as usePlatform, e as usePluginChat, f as usePluginDataRooms, g as usePluginTasks, h as usePluginTranslations } from '../index-Bu5EQGYo.mjs';
+export { P as PlatformCtx, u as usePlatform, e as usePluginChat, f as usePluginDataRooms, g as usePluginTasks, h as usePluginTranslations } from '../index-BGT6xBGD.mjs';
 import 'react';
-import '../plugin-UV46q1mU.mjs';
+import '../plugin-CG6spHKI.mjs';
 import '../data-room-Dtd9LLHf.mjs';

package/dist/hooks/index.d.ts

@@ -1,4 +1,4 @@
-export { P as PlatformCtx, u as usePlatform, e as usePluginChat, f as usePluginDataRooms, g as usePluginTasks, h as usePluginTranslations } from '../index-BDVWt7DE.js';
+export { P as PlatformCtx, u as usePlatform, e as usePluginChat, f as usePluginDataRooms, g as usePluginTasks, h as usePluginTranslations } from '../index-Beo6F2Fr.js';
 import 'react';
-import '../plugin-UV46q1mU.js';
+import '../plugin-CG6spHKI.js';
 import '../data-room-Dtd9LLHf.js';

package/dist/{index-Bu5EQGYo.d.mts → index-BGT6xBGD.d.mts}

@@ -1,5 +1,5 @@
 import * as react from 'react';
-import { d as PaletteLanguage, P as PlatformContext } from './plugin-UV46q1mU.mjs';
+import { d as PaletteLanguage, P as PlatformContext } from './plugin-CG6spHKI.mjs';
 import { T as Task, i as TaskStats, g as TaskCreatePayload, l as TaskUpdatePayload, D as DataRoom, a as DataRoomFolder, b as DataRoomFile, d as ChatThread, c as ChatMessage } from './data-room-Dtd9LLHf.mjs';
 
 type TranslationPrimitive = string | number | boolean | null;

package/dist/{index-BDVWt7DE.d.ts → index-Beo6F2Fr.d.ts}

@@ -1,5 +1,5 @@
 import * as react from 'react';
-import { d as PaletteLanguage, P as PlatformContext } from './plugin-UV46q1mU.js';
+import { d as PaletteLanguage, P as PlatformContext } from './plugin-CG6spHKI.js';
 import { T as Task, i as TaskStats, g as TaskCreatePayload, l as TaskUpdatePayload, D as DataRoom, a as DataRoomFolder, b as DataRoomFile, d as ChatThread, c as ChatMessage } from './data-room-Dtd9LLHf.js';
 
 type TranslationPrimitive = string | number | boolean | null;

package/dist/index.d.mts

@@ -1,10 +1,11 @@
-import { P as PlatformContext, O as OrgSummary, U as User } from './plugin-UV46q1mU.mjs';
-export { A as Agent, a as AgentConfig, b as AppCategory, c as AuthContextValue, d as PaletteLanguage, e as PluginAgentDefinition, f as PluginComponentProps, g as PluginManifest, h as PluginToolDefinition } from './plugin-UV46q1mU.mjs';
+import { P as PlatformContext, O as OrgSummary, U as User } from './plugin-CG6spHKI.mjs';
+export { A as Agent, a as AgentConfig, b as AppCategory, c as AuthContextValue, d as PaletteLanguage, e as PluginAgentDefinition, f as PluginComponentProps, g as PluginManifest, h as PluginToolDefinition } from './plugin-CG6spHKI.mjs';
 import { D as DataRoom, a as DataRoomFolder, b as DataRoomFile } from './data-room-Dtd9LLHf.mjs';
 export { C as ChatAttachment, c as ChatMessage, d as ChatThread, e as DataRoomPermission, T as Task, f as TaskAgentSnippet, g as TaskCreatePayload, h as TaskPriority, i as TaskStats, j as TaskStatus, k as TaskType, l as TaskUpdatePayload } from './data-room-Dtd9LLHf.mjs';
 export { AgentResource, ResourcesByGroup } from './types/index.mjs';
 import { ReactElement } from 'react';
-export { P as PlatformCtx, T as TranslateOptions, a as TranslationDictionary, b as TranslationPrimitive, c as TranslationResources, d as TranslationValues, U as UsePluginTranslationsOptions, n as normalizePaletteLanguage, t as translate, u as usePlatform, e as usePluginChat, f as usePluginDataRooms, g as usePluginTasks, h as usePluginTranslations } from './index-Bu5EQGYo.mjs';
+export { P as PlatformCtx, T as TranslateOptions, a as TranslationDictionary, b as TranslationPrimitive, c as TranslationResources, d as TranslationValues, U as UsePluginTranslationsOptions, n as normalizePaletteLanguage, t as translate, u as usePlatform, e as usePluginChat, f as usePluginDataRooms, g as usePluginTasks, h as usePluginTranslations } from './index-BGT6xBGD.mjs';
+export { Link, PaletteAppRoute, PaletteAppRouter, notFound, useParams, usePathname, useRouter, useSearchParams } from './router/index.mjs';
 export { PluginProvider } from './components/index.mjs';
 import 'react/jsx-runtime';
 
@@ -107,8 +108,41 @@ declare class DataRoomClient {
 }
 declare const dataRooms: DataRoomClient;
 
+type StorageUploadState = "starting" | "uploading" | "paused" | "complete";
+type StorageUploadProgress = {
+    loaded: number;
+    total: number;
+    percentage: number;
+    chunkIndex: number;
+    chunkCount: number;
+    state: StorageUploadState;
+};
+type StorageUploadOptions = {
+    pluginId?: string;
+    key?: string;
+    contentType?: string;
+    chunkSize?: number;
+    resumable?: boolean;
+    onProgress?: (progress: StorageUploadProgress) => void;
+    signal?: AbortSignal;
+};
+type StorageUploadResult = {
+    uploadId: string;
+    mode: "gcs_resumable" | "local_resumable" | string;
+    bucket: string;
+    objectPath: string;
+    fileUrl: string;
+    contentType: string;
+    size: number;
+};
 declare function uploadToSignedUrl(uploadUrl: string, file: Blob, contentType?: string): Promise<void>;
 declare class StorageClient {
+    private readonly ctx?;
+    constructor(ctx?: PlatformContext | undefined);
+    private pluginId;
+    private createSession;
+    upload(file: File, options?: StorageUploadOptions): Promise<StorageUploadResult>;
+    resume(file: File, options?: StorageUploadOptions): Promise<StorageUploadResult>;
     uploadToSignedUrl: typeof uploadToSignedUrl;
 }
 
@@ -179,4 +213,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, 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 };
+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, type StorageUploadOptions, type StorageUploadProgress, type StorageUploadResult, type StorageUploadState, 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

@@ -1,10 +1,11 @@
-import { P as PlatformContext, O as OrgSummary, U as User } from './plugin-UV46q1mU.js';
-export { A as Agent, a as AgentConfig, b as AppCategory, c as AuthContextValue, d as PaletteLanguage, e as PluginAgentDefinition, f as PluginComponentProps, g as PluginManifest, h as PluginToolDefinition } from './plugin-UV46q1mU.js';
+import { P as PlatformContext, O as OrgSummary, U as User } from './plugin-CG6spHKI.js';
+export { A as Agent, a as AgentConfig, b as AppCategory, c as AuthContextValue, d as PaletteLanguage, e as PluginAgentDefinition, f as PluginComponentProps, g as PluginManifest, h as PluginToolDefinition } from './plugin-CG6spHKI.js';
 import { D as DataRoom, a as DataRoomFolder, b as DataRoomFile } from './data-room-Dtd9LLHf.js';
 export { C as ChatAttachment, c as ChatMessage, d as ChatThread, e as DataRoomPermission, T as Task, f as TaskAgentSnippet, g as TaskCreatePayload, h as TaskPriority, i as TaskStats, j as TaskStatus, k as TaskType, l as TaskUpdatePayload } from './data-room-Dtd9LLHf.js';
 export { AgentResource, ResourcesByGroup } from './types/index.js';
 import { ReactElement } from 'react';
-export { P as PlatformCtx, T as TranslateOptions, a as TranslationDictionary, b as TranslationPrimitive, c as TranslationResources, d as TranslationValues, U as UsePluginTranslationsOptions, n as normalizePaletteLanguage, t as translate, u as usePlatform, e as usePluginChat, f as usePluginDataRooms, g as usePluginTasks, h as usePluginTranslations } from './index-BDVWt7DE.js';
+export { P as PlatformCtx, T as TranslateOptions, a as TranslationDictionary, b as TranslationPrimitive, c as TranslationResources, d as TranslationValues, U as UsePluginTranslationsOptions, n as normalizePaletteLanguage, t as translate, u as usePlatform, e as usePluginChat, f as usePluginDataRooms, g as usePluginTasks, h as usePluginTranslations } from './index-Beo6F2Fr.js';
+export { Link, PaletteAppRoute, PaletteAppRouter, notFound, useParams, usePathname, useRouter, useSearchParams } from './router/index.js';
 export { PluginProvider } from './components/index.js';
 import 'react/jsx-runtime';
 
@@ -107,8 +108,41 @@ declare class DataRoomClient {
 }
 declare const dataRooms: DataRoomClient;
 
+type StorageUploadState = "starting" | "uploading" | "paused" | "complete";
+type StorageUploadProgress = {
+    loaded: number;
+    total: number;
+    percentage: number;
+    chunkIndex: number;
+    chunkCount: number;
+    state: StorageUploadState;
+};
+type StorageUploadOptions = {
+    pluginId?: string;
+    key?: string;
+    contentType?: string;
+    chunkSize?: number;
+    resumable?: boolean;
+    onProgress?: (progress: StorageUploadProgress) => void;
+    signal?: AbortSignal;
+};
+type StorageUploadResult = {
+    uploadId: string;
+    mode: "gcs_resumable" | "local_resumable" | string;
+    bucket: string;
+    objectPath: string;
+    fileUrl: string;
+    contentType: string;
+    size: number;
+};
 declare function uploadToSignedUrl(uploadUrl: string, file: Blob, contentType?: string): Promise<void>;
 declare class StorageClient {
+    private readonly ctx?;
+    constructor(ctx?: PlatformContext | undefined);
+    private pluginId;
+    private createSession;
+    upload(file: File, options?: StorageUploadOptions): Promise<StorageUploadResult>;
+    resume(file: File, options?: StorageUploadOptions): Promise<StorageUploadResult>;
     uploadToSignedUrl: typeof uploadToSignedUrl;
 }
 
@@ -179,4 +213,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, 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 };
+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, type StorageUploadOptions, type StorageUploadProgress, type StorageUploadResult, type StorageUploadState, User, UserClient, apiFetch, apiUpload, createMockPlatformContext, createPaletteClient, createSandboxBridge, dataRooms, errorFromResponse, getBaseUrl, getInstallConfig, hasAllPermissions, hasAnyPermission, hasPermission, isPaletteApiError, isSandboxRuntime, setBaseUrl, updateInstallConfig, uploadToSignedUrl, withPluginProvider };