import { LiteGraph, type ContextMenuItem, type LGraphNode, type Vector2, LConnectionKind, LLink, LGraphCanvas, type SlotType, TitleMode, type SlotLayout, LGraph, type INodeInputSlot, type ITextWidget, type INodeOutputSlot, type SerializedLGraphNode, BuiltInSlotType, type PropertyLayout, type IComboWidget, NodeMode, type INumberWidget } from "@litegraph-ts/core"; import ComfyGraphNode, { type ComfyGraphNodeProperties } from "./ComfyGraphNode"; import type { SvelteComponentDev } from "svelte/internal"; import { Watch } from "@litegraph-ts/nodes-basic"; import type IComfyInputSlot from "$lib/IComfyInputSlot"; import { writable, type Unsubscriber, type Writable, get } from "svelte/store"; import { clamp, convertComfyOutputToGradio, range } from "$lib/utils" import layoutState from "$lib/stores/layoutState"; import type { FileData as GradioFileData } from "@gradio/upload"; import queueState from "$lib/stores/queueState"; import ComboWidget from "$lib/widgets/ComboWidget.svelte"; import RangeWidget from "$lib/widgets/RangeWidget.svelte"; import TextWidget from "$lib/widgets/TextWidget.svelte"; import GalleryWidget from "$lib/widgets/GalleryWidget.svelte"; import ButtonWidget from "$lib/widgets/ButtonWidget.svelte"; import CheckboxWidget from "$lib/widgets/CheckboxWidget.svelte"; import RadioWidget from "$lib/widgets/RadioWidget.svelte"; import ImageUploadWidget from "$lib/widgets/ImageUploadWidget.svelte"; /* * NOTE: If you want to add a new widget but it has the same input/output type * as another one of the existing widgets, best to create a new "variant" of * that widget instead. * * - Go to layoutState, look for `ALL_ATTRIBUTES,` insert or find a "variant" * attribute and set `validNodeTypes` to the type of the litegraph node * - Add a new entry in the `values` array, like "knob" or "dial" for ComfySliderWidget * - Add an {#if widget.attrs.variant === <...>} statement in the corresponding Svelte component * * Also, BEWARE of calling setOutputData() and triggerSlot() on the same frame! * You will have to either implement an internal delay on the event triggering * or use an Event Delay node to ensure the output slot data can propagate to * the rest of the graph first (see `delayChangedEvent` for details) */ export interface ComfyWidgetProperties extends ComfyGraphNodeProperties { defaultValue: any } /* * A node that is tied to a UI widget in the frontend. When the frontend's * widget is changed, the value of the first output in the node is updated * in the litegraph instance. */ export abstract class ComfyWidgetNode extends ComfyGraphNode { abstract properties: ComfyWidgetProperties; value: Writable propsChanged: Writable = writable(0) // dummy to indicate if props changed unsubscribe: Unsubscriber; /** Svelte class for the frontend logic */ abstract svelteComponentType: typeof SvelteComponentDev /** If false, user manually set min/max/step, and should not be autoinherited from connected input */ autoConfig: boolean = true; copyFromInputLink: boolean = true; /** * If true wait until next frame update to trigger the changed event. * Reason is, if the event is triggered immediately then other stuff that wants to run * their own onExecute on the output value won't have completed yet. */ delayChangedEvent: boolean = true; private _aboutToChange: number = 0; private _aboutToChangeValue: any = null; abstract defaultValue: T; /** Names of properties to add as inputs */ // shownInputProperties: string[] = [] /** Names of properties to add as outputs */ private shownOutputProperties: Record = {} outputProperties: { name: string, type: string }[] = [] override isBackendNode = false; override serialize_widgets = true; // TODO these are bad, create override methods instead // input slots inputIndex: number = 0; // output slots outputIndex: number | null = 0; changedIndex: number | null = 1; displayWidget: ITextWidget; override size: Vector2 = [60, 40]; constructor(name: string, value: T) { const color = LGraphCanvas.node_colors["blue"] super(name) this.value = writable(value) this.color ||= color.color this.bgColor ||= color.bgColor this.displayWidget = this.addWidget( "text", "Value", "" ); this.displayWidget.disabled = true; // prevent editing this.unsubscribe = this.value.subscribe(this.onValueUpdated.bind(this)) } addPropertyAsOutput(propertyName: string, type: string) { if (this.shownOutputProperties[propertyName]) return; if (!(propertyName in this.properties)) { throw `No property named ${propertyName} found!` } this.shownOutputProperties[propertyName] = { type, index: this.outputs.length } this.addOutput(propertyName, type) } formatValue(value: any): string { return Watch.toString(value) } override changeMode(modeTo: NodeMode): boolean { const result = super.changeMode(modeTo); this.notifyPropsChanged(); return result; } private onValueUpdated(value: any) { console.debug("[Widget] valueUpdated", this, value) this.displayWidget.value = this.formatValue(value) if (this.outputIndex !== null && this.outputs.length >= this.outputIndex) { this.setOutputData(this.outputIndex, get(this.value)) } if (this.changedIndex !== null && this.outputs.length >= this.changedIndex) { if (!this.delayChangedEvent) this.triggerChangeEvent(get(this.value)) else { this._aboutToChange = 2; // wait 1.5-2 frames, in case we're already in the middle of one this._aboutToChangeValue = get(this.value); } } } private triggerChangeEvent(value: any) { const changedOutput = this.outputs[this.changedIndex] if (changedOutput.type === BuiltInSlotType.EVENT) this.triggerSlot(this.changedIndex, value) } setValue(value: any) { this.value.set(value) } override onPropertyChanged(property: string, value: any, prevValue?: any) { const data = this.shownOutputProperties[property] if (data) this.setOutputData(data.index, value) } /* * Logic to run if this widget can be treated as output (slider, combo, text) */ override onExecute(param: any, options: object) { if (this.copyFromInputLink) { if (this.inputs.length >= this.inputIndex) { const data = this.getInputData(this.inputIndex) if (data != null) { // TODO can "null" be a legitimate value here? this.setValue(data) } } } if (this.outputs.length >= this.outputIndex) { this.setOutputData(this.outputIndex, get(this.value)) } for (const propName in this.shownOutputProperties) { const data = this.shownOutputProperties[propName] this.setOutputData(data.index, this.properties[propName]) } // Fire a pending change event after one full step of the graph has // finished processing if (this._aboutToChange > 0) { this._aboutToChange -= 1 if (this._aboutToChange <= 0) { const value = this._aboutToChangeValue; this._aboutToChange = 0; this._aboutToChangeValue = null; this.triggerChangeEvent(value); } } } onConnectOutput( outputIndex: number, inputType: INodeInputSlot["type"], input: INodeInputSlot, inputNode: LGraphNode, inputIndex: number ): boolean { const anyConnected = range(this.outputs.length).some(i => this.getOutputLinks(i).length > 0); if (this.autoConfig && "config" in input && !anyConnected && (input as IComfyInputSlot).widgetNodeType === this.type) { this.doAutoConfig(input as IComfyInputSlot) } return true; } doAutoConfig(input: IComfyInputSlot) { // Copy properties from default config in input slot const comfyInput = input as IComfyInputSlot; for (const key in comfyInput.config) this.setProperty(key, comfyInput.config[key]) if ("defaultValue" in this.properties) this.setValue(this.properties.defaultValue) const widget = layoutState.findLayoutForNode(this.id) if (widget && input.name !== "") { widget.attrs.title = input.name; } console.debug("Property copy", input, this.properties) this.setValue(get(this.value)) this.notifyPropsChanged(); } notifyPropsChanged() { const layoutEntry = layoutState.findLayoutEntryForNode(this.id) if (layoutEntry && layoutEntry.parent) { layoutEntry.parent.attrsChanged.set(get(layoutEntry.parent.attrsChanged) + 1) } console.debug("propsChanged", this) this.propsChanged.set(get(this.propsChanged) + 1) } override onConnectionsChange( type: LConnectionKind, slotIndex: number, isConnected: boolean, link: LLink, ioSlot: (INodeOutputSlot | INodeInputSlot) ): void { super.onConnectionsChange(type, slotIndex, isConnected, link, ioSlot); this.clampConfig(); } clampConfig() { let changed = false; for (const link of this.getOutputLinks(0)) { if (link) { // can be undefined if the link is removed const node = this.graph._nodes_by_id[link.target_id] if (node) { const input = node.inputs[link.target_slot] if (input && "config" in input) { this.clampOneConfig(input as IComfyInputSlot) changed = true; } } } } // Force reactivity change so the frontend can be updated with the new props this.notifyPropsChanged(); } clampOneConfig(input: IComfyInputSlot) { } override onSerialize(o: SerializedLGraphNode) { (o as any).comfyValue = get(this.value); (o as any).shownOutputProperties = this.shownOutputProperties super.onSerialize(o); } override onConfigure(o: SerializedLGraphNode) { const value = (o as any).comfyValue || LiteGraph.cloneObject(this.defaultValue); this.value.set(value); this.shownOutputProperties = (o as any).shownOutputProperties; } override stripUserState(o: SerializedLGraphNode) { super.stripUserState(o); (o as any).comfyValue = this.defaultValue; o.properties.defaultValue = null; } } export interface ComfySliderProperties extends ComfyWidgetProperties { min: number, max: number, step: number, precision: number } export class ComfySliderNode extends ComfyWidgetNode { override properties: ComfySliderProperties = { tags: [], defaultValue: 0, min: 0, max: 10, step: 1, precision: 1 } override svelteComponentType = RangeWidget override defaultValue = 0; static slotLayout: SlotLayout = { inputs: [ { name: "value", type: "number" }, { name: "store", type: BuiltInSlotType.ACTION } ], outputs: [ { name: "value", type: "number" }, { name: "changed", type: BuiltInSlotType.EVENT }, ] } override outputProperties = [ { name: "min", type: "number" }, { name: "max", type: "number" }, { name: "step", type: "number" }, { name: "precision", type: "number" }, ] constructor(name?: string) { super(name, 0) } override onAction(action: any, param: any) { if (action === "store" && typeof param === "number") this.setValue(param) } override setValue(value: any) { if (typeof value !== "number") return; super.setValue(clamp(value, this.properties.min, this.properties.max)) } override clampOneConfig(input: IComfyInputSlot) { // this.setProperty("min", clamp(this.properties.min, input.config.min, input.config.max)) // this.setProperty("max", clamp(this.properties.max, input.config.max, input.config.min)) // this.setProperty("step", Math.min(this.properties.step, input.config.step)) this.setValue(this.properties.defaultValue) } } LiteGraph.registerNodeType({ class: ComfySliderNode, title: "UI.Slider", desc: "Slider outputting a number value", type: "ui/slider" }) export interface ComfyComboProperties extends ComfyWidgetProperties { values: string[] } export class ComfyComboNode extends ComfyWidgetNode { override properties: ComfyComboProperties = { tags: [], defaultValue: "A", values: ["A", "B", "C", "D"] } static slotLayout: SlotLayout = { inputs: [ { name: "value", type: "string" }, { name: "store", type: BuiltInSlotType.ACTION } ], outputs: [ { name: "value", type: "string" }, { name: "changed", type: BuiltInSlotType.EVENT } ] } override svelteComponentType = ComboWidget override defaultValue = "A"; override saveUserState = false; comboRefreshed: Writable; constructor(name?: string) { super(name, "A") this.comboRefreshed = writable(false) } onConnectOutput( outputIndex: number, inputType: INodeInputSlot["type"], input: INodeInputSlot, inputNode: LGraphNode, inputIndex: number ): boolean { if (!super.onConnectOutput(outputIndex, inputType, input, inputNode, inputIndex)) return false; const thisProps = this.properties; if (!("config" in input)) return true; const comfyInput = input as IComfyInputSlot; const otherProps = comfyInput.config; // Ensure combo options match if (!(otherProps.values instanceof Array)) return false; if (thisProps.values.find((v, i) => otherProps.values.indexOf(v) === -1)) return false; return true; } override onAction(action: any, param: any) { if (action === "store" && typeof param === "string") this.setValue(param) } override setValue(value: any) { if (typeof value !== "string" || this.properties.values.indexOf(value) === -1) return; super.setValue(value) } override clampOneConfig(input: IComfyInputSlot) { if (!input.config.values) this.setValue("") else if (input.config.values.indexOf(this.properties.value) === -1) { if (input.config.values.length === 0) this.setValue("") else this.setValue(input.config.defaultValue || input.config.values[0]) } } override stripUserState(o: SerializedLGraphNode) { super.stripUserState(o); o.properties.values = [] } } LiteGraph.registerNodeType({ class: ComfyComboNode, title: "UI.Combo", desc: "Combo box outputting a string value", type: "ui/combo" }) export interface ComfyTextProperties extends ComfyWidgetProperties { multiline: boolean; } export class ComfyTextNode extends ComfyWidgetNode { override properties: ComfyTextProperties = { tags: [], defaultValue: "", multiline: false } static slotLayout: SlotLayout = { inputs: [ { name: "value", type: "string" }, { name: "store", type: BuiltInSlotType.ACTION } ], outputs: [ { name: "value", type: "string" }, { name: "changed", type: BuiltInSlotType.EVENT } ] } override svelteComponentType = TextWidget override defaultValue = ""; constructor(name?: string) { super(name, "") } override onAction(action: any, param: any) { if (action === "store") this.setValue(param) } override setValue(value: any) { super.setValue(`${value}`) } } LiteGraph.registerNodeType({ class: ComfyTextNode, title: "UI.Text", desc: "Textbox outputting a string value", type: "ui/text" }) /** Raw output as received from ComfyUI's backend */ export type GalleryOutput = { images: GalleryOutputEntry[] } /** Raw output entry as received from ComfyUI's backend */ export type GalleryOutputEntry = { filename: string, subfolder: string, type: string } export interface ComfyGalleryProperties extends ComfyWidgetProperties { index: number, updateMode: "replace" | "append" } export class ComfyGalleryNode extends ComfyWidgetNode { override properties: ComfyGalleryProperties = { tags: [], defaultValue: [], index: 0, updateMode: "replace" } static slotLayout: SlotLayout = { inputs: [ { name: "images", type: "OUTPUT" }, { name: "store", type: BuiltInSlotType.ACTION, options: { color_off: "rebeccapurple", color_on: "rebeccapurple" } }, { name: "clear", type: BuiltInSlotType.ACTION } ], outputs: [ { name: "selected_index", type: "number" }, { name: "width", type: "number" }, { name: "height", type: "number" }, { name: "any_selected", type: "boolean" }, ] } static propertyLayout: PropertyLayout = [ { name: "updateMode", defaultValue: "replace", type: "enum", options: { values: ["replace", "append"] } } ] override svelteComponentType = GalleryWidget override defaultValue = [] override copyFromInputLink = false; override saveUserState = false; override outputIndex = null; override changedIndex = null; anyImageSelected: boolean = false; modeWidget: IComboWidget; constructor(name?: string) { super(name, []) this.modeWidget = this.addWidget("combo", "Mode", this.properties.updateMode, null, { property: "updateMode", values: ["replace", "append"] }) } override onPropertyChanged(property: any, value: any) { if (property === "updateMode") { this.modeWidget.value = value; } } imageSize: Vector2 = [1, 1] override onExecute() { this.setOutputData(0, this.properties.index) this.setOutputData(1, this.imageSize[0]) this.setOutputData(2, this.imageSize[1]) this.setOutputData(3, this.anyImageSelected) } override onAction(action: any, param: any, options: { action_call?: string }) { if (action === "clear") { this.setValue([]) } else if (action === "store") { if (param && "images" in param) { const data = param as GalleryOutput console.debug("[ComfyGalleryNode] Received output!", data) const galleryItems: GradioFileData[] = convertComfyOutputToGradio(data) if (this.properties.updateMode === "append") { const currentValue = get(this.value) this.setValue(currentValue.concat(galleryItems)) } else { this.setValue(galleryItems) } } this.setProperty("index", 0) this.anyImageSelected = false; } } override formatValue(value: GradioFileData[] | null): string { return `Images: ${value?.length || 0}` } override setValue(value: any) { console.warn("SETVALUE", value) if (Array.isArray(value)) { super.setValue(value) } else { super.setValue([]) } if (!get(this.value)) this.anyImageSelected = false const len = get(this.value).length if (this.properties.index < 0 || this.properties.index >= len) { this.setProperty("index", clamp(this.properties.index, 0, len)) } } } LiteGraph.registerNodeType({ class: ComfyGalleryNode, title: "UI.Gallery", desc: "Gallery that shows most recent outputs", type: "ui/gallery" }) export interface ComfyButtonProperties extends ComfyWidgetProperties { param: string } export class ComfyButtonNode extends ComfyWidgetNode { override properties: ComfyButtonProperties = { tags: [], defaultValue: false, param: "bang" } static slotLayout: SlotLayout = { outputs: [ { name: "clicked", type: BuiltInSlotType.EVENT }, { name: "isClicked", type: "boolean" }, ] } override svelteComponentType = ButtonWidget; override defaultValue = false; override outputIndex = 1; constructor(name?: string) { super(name, false) } override setValue(value: any) { super.setValue(Boolean(value)) } onClick() { this.setValue(true) this.triggerSlot(0, this.properties.param); this.setValue(false) // TODO onRelease } } LiteGraph.registerNodeType({ class: ComfyButtonNode, title: "UI.Button", desc: "Button that triggers an event when clicked", type: "ui/button" }) export interface ComfyCheckboxProperties extends ComfyWidgetProperties { } export class ComfyCheckboxNode extends ComfyWidgetNode { override properties: ComfyCheckboxProperties = { tags: [], defaultValue: false, } static slotLayout: SlotLayout = { inputs: [ { name: "value", type: "boolean" }, { name: "store", type: BuiltInSlotType.ACTION } ], outputs: [ { name: "value", type: "boolean" }, { name: "changed", type: BuiltInSlotType.EVENT }, ] } override svelteComponentType = CheckboxWidget; override defaultValue = false; constructor(name?: string) { super(name, false) } override setValue(value: any) { value = Boolean(value) const changed = value != get(this.value); super.setValue(Boolean(value)) if (changed) this.triggerSlot(1, value) } override onAction(action: any, param: any) { if (action === "store") this.setValue(Boolean(param)) } } LiteGraph.registerNodeType({ class: ComfyCheckboxNode, title: "UI.Checkbox", desc: "Checkbox that stores a boolean value", type: "ui/checkbox" }) export interface ComfyRadioProperties extends ComfyWidgetProperties { choices: string[] } export class ComfyRadioNode extends ComfyWidgetNode { override properties: ComfyRadioProperties = { tags: [], choices: ["Choice A", "Choice B", "Choice C"], defaultValue: "Choice A", } static slotLayout: SlotLayout = { outputs: [ { name: "value", type: "string" }, { name: "index", type: "number" }, { name: "changed", type: BuiltInSlotType.EVENT }, ] } override svelteComponentType = RadioWidget; override defaultValue = ""; override changedIndex = 2; indexWidget: INumberWidget; index = 0; constructor(name?: string) { super(name, "Choice A") this.indexWidget = this.addWidget("number", "Index", this.index) this.indexWidget.disabled = true; } override onExecute(param: any, options: object) { super.onExecute(param, options); this.setOutputData(1, this.index) } override setValue(value: string) { const index = this.properties.choices.indexOf(value) if (index == -1) return; this.index = index; this.indexWidget.value = index; this.setOutputData(1, this.index) super.setValue(value) } } LiteGraph.registerNodeType({ class: ComfyRadioNode, title: "UI.Radio", desc: "Radio that outputs a string and index", type: "ui/radio" }) export interface ComfyImageUploadProperties extends ComfyWidgetProperties { fileCount: "single" | "multiple" // gradio File component format } export class ComfyImageUploadNode extends ComfyWidgetNode> { override properties: ComfyImageUploadProperties = { defaultValue: [], tags: [], fileCount: "single", } static slotLayout: SlotLayout = { outputs: [ { name: "filename", type: "string" }, // TODO support batches { name: "width", type: "number" }, { name: "height", type: "number" }, { name: "changed", type: BuiltInSlotType.EVENT }, ] } override svelteComponentType = ImageUploadWidget; override defaultValue = []; override outputIndex = null; override changedIndex = 3; override saveUserState = false; imageSize: Vector2 = [1, 1]; constructor(name?: string) { super(name, []) } override onExecute(param: any, options: object) { super.onExecute(param, options); const value = get(this.value) if (value.length > 0 && value[0].name) { this.setOutputData(0, value[0].name) // TODO when ComfyUI LoadImage supports loading an image batch this.setOutputData(1, this.imageSize[0]) this.setOutputData(2, this.imageSize[1]) } else { this.setOutputData(0, "") this.setOutputData(1, 1) this.setOutputData(2, 1) } } override formatValue(value: GradioFileData[]): string { return `Images: ${value?.length || 0}` } } LiteGraph.registerNodeType({ class: ComfyImageUploadNode, title: "UI.ImageUpload", desc: "Widget that lets you upload images into ComfyUI's input folder", type: "ui/image_upload" })