@comfyorg/comfyui-desktop-bridge-types 0.8.0 → 0.10.0

package/README.md

@@ -39,6 +39,41 @@ async function openModelAccessPage(url: string): Promise<void> {
 every top-level member required, so Desktop's preload cannot claim the contract
 while omitting part of it.
 
+## Comfy pages hosted in Desktop's Apps view
+
+A Comfy page that Desktop shows in its Apps view gets two objects instead, and
+nothing else of the bridge above: `window.comfyDesktopAuth`, Desktop's account
+session, and `window.comfyDesktopLocal`, a ComfyUI on this computer.
+
+```ts
+import type {
+  ComfyDesktopHostedAuthBridge,
+  ComfyDesktopHostedLocalBridge
+} from '@comfyorg/comfyui-desktop-bridge-types'
+
+declare global {
+  interface Window {
+    comfyDesktopAuth?: ComfyDesktopHostedAuthBridge
+    comfyDesktopLocal?: ComfyDesktopHostedLocalBridge
+  }
+}
+```
+
+The page reads the session with `getState()`, follows it with `onChanged()`,
+asks for the workspace credential with `getWorkspaceToken(workspaceId)` each
+time it calls Comfy Cloud, and starts a sign-in with `requestSignIn()`. It
+cannot sign Desktop out or switch workspace.
+
+For a run on this computer the page asks `getLocal({ minVersion })` which of
+the person's builds Desktop would use, starts it with `startLocal()`, and then
+talks to it through `localFetch()`. Desktop forwards only the calls a run
+needs, and only for runs the page started; `onLocalEvent()` carries ComfyUI's
+updates for those runs. `localDownload()` saves a safetensors model from
+Hugging Face into that build's models folder.
+
+Both objects are absent in a browser, so a page keeps its own sign-in and its
+own way to reach a local ComfyUI as the fallback.
+
 ## Provenance
 
 Generated from `src/types/comfyDesktopBridge.ts` in

package/comfyDesktopBridge.d.ts

@@ -174,6 +174,98 @@ export interface ComfyDesktop2AuthBridge {
     amountCents?: number
   ): Promise<ComfyDesktop2BillingHandoff>
 }
+/**
+ * Desktop's own Comfy account session, as a Comfy page hosted in Desktop's
+ * Apps view sees it. Desktop exposes it to that page as
+ * `window.comfyDesktopAuth`. The page can read the session, hold the
+ * workspace and partner-node credentials, and start a sign-in; it cannot sign
+ * Desktop out or switch workspace.
+ */
+export type ComfyDesktopHostedAuthBridge = Required<
+  Pick<
+    ComfyDesktop2AuthBridge,
+    'getState' | 'getWorkspaceToken' | 'getPartnerNodeToken' | 'requestSignIn' | 'onChanged'
+  >
+>
+/** What a hosted page needs from the ComfyUI on this computer. */
+export interface ComfyDesktopLocalRequirements {
+  /** The oldest ComfyUI the page can run on, such as `0.41.0`. */
+  minVersion?: string
+}
+/**
+ * The ComfyUI on this computer that Desktop uses for a hosted page.
+ * `running`: it answers now. `stopped`: one of the person's builds fits and
+ * `startLocal` starts it. `unsupported`: no build here can run the page, and
+ * `error` says why in words for the person.
+ */
+export interface ComfyDesktopLocalComfy {
+  state: 'running' | 'stopped' | 'unsupported'
+  /** True when it is one of the person's own builds. */
+  own?: boolean
+  name?: string
+  version?: string
+  /** The `client_id` Desktop listens with; updates for runs sent through `localFetch` arrive on `onLocalEvent`. */
+  clientId?: string
+  error?: string
+}
+/**
+ * One call to that ComfyUI. Desktop forwards only what a run needs:
+ * `GET /queue`, `GET /history/<run>`, `GET /view`, `GET /object_info/<node>`,
+ * `POST /prompt`, `POST /upload/image`, `POST /queue` to take a run out, and
+ * `POST /interrupt` to stop one. History, files, removal and stopping work
+ * only for runs the page started through this bridge.
+ */
+export interface ComfyDesktopLocalRequest {
+  method?: 'GET' | 'POST'
+  path: string
+  /** JSON text, or a file's bytes for `/upload/image`. */
+  body?: string | Uint8Array
+  /** The name to save an upload under. */
+  fileName?: string
+}
+/** ComfyUI's answer, or status 403 for a call Desktop does not forward. */
+export interface ComfyDesktopLocalAnswer {
+  status: number
+  contentType: string
+  body: Uint8Array
+}
+/** A safetensors file on Hugging Face to save as `name` in the models folder `folder`. */
+export interface ComfyDesktopLocalModel {
+  url: string
+  folder: string
+  name: string
+}
+export interface ComfyDesktopLocalDownload {
+  state: 'done' | 'failed' | 'cancelled'
+  error?: string
+}
+/**
+ * A model download's progress (`type: 'download'`, with `name`, `done` and
+ * `total` bytes in `data`), or one ComfyUI socket message about a run the page
+ * started (`execution_start`, `executing`, `progress`, `progress_state`,
+ * `execution_success`, `execution_error`, `execution_interrupted`).
+ */
+export interface ComfyDesktopLocalEvent {
+  type: string
+  data?: Record<string, unknown>
+}
+/**
+ * A ComfyUI on this computer, run by Desktop, for a Comfy page hosted in
+ * Desktop's Apps view. Desktop exposes it to that page as
+ * `window.comfyDesktopLocal`. The page builds and follows its own runs;
+ * Desktop finds or starts the ComfyUI, forwards the page's calls to it and
+ * downloads a model the page asks for.
+ */
+export interface ComfyDesktopHostedLocalBridge {
+  getLocal(want?: ComfyDesktopLocalRequirements): Promise<ComfyDesktopLocalComfy>
+  /** Starts the ComfyUI if it is stopped and resolves once it answers, or with the state and `error` if it could not start. */
+  startLocal(want?: ComfyDesktopLocalRequirements): Promise<ComfyDesktopLocalComfy>
+  /** Rejects when no ComfyUI is running to forward to. */
+  localFetch(request: ComfyDesktopLocalRequest): Promise<ComfyDesktopLocalAnswer>
+  /** Downloads into the running ComfyUI's models folder and resolves when the file is there. */
+  localDownload(model: ComfyDesktopLocalModel): Promise<ComfyDesktopLocalDownload>
+  onLocalEvent(callback: (event: ComfyDesktopLocalEvent) => void): () => void
+}
 export interface ComfyDesktop2TerminalBridge {
   subscribe(installationId?: string): Promise<TerminalRestore>
   unsubscribe(installationId?: string): Promise<void>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@comfyorg/comfyui-desktop-bridge-types",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "TypeScript definitions for the Comfy Desktop hosted frontend bridge",
   "type": "module",
   "main": "./index.js",