@puredesktop/create-app 2.1.5 → 2.1.7

package/template/docs/bridge/dialog.md

@@ -1,56 +1,56 @@
-# Dialog
-
-Permission: `filesystem`
-
-Dialog helpers open shell-native file and folder pickers.
-
-Import from the generated app bridge:
-
-```ts
-import {
-  openPlatformFileDialog,
-  openPlatformFolderDialog,
-  openPlatformImageDialog,
-  savePlatformFolderDialog,
-} from '../../src/bridge/platformBridge'
-```
-
-## openPlatformFolderDialog
-
-Opens a folder picker.
-
-```ts
-const folderPath = await openPlatformFolderDialog()
-```
-
-Returns the selected absolute folder path, or `null` when cancelled.
-
-## savePlatformFolderDialog
-
-Opens a folder picker configured for choosing a parent directory.
-
-```ts
-const parentPath = await savePlatformFolderDialog()
-```
-
-Returns the selected absolute folder path, or `null` when cancelled.
-
-## openPlatformImageDialog
-
-Opens an image file picker.
-
-```ts
-const imagePath = await openPlatformImageDialog()
-```
-
-Returns the selected absolute image path, or `null` when cancelled.
-
-## openPlatformFileDialog
-
-Opens a text/document file picker.
-
-```ts
-const filePath = await openPlatformFileDialog()
-```
-
-Returns the selected absolute file path, or `null` when cancelled.
+# Dialog
+
+Permission: `filesystem`
+
+Dialog helpers open shell-native file and folder pickers.
+
+Import from the generated app bridge:
+
+```ts
+import {
+  openPlatformFileDialog,
+  openPlatformFolderDialog,
+  openPlatformImageDialog,
+  savePlatformFolderDialog,
+} from '../../src/bridge/platformBridge'
+```
+
+## openPlatformFolderDialog
+
+Opens a folder picker.
+
+```ts
+const folderPath = await openPlatformFolderDialog()
+```
+
+Returns the selected absolute folder path, or `null` when cancelled.
+
+## savePlatformFolderDialog
+
+Opens a folder picker configured for choosing a parent directory.
+
+```ts
+const parentPath = await savePlatformFolderDialog()
+```
+
+Returns the selected absolute folder path, or `null` when cancelled.
+
+## openPlatformImageDialog
+
+Opens an image file picker.
+
+```ts
+const imagePath = await openPlatformImageDialog()
+```
+
+Returns the selected absolute image path, or `null` when cancelled.
+
+## openPlatformFileDialog
+
+Opens a text/document file picker.
+
+```ts
+const filePath = await openPlatformFileDialog()
+```
+
+Returns the selected absolute file path, or `null` when cancelled.

package/template/docs/bridge/fs.md

@@ -1,95 +1,95 @@
-# Filesystem
-
-Permission: `filesystem`
-
-Filesystem helpers read, write, list, rename, delete, and preview files through
-the shell.
-
-Import from the generated app bridge:
-
-```ts
-import {
-  createPlatformFolder,
-  deletePlatformFile,
-  listPlatformFiles,
-  readPlatformTextFile,
-  renamePlatformFile,
-  writePlatformTextFile,
-} from '../../src/bridge/platformBridge'
-```
-
-## listPlatformFiles
-
-Lists a folder.
-
-```ts
-const listing = await listPlatformFiles('/absolute/folder')
-```
-
-Returns:
-
-- `rootPath`: listed folder path.
-- `parentPath`: parent folder path or `null`.
-- `entries`: file and folder entries with `path`, `name`, `kind`, size,
-  modified time, MIME type, extension, and directory flag.
-
-## readPlatformTextFile
-
-Reads a text file.
-
-```ts
-const content = await readPlatformTextFile('/absolute/file.md')
-```
-
-Returns the file contents as a string.
-
-## writePlatformTextFile
-
-Writes a text file.
-
-```ts
-await writePlatformTextFile('/absolute/file.md', '# Notes\n')
-```
-
-Returns `{ ok: true }`.
-
-## createPlatformFolder
-
-Creates a folder under a parent directory.
-
-```ts
-const folder = await createPlatformFolder('/absolute/parent', 'Project')
-```
-
-Returns `{ path }` for the created folder.
-
-## renamePlatformFile
-
-Renames a file or folder within its current parent directory.
-
-```ts
-const renamed = await renamePlatformFile('/absolute/file.md', 'renamed.md')
-```
-
-Returns `{ path }` for the renamed path.
-
-## deletePlatformFile
-
-Deletes a file or folder.
-
-```ts
-await deletePlatformFile('/absolute/file.md')
-await deletePlatformFile('/absolute/folder', true)
-```
-
-Pass `true` for recursive folder deletion. Returns `{ ok: true }`.
-
-## Preview And Binary Helpers
-
-The same domain also exports:
-
-- `readPlatformFilePreview(path, maxBytes?)`
-- `readPlatformFilePreviewUrl(path)`
-- `readPlatformFileBinary(path, maxBytes?)`
-- `readPlatformFileBinaryDataUrl(path, maxBytes?)`
-- `writePlatformFileBinary(path, base64)`
+# Filesystem
+
+Permission: `filesystem`
+
+Filesystem helpers read, write, list, rename, delete, and preview files through
+the shell.
+
+Import from the generated app bridge:
+
+```ts
+import {
+  createPlatformFolder,
+  deletePlatformFile,
+  listPlatformFiles,
+  readPlatformTextFile,
+  renamePlatformFile,
+  writePlatformTextFile,
+} from '../../src/bridge/platformBridge'
+```
+
+## listPlatformFiles
+
+Lists a folder.
+
+```ts
+const listing = await listPlatformFiles('/absolute/folder')
+```
+
+Returns:
+
+- `rootPath`: listed folder path.
+- `parentPath`: parent folder path or `null`.
+- `entries`: file and folder entries with `path`, `name`, `kind`, size,
+  modified time, MIME type, extension, and directory flag.
+
+## readPlatformTextFile
+
+Reads a text file.
+
+```ts
+const content = await readPlatformTextFile('/absolute/file.md')
+```
+
+Returns the file contents as a string.
+
+## writePlatformTextFile
+
+Writes a text file.
+
+```ts
+await writePlatformTextFile('/absolute/file.md', '# Notes\n')
+```
+
+Returns `{ ok: true }`.
+
+## createPlatformFolder
+
+Creates a folder under a parent directory.
+
+```ts
+const folder = await createPlatformFolder('/absolute/parent', 'Project')
+```
+
+Returns `{ path }` for the created folder.
+
+## renamePlatformFile
+
+Renames a file or folder within its current parent directory.
+
+```ts
+const renamed = await renamePlatformFile('/absolute/file.md', 'renamed.md')
+```
+
+Returns `{ path }` for the renamed path.
+
+## deletePlatformFile
+
+Deletes a file or folder.
+
+```ts
+await deletePlatformFile('/absolute/file.md')
+await deletePlatformFile('/absolute/folder', true)
+```
+
+Pass `true` for recursive folder deletion. Returns `{ ok: true }`.
+
+## Preview And Binary Helpers
+
+The same domain also exports:
+
+- `readPlatformFilePreview(path, maxBytes?)`
+- `readPlatformFilePreviewUrl(path)`
+- `readPlatformFileBinary(path, maxBytes?)`
+- `readPlatformFileBinaryDataUrl(path, maxBytes?)`
+- `writePlatformFileBinary(path, base64)`

package/template/docs/bridge/network.md

@@ -1,38 +1,38 @@
-# Network
-
-Permission: `network`
-
-Use `networkFetch` for HTTP(S) requests through the shell.
-
-Import from the generated app bridge:
-
-```ts
-import { networkFetch } from '../../src/bridge/platformBridge'
-```
-
-Example:
-
-```ts
-const response = await networkFetch({
-  url: 'https://example.com/api/items',
-  method: 'GET',
-})
-
-if (!response.ok) {
-  throw new Error(`Request failed with ${response.status}`)
-}
-```
-
-Request fields:
-
-- `url`: HTTP or HTTPS URL.
-- `method`: optional, defaults to `GET`.
-- `headers`: optional string map.
-- `body`: optional string.
-
-Response fields:
-
-- `status`: HTTP status code.
-- `ok`: `true` for 2xx responses.
-- `headers`: response headers as a string map.
-- `body`: response body as text.
+# Network
+
+Permission: `network`
+
+Use `networkFetch` for HTTP(S) requests through the shell.
+
+Import from the generated app bridge:
+
+```ts
+import { networkFetch } from '../../src/bridge/platformBridge'
+```
+
+Example:
+
+```ts
+const response = await networkFetch({
+  url: 'https://example.com/api/items',
+  method: 'GET',
+})
+
+if (!response.ok) {
+  throw new Error(`Request failed with ${response.status}`)
+}
+```
+
+Request fields:
+
+- `url`: HTTP or HTTPS URL.
+- `method`: optional, defaults to `GET`.
+- `headers`: optional string map.
+- `body`: optional string.
+
+Response fields:
+
+- `status`: HTTP status code.
+- `ok`: `true` for 2xx responses.
+- `headers`: response headers as a string map.
+- `body`: response body as text.

package/template/docs/bridge/settings.md

@@ -1,63 +1,63 @@
-# Settings
-
-Permission: `settings`
-
-Settings helpers read and update user preferences through the shell. App
-settings are stored inside user preferences under the current app's slug.
-
-Import from the generated app bridge:
-
-```ts
-import {
-  getPlatformAppSettings,
-  getPlatformPreferences,
-  patchPlatformPreferences,
-  updatePlatformAppSettings,
-} from '../../src/bridge/platformBridge'
-```
-
-## getPlatformAppSettings
-
-Reads settings for the current app slug.
-
-```ts
-const settings = await getPlatformAppSettings(APP_SLUG)
-```
-
-The shell allows plugin frames to access only their own app settings.
-
-## updatePlatformAppSettings
-
-Patches settings for the current app slug.
-
-```ts
-const next = await updatePlatformAppSettings({
-  appSlug: APP_SLUG,
-  patch: { workspacePath: '/absolute/folder' },
-})
-```
-
-Returns the merged app settings object.
-
-## getPlatformPreferences
-
-Reads shell user preferences.
-
-```ts
-const prefs = await getPlatformPreferences()
-```
-
-Common fields include the working directory, theme, app settings, user profile,
-and agent defaults.
-
-## patchPlatformPreferences
-
-Patches shell user preferences.
-
-```ts
-const next = await patchPlatformPreferences({
-  theme: 'dark',
-})
-```
-
-Returns the merged user preferences object.
+# Settings
+
+Permission: `settings`
+
+Settings helpers read and update user preferences through the shell. App
+settings are stored inside user preferences under the current app's slug.
+
+Import from the generated app bridge:
+
+```ts
+import {
+  getPlatformAppSettings,
+  getPlatformPreferences,
+  patchPlatformPreferences,
+  updatePlatformAppSettings,
+} from '../../src/bridge/platformBridge'
+```
+
+## getPlatformAppSettings
+
+Reads settings for the current app slug.
+
+```ts
+const settings = await getPlatformAppSettings(APP_SLUG)
+```
+
+The shell allows plugin frames to access only their own app settings.
+
+## updatePlatformAppSettings
+
+Patches settings for the current app slug.
+
+```ts
+const next = await updatePlatformAppSettings({
+  appSlug: APP_SLUG,
+  patch: { workspacePath: '/absolute/folder' },
+})
+```
+
+Returns the merged app settings object.
+
+## getPlatformPreferences
+
+Reads shell user preferences.
+
+```ts
+const prefs = await getPlatformPreferences()
+```
+
+Common fields include the working directory, theme, app settings, user profile,
+and agent defaults.
+
+## patchPlatformPreferences
+
+Patches shell user preferences.
+
+```ts
+const next = await patchPlatformPreferences({
+  theme: 'dark',
+})
+```
+
+Returns the merged user preferences object.

package/template/docs/bridge/storage.md

@@ -1,48 +1,48 @@
-# Storage
-
-Permission: `filesystem`
-
-Storage helpers read and write JSON files in the shell-managed PureDesktop data
-folder. These helpers use the same bridge path as the exposed
-`storage.readJson` and `storage.writeJson` methods.
-
-Import from the generated app bridge:
-
-```ts
-import {
-  readPlatformStorageJson,
-  writePlatformStorageJson,
-} from '../../src/bridge/platformBridge'
-```
-
-## readPlatformStorageJson
-
-Reads an app JSON store file.
-
-```ts
-const result = await readPlatformStorageJson({
-  appSlug: APP_SLUG,
-  fileName: 'items.json',
-})
-```
-
-Returns:
-
-- `path`: resolved storage path.
-- `value`: parsed JSON value, or `null` when the file is absent.
-
-## writePlatformStorageJson
-
-Writes an app JSON store file.
-
-```ts
-await writePlatformStorageJson({
-  appSlug: APP_SLUG,
-  fileName: 'items.json',
-  value: { items: [] },
-})
-```
-
-Returns `{ path, ok: true }`.
-
-Storage file names must be file names ending with `.json`.
+# Storage
+
+Permission: `filesystem`
+
+Storage helpers read and write JSON files in the shell-managed PureDesktop data
+folder. These helpers use the same bridge path as the exposed
+`storage.readJson` and `storage.writeJson` methods.
+
+Import from the generated app bridge:
+
+```ts
+import {
+  readPlatformStorageJson,
+  writePlatformStorageJson,
+} from '../../src/bridge/platformBridge'
+```
+
+## readPlatformStorageJson
+
+Reads an app JSON store file.
+
+```ts
+const result = await readPlatformStorageJson({
+  appSlug: APP_SLUG,
+  fileName: 'items.json',
+})
+```
+
+Returns:
+
+- `path`: resolved storage path.
+- `value`: parsed JSON value, or `null` when the file is absent.
+
+## writePlatformStorageJson
+
+Writes an app JSON store file.
+
+```ts
+await writePlatformStorageJson({
+  appSlug: APP_SLUG,
+  fileName: 'items.json',
+  value: { items: [] },
+})
+```
+
+Returns `{ path, ok: true }`.
+
+Storage file names must be file names ending with `.json`.