@comfyorg/comfyui-desktop-bridge-types 0.2.1 → 0.4.0

package/comfyDesktopBridge.d.ts

@@ -14,7 +14,61 @@ export interface ComfyDownloadProgress {
   status: 'pending' | 'downloading' | 'paused' | 'completed' | 'error' | 'cancelled'
   error?: string
   isImage?: boolean
+  /**
+   * The template inputs this transfer serves, named by the host on every
+   * event. A retry mints a new job id, and a renderer that dropped the old
+   * mapping has no way back to it; naming the inputs here removes the need
+   * to correlate by id at all.
+   */
+  templateInputs?: ComfyTemplateInputReference[]
 }
+export interface ComfyTemplateInputReference {
+  templateId: string
+  assetId: string
+}
+export interface ComfyTemplateInputAssetDownload {
+  downloadId: string
+  filename: string
+  progress: number
+  receivedBytes?: number
+  totalBytes?: number
+  status: ComfyDownloadProgress['status']
+  error?: string
+}
+export interface ComfyTemplateInputDownloadProgress extends ComfyTemplateInputAssetDownload {
+  /** Every template asset currently sharing this managed download job. */
+  templateInputs: ComfyTemplateInputReference[]
+}
+export interface ComfyTemplateInputAsset {
+  /** Opaque, template-scoped identifier accepted by `downloadTemplateInputAsset`. */
+  assetId: string
+  filename: string
+  mediaType: 'image' | 'video' | 'audio'
+  /** Desktop-resolved public URL for previewing this declared template asset. */
+  previewUrl: string
+  availability: 'present' | 'missing' | 'unknown'
+  /** Present when this exact asset destination already has a managed job. */
+  activeDownload?: ComfyTemplateInputAssetDownload
+}
+export type ComfyTemplateInputAssetDownloadResult =
+  | {
+      status: 'already-present'
+      /**
+       * No job exists for a file that is already on disk, so nothing would
+       * report it. Naming it lets the host emit one terminal progress event,
+       * which is the only channel a renderer watches.
+       */
+      filename: string
+    }
+  | {
+      status: 'accepted' | 'joined'
+      /** Admission snapshot seeds UI state even if the first IPC event raced ahead. */
+      download: ComfyTemplateInputAssetDownload
+    }
+  | {
+      status: 'not-started'
+      reason: 'invalid-request' | 'not-declared' | 'unavailable'
+    }
 export interface TerminalRestore {
   buffer: string[]
   size: {
@@ -51,6 +105,39 @@ export type ComfyDesktop2FirebaseAuthState =
       status: 'signed_in'
       userId: string
     }
+/**
+ * Desktop's own Comfy account session, as the hosted local ComfyUI view sees it.
+ * `disabled` means Desktop does not share its session with this view (ops flag
+ * off, or the view is not a trusted loopback ComfyUI).
+ */
+export type ComfyDesktop2AuthState =
+  | {
+      status: 'disabled'
+    }
+  | {
+      status: 'signed_out'
+    }
+  | {
+      status: 'signed_in'
+      /** Comfy user id (the access token's `sub`), not a Firebase uid. */
+      userId: string
+      email?: string
+      workspaceId?: string
+    }
+export interface ComfyDesktop2AuthBridge {
+  getState(): Promise<ComfyDesktop2AuthState>
+  /** The workspace credential, only for an exact workspace Desktop's session
+   *  is scoped to; null when signed out, disabled, or the scope is missing,
+   *  malformed or different. The refresh token never leaves Desktop. */
+  getWorkspaceToken(workspaceId: string): Promise<string | null>
+  /** Runs Desktop's browser sign-in and resolves with the resulting state. */
+  requestSignIn(): Promise<ComfyDesktop2AuthState>
+  /** Signs Desktop out of its account (every view follows) and resolves with
+   *  the resulting state; Desktop may keep the session if an install needs it. */
+  signOut(): Promise<ComfyDesktop2AuthState>
+  /** Fires when Desktop signs in, signs out or switches workspace. */
+  onChanged(callback: (state: ComfyDesktop2AuthState) => void): () => void
+}
 export interface ComfyDesktop2TerminalBridge {
   subscribe(installationId?: string): Promise<TerminalRestore>
   unsubscribe(installationId?: string): Promise<void>
@@ -86,6 +173,19 @@ export interface ComfyDesktop2Bridge {
   openModelAccessPage?: (url: string) => Promise<boolean>
   downloadModel?: (url: string, filename: string, directory: string) => Promise<boolean>
   downloadAsset?: (url: string, filename: string, authToken?: string) => Promise<boolean>
+  /** Resolve only assets declared by this template. `null` means Desktop cannot
+   *  authorize the caller or resolve the metadata; `[]` means the resolved
+   *  template declares none. */
+  getTemplateInputAssets?: (templateId: string) => Promise<ComfyTemplateInputAsset[] | null>
+  /** Start or join the managed download for one declared template asset. */
+  downloadTemplateInputAsset?: (
+    templateId: string,
+    assetId: string
+  ) => Promise<ComfyTemplateInputAssetDownloadResult>
+  /** Download events decorated with the template asset identities that own the job. */
+  onTemplateInputDownloadProgress?: (
+    callback: (data: ComfyTemplateInputDownloadProgress) => void
+  ) => () => void
   pauseDownload?: (url: string) => Promise<boolean>
   resumeDownload?: (url: string) => Promise<boolean>
   cancelDownload?: (url: string) => Promise<boolean>
@@ -94,6 +194,8 @@ export interface ComfyDesktop2Bridge {
   Terminal?: ComfyDesktop2TerminalBridge
   Logs?: ComfyDesktop2LogsBridge
   Telemetry?: ComfyDesktop2TelemetryBridge
+  /** Absent on Desktop builds older than this bridge. */
+  Auth?: ComfyDesktop2AuthBridge
 }
 /**
  * The `-?` mapper intentionally requires every top-level bridge member.

package/package.json

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