@comfyorg/comfyui-desktop-bridge-types 0.7.0 → 0.9.0

package/README.md

@@ -39,6 +39,27 @@ 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 `window.comfyDesktopAuth`
+instead: Desktop's account session, and nothing else of the bridge above.
+
+```ts
+import type { ComfyDesktopHostedAuthBridge } from '@comfyorg/comfyui-desktop-bridge-types'
+
+declare global {
+  interface Window {
+    comfyDesktopAuth?: ComfyDesktopHostedAuthBridge
+  }
+}
+```
+
+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. The object is absent in a
+browser, so a page keeps its own sign-in as the fallback.
+
 ## Provenance
 
 Generated from `src/types/comfyDesktopBridge.ts` in

package/comfyDesktopBridge.d.ts

@@ -124,6 +124,24 @@ export type ComfyDesktop2AuthState =
       email?: string
       workspaceId?: string
     }
+export type ComfyDesktop2BillingHandoffReceiver = 'billing_web' | 'platform'
+export type ComfyDesktop2BillingHandoffIntent = 'top-up' | 'subscription'
+export type ComfyDesktop2BillingHandoff =
+  | {
+      status: 'issued'
+      entryUrl: string
+    }
+  | {
+      status: 'sign_in_again'
+    }
+  | {
+      status: 'refused'
+      code?: string
+      message?: string
+    }
+  | {
+      status: 'disabled'
+    }
 export interface ComfyDesktop2AuthBridge {
   getState(): Promise<ComfyDesktop2AuthState>
   /** The workspace credential, only for an exact workspace Desktop's session
@@ -148,7 +166,27 @@ export interface ComfyDesktop2AuthBridge {
   switchWorkspace(workspaceId: string): Promise<ComfyDesktop2AuthState>
   /** Fires when Desktop signs in, signs out or switches workspace. */
   onChanged(callback: (state: ComfyDesktop2AuthState) => void): () => void
+  /** Issues a billing handoff with Desktop's credential and resolves with only its https entry URL; `intent` picks the landing page and `amountCents` the top-up amount. Absent on older Desktop builds. */
+  issueBillingHandoff?(
+    workspaceId: string,
+    receiver: ComfyDesktop2BillingHandoffReceiver,
+    intent?: ComfyDesktop2BillingHandoffIntent,
+    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'
+  >
+>
 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.7.0",
+  "version": "0.9.0",
   "description": "TypeScript definitions for the Comfy Desktop hosted frontend bridge",
   "type": "module",
   "main": "./index.js",