@puredesktop/puredesktop-ui-bridge 2.1.4 → 2.1.7

package/src/bridge/fs.d.mts

@@ -1,31 +1,31 @@
-import type {
-  PlatformFileCreateFolderResult,
-  PlatformFileDeleteResult,
-  PlatformFileListResult,
-  PlatformFilePreviewUrlResult,
-  PlatformFileReadBinaryResult,
-  PlatformFileReadPreviewResult,
-  PlatformFileRenameResult,
-  PlatformFileWriteResult,
-} from './types.js'
+import type {
+  PlatformFileCreateFolderResult,
+  PlatformFileDeleteResult,
+  PlatformFileListResult,
+  PlatformFilePreviewUrlResult,
+  PlatformFileReadBinaryResult,
+  PlatformFileReadPreviewResult,
+  PlatformFileRenameResult,
+  PlatformFileWriteResult,
+} from './types.js'
 
-export declare const PLATFORM_FILE_TEXT_PREVIEW_MAX_BYTES: number
-export declare const PLATFORM_FILE_BINARY_PREVIEW_MAX_BYTES: number
-
-export declare function listPlatformFiles(
-  rootPath: string,
-): Promise<PlatformFileListResult>
-
-export declare function readPlatformTextFile(path: string): Promise<string>
-
-export declare function writePlatformTextFile(
-  path: string,
-  content: string,
-): Promise<PlatformFileWriteResult>
-
-export declare function readPlatformFilePreview(
-  path: string,
-  maxBytes?: number,
+export declare const PLATFORM_FILE_TEXT_PREVIEW_MAX_BYTES: number
+export declare const PLATFORM_FILE_BINARY_PREVIEW_MAX_BYTES: number
+
+export declare function listPlatformFiles(
+  rootPath: string,
+): Promise<PlatformFileListResult>
+
+export declare function readPlatformTextFile(path: string): Promise<string>
+
+export declare function writePlatformTextFile(
+  path: string,
+  content: string,
+): Promise<PlatformFileWriteResult>
+
+export declare function readPlatformFilePreview(
+  path: string,
+  maxBytes?: number,
 ): Promise<PlatformFileReadPreviewResult>
 
 export declare function readPlatformFileBinary(
@@ -51,17 +51,17 @@ export declare function writePlatformFileBinary(
   base64: string,
 ): Promise<{ ok: true }>
 
-export declare function createPlatformFolder(
-  parentPath: string,
-  name: string,
-): Promise<PlatformFileCreateFolderResult>
-
-export declare function renamePlatformFile(
-  path: string,
-  name: string,
-): Promise<PlatformFileRenameResult>
-
-export declare function deletePlatformFile(
-  path: string,
-  recursive?: boolean,
-): Promise<PlatformFileDeleteResult>
+export declare function createPlatformFolder(
+  parentPath: string,
+  name: string,
+): Promise<PlatformFileCreateFolderResult>
+
+export declare function renamePlatformFile(
+  path: string,
+  name: string,
+): Promise<PlatformFileRenameResult>
+
+export declare function deletePlatformFile(
+  path: string,
+  recursive?: boolean,
+): Promise<PlatformFileDeleteResult>

package/src/bridge/fs.mjs

@@ -5,38 +5,38 @@ import { PLATFORM_BRIDGE_METHODS } from './methods.mjs'
 export const PLATFORM_FILE_TEXT_PREVIEW_MAX_BYTES = 64 * 1024
 
 /** Default binary preview cap for legacy inline image reads. Prefer `fs.previewUrl`. */
-export const PLATFORM_FILE_BINARY_PREVIEW_MAX_BYTES = 5 * 1024 * 1024
-
-/**
- * @param {string} rootPath
- * @returns {Promise<import('./types.ts').PlatformFileListResult>}
- */
-export async function listPlatformFiles(rootPath) {
-  return bridge.call(PLATFORM_BRIDGE_METHODS.FS_LIST, [{ rootPath }])
-}
-
-/**
- * @param {string} path
- * @returns {Promise<string>}
- */
-export async function readPlatformTextFile(path) {
-  return bridge.call(PLATFORM_BRIDGE_METHODS.FS_READ, [path])
-}
-
-/**
- * @param {string} path
- * @param {string} content
- * @returns {Promise<import('./types.ts').PlatformFileWriteResult>}
- */
-export async function writePlatformTextFile(path, content) {
-  return bridge.call(PLATFORM_BRIDGE_METHODS.FS_WRITE, [path, content])
-}
-
-/**
- * @param {string} path
- * @returns {Promise<import('./types.ts').PlatformFilePreviewUrlResult>}
- */
-export async function readPlatformFilePreviewUrl(path) {
+export const PLATFORM_FILE_BINARY_PREVIEW_MAX_BYTES = 5 * 1024 * 1024
+
+/**
+ * @param {string} rootPath
+ * @returns {Promise<import('./types.ts').PlatformFileListResult>}
+ */
+export async function listPlatformFiles(rootPath) {
+  return bridge.call(PLATFORM_BRIDGE_METHODS.FS_LIST, [{ rootPath }])
+}
+
+/**
+ * @param {string} path
+ * @returns {Promise<string>}
+ */
+export async function readPlatformTextFile(path) {
+  return bridge.call(PLATFORM_BRIDGE_METHODS.FS_READ, [path])
+}
+
+/**
+ * @param {string} path
+ * @param {string} content
+ * @returns {Promise<import('./types.ts').PlatformFileWriteResult>}
+ */
+export async function writePlatformTextFile(path, content) {
+  return bridge.call(PLATFORM_BRIDGE_METHODS.FS_WRITE, [path, content])
+}
+
+/**
+ * @param {string} path
+ * @returns {Promise<import('./types.ts').PlatformFilePreviewUrlResult>}
+ */
+export async function readPlatformFilePreviewUrl(path) {
   return bridge.call(PLATFORM_BRIDGE_METHODS.FS_PREVIEW_URL, [{ path }])
 }
 
@@ -100,27 +100,27 @@ export async function writePlatformFileBinary(path, base64) {
  * @param {string} name
  * @returns {Promise<{ path: string }>}
  */
-export async function createPlatformFolder(parentPath, name) {
-  return bridge.call(PLATFORM_BRIDGE_METHODS.FS_CREATE_FOLDER, [
-    { parentPath, name },
-  ])
-}
-
-/**
- * @param {string} path
- * @param {string} name
- * @returns {Promise<import('./types.ts').PlatformFileRenameResult>}
- */
-export async function renamePlatformFile(path, name) {
-  return bridge.call(PLATFORM_BRIDGE_METHODS.FS_RENAME, [{ path, name }])
-}
-
-/**
- * @param {string} path
- * @param {boolean | undefined} recursive
- * @returns {Promise<import('./types.ts').PlatformFileDeleteResult>}
- */
-export async function deletePlatformFile(path, recursive) {
-  const request = recursive === undefined ? { path } : { path, recursive }
-  return bridge.call(PLATFORM_BRIDGE_METHODS.FS_DELETE, [request])
-}
+export async function createPlatformFolder(parentPath, name) {
+  return bridge.call(PLATFORM_BRIDGE_METHODS.FS_CREATE_FOLDER, [
+    { parentPath, name },
+  ])
+}
+
+/**
+ * @param {string} path
+ * @param {string} name
+ * @returns {Promise<import('./types.ts').PlatformFileRenameResult>}
+ */
+export async function renamePlatformFile(path, name) {
+  return bridge.call(PLATFORM_BRIDGE_METHODS.FS_RENAME, [{ path, name }])
+}
+
+/**
+ * @param {string} path
+ * @param {boolean | undefined} recursive
+ * @returns {Promise<import('./types.ts').PlatformFileDeleteResult>}
+ */
+export async function deletePlatformFile(path, recursive) {
+  const request = recursive === undefined ? { path } : { path, recursive }
+  return bridge.call(PLATFORM_BRIDGE_METHODS.FS_DELETE, [request])
+}

package/src/bridge/fs.test.ts

@@ -1,30 +1,30 @@
-import { beforeEach, describe, expect, it, vi } from 'vitest'
-import { PLATFORM_BRIDGE_METHODS } from './methods.mjs'
-
-const bridgeCall = vi.hoisted(() => vi.fn())
-
-vi.mock('./client.mjs', () => ({
-  bridge: {
-    call: bridgeCall,
-  },
-}))
-
-import {
-  dataUrlFromFileBinary,
-  deletePlatformFile,
-  listPlatformFiles,
-  readPlatformTextFile,
-  renamePlatformFile,
-  writePlatformTextFile,
-} from './fs.mjs'
-
-beforeEach(() => {
-  bridgeCall.mockReset()
-})
-
-describe('dataUrlFromFileBinary', () => {
-  it('builds a data URL from bridge binary result', () => {
-    expect(
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+import { PLATFORM_BRIDGE_METHODS } from './methods.mjs'
+
+const bridgeCall = vi.hoisted(() => vi.fn())
+
+vi.mock('./client.mjs', () => ({
+  bridge: {
+    call: bridgeCall,
+  },
+}))
+
+import {
+  dataUrlFromFileBinary,
+  deletePlatformFile,
+  listPlatformFiles,
+  readPlatformTextFile,
+  renamePlatformFile,
+  writePlatformTextFile,
+} from './fs.mjs'
+
+beforeEach(() => {
+  bridgeCall.mockReset()
+})
+
+describe('dataUrlFromFileBinary', () => {
+  it('builds a data URL from bridge binary result', () => {
+    expect(
       dataUrlFromFileBinary({
         path: '/tmp/image.png',
         mimeType: 'image/png',
@@ -32,59 +32,59 @@ describe('dataUrlFromFileBinary', () => {
         truncated: false,
         byteLength: 3,
       }),
-    ).toBe('data:image/png;base64,abc123')
-  })
-})
-
-describe('filesystem bridge helpers', () => {
-  it('lists files using the shell request object shape', async () => {
-    bridgeCall.mockResolvedValue({ entries: [] })
-
-    await listPlatformFiles('/tmp')
-
-    expect(bridgeCall).toHaveBeenCalledWith(PLATFORM_BRIDGE_METHODS.FS_LIST, [
-      { rootPath: '/tmp' },
-    ])
-  })
-
-  it('reads text files using the shell path argument shape', async () => {
-    bridgeCall.mockResolvedValue('hello')
-
-    await readPlatformTextFile('/tmp/a.md')
-
-    expect(bridgeCall).toHaveBeenCalledWith(PLATFORM_BRIDGE_METHODS.FS_READ, [
-      '/tmp/a.md',
-    ])
-  })
-
-  it('writes text files using the shell path and content argument shape', async () => {
-    bridgeCall.mockResolvedValue({ ok: true })
-
-    await writePlatformTextFile('/tmp/a.md', 'hello')
-
-    expect(bridgeCall).toHaveBeenCalledWith(PLATFORM_BRIDGE_METHODS.FS_WRITE, [
-      '/tmp/a.md',
-      'hello',
-    ])
-  })
-
-  it('renames files using the shell request object shape', async () => {
-    bridgeCall.mockResolvedValue({ path: '/tmp/b.md' })
-
-    await renamePlatformFile('/tmp/a.md', 'b.md')
-
-    expect(bridgeCall).toHaveBeenCalledWith(PLATFORM_BRIDGE_METHODS.FS_RENAME, [
-      { path: '/tmp/a.md', name: 'b.md' },
-    ])
-  })
-
-  it('deletes files using the shell request object shape', async () => {
-    bridgeCall.mockResolvedValue({ ok: true })
-
-    await deletePlatformFile('/tmp/a.md', true)
-
-    expect(bridgeCall).toHaveBeenCalledWith(PLATFORM_BRIDGE_METHODS.FS_DELETE, [
-      { path: '/tmp/a.md', recursive: true },
-    ])
-  })
-})
+    ).toBe('data:image/png;base64,abc123')
+  })
+})
+
+describe('filesystem bridge helpers', () => {
+  it('lists files using the shell request object shape', async () => {
+    bridgeCall.mockResolvedValue({ entries: [] })
+
+    await listPlatformFiles('/tmp')
+
+    expect(bridgeCall).toHaveBeenCalledWith(PLATFORM_BRIDGE_METHODS.FS_LIST, [
+      { rootPath: '/tmp' },
+    ])
+  })
+
+  it('reads text files using the shell path argument shape', async () => {
+    bridgeCall.mockResolvedValue('hello')
+
+    await readPlatformTextFile('/tmp/a.md')
+
+    expect(bridgeCall).toHaveBeenCalledWith(PLATFORM_BRIDGE_METHODS.FS_READ, [
+      '/tmp/a.md',
+    ])
+  })
+
+  it('writes text files using the shell path and content argument shape', async () => {
+    bridgeCall.mockResolvedValue({ ok: true })
+
+    await writePlatformTextFile('/tmp/a.md', 'hello')
+
+    expect(bridgeCall).toHaveBeenCalledWith(PLATFORM_BRIDGE_METHODS.FS_WRITE, [
+      '/tmp/a.md',
+      'hello',
+    ])
+  })
+
+  it('renames files using the shell request object shape', async () => {
+    bridgeCall.mockResolvedValue({ path: '/tmp/b.md' })
+
+    await renamePlatformFile('/tmp/a.md', 'b.md')
+
+    expect(bridgeCall).toHaveBeenCalledWith(PLATFORM_BRIDGE_METHODS.FS_RENAME, [
+      { path: '/tmp/a.md', name: 'b.md' },
+    ])
+  })
+
+  it('deletes files using the shell request object shape', async () => {
+    bridgeCall.mockResolvedValue({ ok: true })
+
+    await deletePlatformFile('/tmp/a.md', true)
+
+    expect(bridgeCall).toHaveBeenCalledWith(PLATFORM_BRIDGE_METHODS.FS_DELETE, [
+      { path: '/tmp/a.md', recursive: true },
+    ])
+  })
+})

package/src/bridge/fs.ts

@@ -1,28 +1,28 @@
-export {
-  createPlatformFolder,
-  dataUrlFromFileBinary,
-  deletePlatformFile,
-  listPlatformFiles,
-  readPlatformFileBinary,
-  readPlatformFileBinaryDataUrl,
-  readPlatformFilePreview,
-  readPlatformFilePreviewUrl,
-  readPlatformTextFile,
-  renamePlatformFile,
-  writePlatformFileBinary,
-  writePlatformTextFile,
-  PLATFORM_FILE_BINARY_PREVIEW_MAX_BYTES,
-  PLATFORM_FILE_TEXT_PREVIEW_MAX_BYTES,
-} from './fs.mjs'
-
-export type {
-  PlatformFileCreateFolderResult,
-  PlatformFileDeleteResult,
-  PlatformFileEntry,
-  PlatformFileListResult,
-  PlatformFilePreviewUrlResult,
-  PlatformFileReadBinaryResult,
-  PlatformFileReadPreviewResult,
-  PlatformFileRenameResult,
-  PlatformFileWriteResult,
-} from './types.js'
+export {
+  createPlatformFolder,
+  dataUrlFromFileBinary,
+  deletePlatformFile,
+  listPlatformFiles,
+  readPlatformFileBinary,
+  readPlatformFileBinaryDataUrl,
+  readPlatformFilePreview,
+  readPlatformFilePreviewUrl,
+  readPlatformTextFile,
+  renamePlatformFile,
+  writePlatformFileBinary,
+  writePlatformTextFile,
+  PLATFORM_FILE_BINARY_PREVIEW_MAX_BYTES,
+  PLATFORM_FILE_TEXT_PREVIEW_MAX_BYTES,
+} from './fs.mjs'
+
+export type {
+  PlatformFileCreateFolderResult,
+  PlatformFileDeleteResult,
+  PlatformFileEntry,
+  PlatformFileListResult,
+  PlatformFilePreviewUrlResult,
+  PlatformFileReadBinaryResult,
+  PlatformFileReadPreviewResult,
+  PlatformFileRenameResult,
+  PlatformFileWriteResult,
+} from './types.js'

package/src/bridge/googleAuth.ts

@@ -127,7 +127,9 @@ export async function exchangeCodeForTokens(
       `Google token exchange failed (${response.status}): ${response.body}`,
     )
   }
-  return tokensFromTokenResponse(JSON.parse(response.body) as GoogleTokenResponse)
+  return tokensFromTokenResponse(
+    JSON.parse(response.body) as GoogleTokenResponse,
+  )
 }
 
 export interface TokenRefreshInput {

package/src/bridge/methods.d.mts

@@ -7,6 +7,7 @@ export declare const PLATFORM_BRIDGE_METHODS: {
   readonly CATALOG_OPEN: 'catalog.open'
   readonly WORKSPACE_OPEN_APP: 'workspace.openApp'
   readonly WORKSPACE_OPEN_PALETTE: 'workspace.openPalette'
+  readonly WORKSPACE_UPDATE_CURRENT_TAB: 'workspace.updateCurrentTab'
   readonly SCHEDULER_REGISTER: 'scheduler.register'
   readonly SCHEDULER_UNREGISTER: 'scheduler.unregister'
   readonly CATALOG_CONSUME_PENDING_OPEN: 'catalog.consumePendingOpen'
@@ -32,9 +33,12 @@ export declare const PLATFORM_BRIDGE_METHODS: {
   readonly DIALOG_SAVE_FOLDER: 'dialog.saveFolder'
   readonly DIALOG_OPEN_IMAGE: 'dialog.openImage'
   readonly DIALOG_OPEN_FILE: 'dialog.openFile'
+  readonly DIALOG_SAVE_FILE: 'dialog.saveFile'
   readonly OS_REVEAL: 'os.reveal'
   readonly OS_OPEN_PATH: 'os.openPath'
   readonly OS_TRASH: 'os.trash'
+  readonly CLIPBOARD_READ: 'clipboard.read'
+  readonly CLIPBOARD_WRITE: 'clipboard.write'
   readonly RENDER_PRINT_HTML: 'render.printHtml'
   readonly RENDER_PREPARE_PAGED_PREVIEW: 'render.preparePagedPreview'
   readonly RENDER_CAPTURE_PAGED_SNAPSHOT: 'render.capturePagedSnapshot'
@@ -102,6 +106,7 @@ export declare const PLATFORM_BRIDGE_METHODS: {
 
 export declare const PLATFORM_BRIDGE_METHOD_PREFIXES: {
   readonly RUNTIME: 'runtime.'
+  readonly WORKSPACE: 'workspace.'
   readonly THEME: 'theme.'
   readonly WINDOW: 'window.'
   readonly SETTINGS: 'settings.'
@@ -109,6 +114,7 @@ export declare const PLATFORM_BRIDGE_METHOD_PREFIXES: {
   readonly FS: 'fs.'
   readonly DIALOG: 'dialog.'
   readonly OS: 'os.'
+  readonly CLIPBOARD: 'clipboard.'
   readonly RENDER: 'render.'
   readonly WATCH: 'watch.'
   readonly ASSETS: 'assets.'

package/src/bridge/methods.mjs

@@ -10,6 +10,7 @@ export const PLATFORM_BRIDGE_METHODS = {
   CATALOG_OPEN: 'catalog.open',
   WORKSPACE_OPEN_APP: 'workspace.openApp',
   WORKSPACE_OPEN_PALETTE: 'workspace.openPalette',
+  WORKSPACE_UPDATE_CURRENT_TAB: 'workspace.updateCurrentTab',
   SCHEDULER_REGISTER: 'scheduler.register',
   SCHEDULER_UNREGISTER: 'scheduler.unregister',
   CATALOG_CONSUME_PENDING_OPEN: 'catalog.consumePendingOpen',
@@ -41,11 +42,15 @@ export const PLATFORM_BRIDGE_METHODS = {
   DIALOG_SAVE_FOLDER: 'dialog.saveFolder',
   DIALOG_OPEN_IMAGE: 'dialog.openImage',
   DIALOG_OPEN_FILE: 'dialog.openFile',
+  DIALOG_SAVE_FILE: 'dialog.saveFile',
 
   OS_REVEAL: 'os.reveal',
   OS_OPEN_PATH: 'os.openPath',
   OS_TRASH: 'os.trash',
 
+  CLIPBOARD_READ: 'clipboard.read',
+  CLIPBOARD_WRITE: 'clipboard.write',
+
   RENDER_PRINT_HTML: 'render.printHtml',
   RENDER_PREPARE_PAGED_PREVIEW: 'render.preparePagedPreview',
   RENDER_CAPTURE_PAGED_SNAPSHOT: 'render.capturePagedSnapshot',
@@ -123,6 +128,7 @@ export const PLATFORM_BRIDGE_METHODS = {
 
 export const PLATFORM_BRIDGE_METHOD_PREFIXES = {
   RUNTIME: 'runtime.',
+  WORKSPACE: 'workspace.',
   THEME: 'theme.',
   WINDOW: 'window.',
   SETTINGS: 'settings.',
@@ -130,6 +136,7 @@ export const PLATFORM_BRIDGE_METHOD_PREFIXES = {
   FS: 'fs.',
   DIALOG: 'dialog.',
   OS: 'os.',
+  CLIPBOARD: 'clipboard.',
   RENDER: 'render.',
   WATCH: 'watch.',
   ASSETS: 'assets.',

package/src/bridge/network.d.mts

@@ -1,17 +1,17 @@
-export interface PlatformNetworkFetchRequest {
-  url: string
-  method?: string
-  headers?: Record<string, string>
-  body?: string
-}
-
-export interface PlatformNetworkFetchResponse {
-  status: number
-  ok: boolean
-  headers: Record<string, string>
-  body: string
-}
-
-export declare function networkFetch(
-  request: PlatformNetworkFetchRequest,
-): Promise<PlatformNetworkFetchResponse>
+export interface PlatformNetworkFetchRequest {
+  url: string
+  method?: string
+  headers?: Record<string, string>
+  body?: string
+}
+
+export interface PlatformNetworkFetchResponse {
+  status: number
+  ok: boolean
+  headers: Record<string, string>
+  body: string
+}
+
+export declare function networkFetch(
+  request: PlatformNetworkFetchRequest,
+): Promise<PlatformNetworkFetchResponse>

package/src/bridge/network.mjs

@@ -1,22 +1,22 @@
-import { bridge } from './client.mjs'
-import { PLATFORM_BRIDGE_METHODS } from './methods.mjs'
-
-/**
- * Fetch an HTTP(S) resource through the shell network bridge.
- *
- * @param {{
- *   url: string,
- *   method?: string,
- *   headers?: Record<string, string>,
- *   body?: string,
- * }} request
- * @returns {Promise<{
- *   status: number,
- *   ok: boolean,
- *   headers: Record<string, string>,
- *   body: string,
- * }>}
- */
-export async function networkFetch(request) {
-  return bridge.call(PLATFORM_BRIDGE_METHODS.NETWORK_FETCH, [request])
-}
+import { bridge } from './client.mjs'
+import { PLATFORM_BRIDGE_METHODS } from './methods.mjs'
+
+/**
+ * Fetch an HTTP(S) resource through the shell network bridge.
+ *
+ * @param {{
+ *   url: string,
+ *   method?: string,
+ *   headers?: Record<string, string>,
+ *   body?: string,
+ * }} request
+ * @returns {Promise<{
+ *   status: number,
+ *   ok: boolean,
+ *   headers: Record<string, string>,
+ *   body: string,
+ * }>}
+ */
+export async function networkFetch(request) {
+  return bridge.call(PLATFORM_BRIDGE_METHODS.NETWORK_FETCH, [request])
+}