@comfyorg/comfyui-frontend-types 1.30.2 → 1.30.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +62 -1
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -728,6 +728,10 @@ export declare class ComfyApi extends EventTarget {
|
|
|
728
728
|
*/
|
|
729
729
|
user: string;
|
|
730
730
|
socket: WebSocket | null;
|
|
731
|
+
/**
|
|
732
|
+
* Cache Firebase auth store composable function.
|
|
733
|
+
*/
|
|
734
|
+
private authStoreComposable?;
|
|
731
735
|
reportedUnknownMessageTypes: Set<string>;
|
|
732
736
|
/**
|
|
733
737
|
* Get feature flags supported by this frontend client.
|
|
@@ -759,6 +763,18 @@ export declare class ComfyApi extends EventTarget {
|
|
|
759
763
|
internalURL(route: string): string;
|
|
760
764
|
apiURL(route: string): string;
|
|
761
765
|
fileURL(route: string): string;
|
|
766
|
+
/**
|
|
767
|
+
* Gets the Firebase auth store instance using cached composable function.
|
|
768
|
+
* Caches the composable function on first call, then reuses it.
|
|
769
|
+
* Returns null for non-cloud distributions.
|
|
770
|
+
* @returns The Firebase auth store instance, or null if not in cloud
|
|
771
|
+
*/
|
|
772
|
+
private getAuthStore;
|
|
773
|
+
/**
|
|
774
|
+
* Waits for Firebase auth to be initialized before proceeding.
|
|
775
|
+
* Includes 10-second timeout to prevent infinite hanging.
|
|
776
|
+
*/
|
|
777
|
+
private waitForAuthInitialization;
|
|
762
778
|
fetchApi(route: string, options?: RequestInit): Promise<Response>;
|
|
763
779
|
/**
|
|
764
780
|
* Dispatches a custom event.
|
|
@@ -770,6 +786,11 @@ export declare class ComfyApi extends EventTarget {
|
|
|
770
786
|
dispatchCustomEvent<T extends ComplexApiEvents>(type: T, detail: ApiEventTypes[T] | null): boolean;
|
|
771
787
|
/** @deprecated Use {@link dispatchCustomEvent}. */
|
|
772
788
|
dispatchEvent(event: never): boolean;
|
|
789
|
+
/**
|
|
790
|
+
* Creates and connects a WebSocket for realtime updates
|
|
791
|
+
* @param {boolean} isReconnect If the socket is connection is a reconnect attempt
|
|
792
|
+
*/
|
|
793
|
+
private createSocket;
|
|
773
794
|
/**
|
|
774
795
|
* Initialises sockets and realtime updates
|
|
775
796
|
*/
|
|
@@ -936,6 +957,8 @@ export declare class ComfyApi extends EventTarget {
|
|
|
936
957
|
overwrite: boolean;
|
|
937
958
|
}): Promise<Response>;
|
|
938
959
|
listUserDataFullInfo(dir: string): Promise<UserDataFullInfo[]>;
|
|
960
|
+
getGlobalSubgraphData(id: string): Promise<string>;
|
|
961
|
+
getGlobalSubgraphs(): Promise<Record<string, GlobalSubgraphData>>;
|
|
939
962
|
getLogs(): Promise<string>;
|
|
940
963
|
getRawLogs(): Promise<LogsRawResponse>;
|
|
941
964
|
subscribeLogs(enabled: boolean): Promise<void>;
|
|
@@ -1374,6 +1397,16 @@ export declare class ComfyApp {
|
|
|
1374
1397
|
* This is an experimental API and may be changed or removed in the future.
|
|
1375
1398
|
*/
|
|
1376
1399
|
onAuthUserResolved?(user: AuthUserInfo, app: ComfyApp): Promise<void> | void;
|
|
1400
|
+
/**
|
|
1401
|
+
* Fired whenever the auth token is refreshed.
|
|
1402
|
+
* This is an experimental API and may be changed or removed in the future.
|
|
1403
|
+
*/
|
|
1404
|
+
onAuthTokenRefreshed?(): Promise<void> | void;
|
|
1405
|
+
/**
|
|
1406
|
+
* Fired when user logs out.
|
|
1407
|
+
* This is an experimental API and may be changed or removed in the future.
|
|
1408
|
+
*/
|
|
1409
|
+
onAuthUserLogout?(): Promise<void> | void;
|
|
1377
1410
|
[key: string]: any;
|
|
1378
1411
|
}
|
|
1379
1412
|
|
|
@@ -1534,7 +1567,7 @@ export declare class ComfyApp {
|
|
|
1534
1567
|
*/
|
|
1535
1568
|
load({ force }?: {
|
|
1536
1569
|
force?: boolean;
|
|
1537
|
-
}): Promise<LoadedComfyWorkflow>;
|
|
1570
|
+
}): Promise<this & LoadedComfyWorkflow>;
|
|
1538
1571
|
unload(): void;
|
|
1539
1572
|
save(): Promise<UserFile>;
|
|
1540
1573
|
/**
|
|
@@ -2193,6 +2226,14 @@ export declare class ComfyApp {
|
|
|
2193
2226
|
onClick(_options: WidgetEventOptions): void;
|
|
2194
2227
|
}
|
|
2195
2228
|
|
|
2229
|
+
declare type GlobalSubgraphData = {
|
|
2230
|
+
name: string;
|
|
2231
|
+
info: {
|
|
2232
|
+
node_pack: string;
|
|
2233
|
+
};
|
|
2234
|
+
data: string | Promise<string>;
|
|
2235
|
+
};
|
|
2236
|
+
|
|
2196
2237
|
/** Internal; simplifies type definitions. */
|
|
2197
2238
|
declare type GraphOrSubgraph = LGraph | Subgraph;
|
|
2198
2239
|
|
|
@@ -7489,6 +7530,10 @@ export declare class ComfyApp {
|
|
|
7489
7530
|
date?: string;
|
|
7490
7531
|
useCase?: string;
|
|
7491
7532
|
license?: string;
|
|
7533
|
+
/**
|
|
7534
|
+
* Estimated VRAM requirement in bytes.
|
|
7535
|
+
*/
|
|
7536
|
+
vram?: number;
|
|
7492
7537
|
size?: number;
|
|
7493
7538
|
}
|
|
7494
7539
|
|
|
@@ -7675,6 +7720,22 @@ export declare class ComfyApp {
|
|
|
7675
7720
|
* Optional badge label (e.g., "BETA", "ALPHA", "NEW")
|
|
7676
7721
|
*/
|
|
7677
7722
|
label?: string;
|
|
7723
|
+
/**
|
|
7724
|
+
* Visual variant for the badge
|
|
7725
|
+
* - info: Default informational badge (white label, gray background)
|
|
7726
|
+
* - warning: Warning badge (orange theme, higher emphasis)
|
|
7727
|
+
* - error: Error/alert badge (red theme, highest emphasis)
|
|
7728
|
+
*/
|
|
7729
|
+
variant?: 'info' | 'warning' | 'error';
|
|
7730
|
+
/**
|
|
7731
|
+
* Optional icon class (e.g., "pi-exclamation-triangle")
|
|
7732
|
+
* If not provided, variant will determine the default icon
|
|
7733
|
+
*/
|
|
7734
|
+
icon?: string;
|
|
7735
|
+
/**
|
|
7736
|
+
* Optional tooltip text to show on hover
|
|
7737
|
+
*/
|
|
7738
|
+
tooltip?: string;
|
|
7678
7739
|
}
|
|
7679
7740
|
|
|
7680
7741
|
/**
|