@comfyorg/comfyui-desktop-bridge-types 0.1.0 → 0.1.2

package/comfyDesktopBridge.d.ts

@@ -0,0 +1,66 @@
+export interface ComfyDownloadProgress {
+    url: string;
+    filename: string;
+    directory?: string;
+    progress: number;
+    receivedBytes?: number;
+    totalBytes?: number;
+    speedBytesPerSec?: number;
+    etaSeconds?: number;
+    status: 'pending' | 'downloading' | 'paused' | 'completed' | 'error' | 'cancelled';
+    error?: string;
+    isImage?: boolean;
+}
+export interface TerminalRestore {
+    buffer: string[];
+    size: {
+        cols: number;
+        rows: number;
+    };
+    exited: boolean;
+}
+export interface LogsRestore {
+    installationId: string;
+    buffer: string[];
+}
+export interface LogsOutputMsg {
+    installationId: string;
+    text: string;
+}
+export type ComfyDesktop2TelemetryValue = string | number | boolean | null;
+export type ComfyDesktop2TelemetryProperties = Record<string, ComfyDesktop2TelemetryValue | ComfyDesktop2TelemetryValue[]>;
+export interface ComfyDesktop2TerminalBridge {
+    subscribe(installationId?: string): Promise<TerminalRestore>;
+    unsubscribe(installationId?: string): Promise<void>;
+    write(data: string, installationId?: string): Promise<void>;
+    resize(cols: number, rows: number, installationId?: string): Promise<void>;
+    restart(installationId?: string): Promise<TerminalRestore>;
+    openPopout(): Promise<void>;
+    onOutput(callback: (data: string) => void): () => void;
+    onExited(callback: () => void): () => void;
+}
+export interface ComfyDesktop2LogsBridge {
+    subscribe(installationId?: string): Promise<LogsRestore>;
+    unsubscribe(installationId?: string): Promise<void>;
+    openPopout(): Promise<void>;
+    onOutput(callback: (msg: LogsOutputMsg) => void): () => void;
+}
+export interface ComfyDesktop2TelemetryBridge {
+    capture(event: string, properties?: ComfyDesktop2TelemetryProperties): void;
+}
+export interface ComfyDesktop2Bridge {
+    isRemote(): boolean;
+    downloadModel?: (url: string, filename: string, directory: string) => Promise<boolean>;
+    downloadAsset?: (url: string, filename: string, authToken?: string) => Promise<boolean>;
+    pauseDownload?: (url: string) => Promise<boolean>;
+    resumeDownload?: (url: string) => Promise<boolean>;
+    cancelDownload?: (url: string) => Promise<boolean>;
+    onDownloadProgress?: (callback: (data: ComfyDownloadProgress) => void) => () => void;
+    reportTheme?: (bg: string, text: string) => void;
+    Terminal?: ComfyDesktop2TerminalBridge;
+    Logs?: ComfyDesktop2LogsBridge;
+    Telemetry?: ComfyDesktop2TelemetryBridge;
+}
+export type ComfyDesktop2BridgeImplementation = {
+    [K in keyof ComfyDesktop2Bridge]-?: NonNullable<ComfyDesktop2Bridge[K]>;
+};

package/index.d.ts

@@ -1,65 +1 @@
-export interface ComfyDownloadProgress {
-    url: string;
-    filename: string;
-    directory?: string;
-    progress: number;
-    receivedBytes?: number;
-    totalBytes?: number;
-    speedBytesPerSec?: number;
-    etaSeconds?: number;
-    status: 'pending' | 'downloading' | 'paused' | 'completed' | 'error' | 'cancelled';
-    error?: string;
-    isImage?: boolean;
-}
-export interface TerminalRestore {
-    buffer: string[];
-    size: {
-        cols: number;
-        rows: number;
-    };
-    exited: boolean;
-}
-export interface LogsRestore {
-    installationId: string;
-    buffer: string[];
-}
-export interface LogsOutputMsg {
-    installationId: string;
-    text: string;
-}
-export type ComfyDesktop2TelemetryValue = string | number | boolean | null;
-export type ComfyDesktop2TelemetryProperties = Record<string, ComfyDesktop2TelemetryValue | ComfyDesktop2TelemetryValue[]>;
-export interface ComfyDesktop2TerminalBridge {
-    subscribe(installationId?: string): Promise<TerminalRestore>;
-    unsubscribe(installationId?: string): Promise<void>;
-    write(data: string, installationId?: string): Promise<void>;
-    resize(cols: number, rows: number, installationId?: string): Promise<void>;
-    restart(installationId?: string): Promise<TerminalRestore>;
-    openPopout(): Promise<void>;
-    onOutput(callback: (data: string) => void): () => void;
-    onExited(callback: () => void): () => void;
-}
-export interface ComfyDesktop2LogsBridge {
-    subscribe(installationId?: string): Promise<LogsRestore>;
-    unsubscribe(installationId?: string): Promise<void>;
-    openPopout(): Promise<void>;
-    onOutput(callback: (msg: LogsOutputMsg) => void): () => void;
-}
-export interface ComfyDesktop2TelemetryBridge {
-    capture(event: string, properties?: ComfyDesktop2TelemetryProperties): void;
-}
-export interface ComfyDesktop2Bridge {
-    downloadModel?: (url: string, filename: string, directory: string) => Promise<boolean>;
-    downloadAsset?: (url: string, filename: string, authToken?: string) => Promise<boolean>;
-    pauseDownload?: (url: string) => Promise<boolean>;
-    resumeDownload?: (url: string) => Promise<boolean>;
-    cancelDownload?: (url: string) => Promise<boolean>;
-    onDownloadProgress?: (callback: (data: ComfyDownloadProgress) => void) => () => void;
-    reportTheme?: (bg: string, text: string) => void;
-    Terminal?: ComfyDesktop2TerminalBridge;
-    Logs?: ComfyDesktop2LogsBridge;
-    Telemetry?: ComfyDesktop2TelemetryBridge;
-}
-export type ComfyDesktop2BridgeImplementation = {
-    [K in keyof ComfyDesktop2Bridge]-?: NonNullable<ComfyDesktop2Bridge[K]>;
-};
+export * from './comfyDesktopBridge.js'

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@comfyorg/comfyui-desktop-bridge-types",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "TypeScript definitions for the Comfy Desktop hosted frontend bridge",
   "type": "module",
   "main": "./index.js",
   "types": "./index.d.ts",
   "files": [
+    "comfyDesktopBridge.d.ts",
     "index.d.ts",
     "index.js"
   ],