@types/node-red__editor-client

/// <reference lib="dom" /> /// <reference types="ace" /> /// <reference types="jquery" /> import * as registry from "@node-red/registry"; import { LocalSettings as RuntimeLocalSettings } from "@node-red/runtime"; import { I18nTFunction } from "@node-red/util"; declare const editorClient: editorClient.EditorClientModule; export = editorClient; declare namespace editorClient { type EditorClientModule = false; /** * Property definition * Read more: https://nodered.org/docs/creating-nodes/properties#property-definitions */ interface NodePropertyDef<TVal, TInstProps extends NodeProperties = NodeProperties> { /** The default value the property takes */ value: TVal | ""; /** Whether the property is required. If set to true, the property will be invalid if its value is null or an empty string. */ required?: boolean | undefined; /** A function that can be used to validate the value of the property. */ validate?: ((this: NodeInstance<TInstProps>, val: string) => boolean) | undefined; /** If this property is a pointer to a configuration node, this identifies the type of the node. */ type?: string | undefined; } /** * Properties definitions (`defaults` object) * Read more: https://nodered.org/docs/creating-nodes/properties */ type NodePropertiesDef<TProps extends NodeProperties, TInstProps extends TProps = TProps> = { [K in keyof TProps]: K extends NodeReservedProperties ? never : NodePropertyDef<TProps[K], TInstProps>; }; /** * Node properties * Read more: https://nodered.org/docs/creating-nodes/properties */ interface NodeProperties { name?: string | undefined; inputs?: 0 | 1 | undefined; } /** Reserved name for properties that MUST NOT BE USED. */ type NodeReservedProperties = | "changed" | "dirty" | "icon" | "id" | "info" | "inputLabels" | "outputLabels" | "ports" | "selected" | "type" | "valid" | "validationErrors" | "wires" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z"; type NodeInstance<TProps extends NodeProperties = NodeProperties> = & Omit<TProps, NodeReservedProperties> & Readonly<{ _: I18nTFunction; id: string; type: string; inputs: 0 | 1; outputs: number; h: number; w: number; x: number; y: number; z: string; }>; type NodeCredentials<T> = { [K in keyof T]: NodeCredential; }; interface NodeCredential { type: "text" | "password"; } /** * Node Definition * Read more: https://nodered.org/docs/creating-nodes/node-html#node-definition */ interface NodeDef<TProps extends NodeProperties, TCreds = undefined, TInstProps extends TProps = TProps> { /** The palette category the node appears in. */ category: "config" | string; /** * The editable properties for the node. * Read more: https://nodered.org/docs/creating-nodes/properties */ defaults: NodePropertiesDef<TProps, TInstProps>; /** * The credential properties for the node. * Read more: https://nodered.org/docs/creating-nodes/credentials */ credentials?: NodeCredentials<TCreds> | undefined; /** * How many inputs the node has, either 0 or 1. */ inputs?: 0 | 1 | undefined; /** * How many outputs the node has. Can be 0 or more. */ outputs?: number | undefined; /** * The background colour to use. * Read more: https://nodered.org/docs/creating-nodes/appearance#background-colour */ color?: string | undefined; /** * The label to use in the palette. * Read more: https://nodered.org/docs/creating-nodes/appearance#palette-label */ paletteLabel?: string | ((this: NodeInstance<TInstProps>) => string) | undefined; /** * The label to use in the workspace. * Read more: https://nodered.org/docs/creating-nodes/appearance#node-label */ label?: string | ((this: NodeInstance<TInstProps>) => string) | undefined; /** * The style to apply to the label. * Read more: https://nodered.org/docs/creating-nodes/appearance#label-style */ labelStyle?: | "node_label" | "node_label_italic" | string | ((this: NodeInstance<TInstProps>) => "node_label" | "node_label_italic" | string) | undefined; /** * Optional label to add on hover to the input port of a node. * Read more: https://nodered.org/docs/creating-nodes/appearance#port-labels */ inputLabels?: string | ((this: NodeInstance<TInstProps>) => string) | undefined; /** * Optional labels to add on hover to the output ports of a node. * Read more: https://nodered.org/docs/creating-nodes/appearance#port-labels */ outputLabels?: | string | string[] | ((this: NodeInstance<TInstProps>, idx: number) => string | undefined) | undefined; /** * The icon to use. * Read more: https://nodered.org/docs/creating-nodes/appearance#icon */ icon?: string | undefined; /** * The alignment of the icon and label. * Read more: https://nodered.org/docs/creating-nodes/appearance#alignment */ align?: "left" | "right" | undefined; /** * Adds a button to the edge of the node. * Read more: https://nodered.org/docs/creating-nodes/appearance#buttons */ button?: | { /** Called when the button is clicked */ onclick: (this: NodeInstance<TInstProps>) => void; /** Function to dynamically enable and disable the button based on the node’s current configuration. */ enabled?: ((this: NodeInstance<TInstProps>) => boolean) | undefined; /** Function to determine whether the button should be shown at all. */ visible?: ((this: NodeInstance<TInstProps>) => boolean) | undefined; } | undefined; /** * Called when the edit dialog is being built. * Read more: https://nodered.org/docs/creating-nodes/properties#custom-edit-behaviour */ oneditprepare?: ((this: NodeInstance<TInstProps>) => void) | undefined; /** * Called when the edit dialog is okayed. * Read more: https://nodered.org/docs/creating-nodes/properties#custom-edit-behaviour */ oneditsave?: ((this: NodeInstance<TInstProps>) => void) | undefined; /** * Called when the edit dialog is cancelled. * Read more: https://nodered.org/docs/creating-nodes/properties#custom-edit-behaviour */ oneditcancel?: ((this: NodeInstance<TInstProps>) => void) | undefined; /** * Called when the delete button in a configuration node’s edit dialog is pressed. * Read more: https://nodered.org/docs/creating-nodes/properties#custom-edit-behaviour */ oneditdelete?: ((this: NodeInstance<TInstProps>) => void) | undefined; /** * Called when the edit dialog is resized. * Read more: https://nodered.org/docs/creating-nodes/properties#custom-edit-behaviour */ oneditresize?: ((this: NodeInstance<TInstProps>, size: { width: number; height: number }) => void) | undefined; /** * Called when the node type is added to the palette. * Read more: https://nodered.org/docs/creating-nodes/properties#custom-edit-behaviour */ onpaletteadd?: ((this: NodeInstance<TInstProps>) => void) | undefined; /** * Called when the node type is removed from the palette. * Read more: https://nodered.org/docs/creating-nodes/properties#custom-edit-behaviour */ onpaletteremove?: ((this: NodeInstance<TInstProps>) => void) | undefined; /** * Called when the node type is dragged into workspace. */ onadd?: ((this: NodeInstance<TInstProps>) => void) | undefined; } interface CommSubscriber { (topic: string, data: any): void; } interface Comms { connect(): void; subscribe(topic: string, callback: CommSubscriber): void; unsubscribe(topic: string, callback: CommSubscriber): void; } interface Events { on(evt: string, func: (...args: any[]) => void): void; off(evt: string, func: (...args: any[]) => void): void; emit(evt: string, ...args: any[]): void; } type HistoryEvent = & { dirty?: boolean | undefined; callback?: ((ev: HistoryEvent) => void) | undefined; } & ( | { t: "multi"; events: HistoryEvent[]; } | { t: "replace"; config: object; changed: object; rev: string; } | { t: "add"; nodes?: object[] | undefined; links?: object[] | undefined; groups?: object[] | undefined; workspaces?: object[] | undefined; subflows?: object[] | undefined; subflow?: object | undefined; removedLinks?: object[] | undefined; } | { t: "delete"; workspaces?: object[] | undefined; subflows?: object[] | undefined; subflowInputs?: object[] | undefined; subflowOutputs?: object[] | undefined; subflow?: object | undefined; groups?: object[] | undefined; nodes?: object[] | undefined; links?: object[] | undefined; createdLinks?: object[] | undefined; changes?: object[] | undefined; } | { t: "move"; nodes: object[]; links?: object[] | undefined; removedLinks?: object[] | undefined; addToGroup?: object | undefined; removeFromGroup?: object | undefined; } | { t: "edit"; node: object; changes: object[]; links?: object[] | undefined; createdLinks?: object[] | undefined; } | { t: "createSubflow"; nodes?: object[] | undefined; links?: object[] | undefined; subflow: object; removedLinks?: object[] | undefined; } | { t: "deleteSubflow"; subflow?: object | undefined; subflows?: object[] | undefined; movedNodes?: object[] | undefined; links?: object[] | undefined; createdLinks?: object[] | undefined; } | { t: "reorder"; order?: object | undefined; } | { t: "createGroup"; groups?: object[] | undefined; } | { t: "ungroup"; groups?: object[] | undefined; } | { t: "addToGroup"; nodes?: object[] | undefined; } | { t: "removeFromGroup"; nodes?: object[] | undefined; } ); interface History { markAllDirty(): void; list(): HistoryEvent[]; listRedo(): HistoryEvent[]; depth(): number; push(ev: HistoryEvent): void; pop(): void; peek(): HistoryEvent; clear(): void; redo(): void; } // eslint-disable-next-line @typescript-eslint/naming-convention interface I18n { lang(): string; } interface NodesFontAwesome { getIconUnicode(name: string): string; getIconList(): string[]; } interface NodesRegistry { setModulePendingUpdated(module: string, version: string): void; getModule(module: string): object; getNodeSetForType(nodeType: string): object; getModuleList(): object; getNodeList(): object[]; getNodeTypes(): string[]; setNodeList(list: object[]): void; addNodeSet(ns: object): void; removeNodeSet<T extends object>(ns: T): T; getNodeSet(id: string): object; enableNodeSet(id: string): void; disableNodeSet(id: string): void; /** * Registers a node with the editor. * * @param nt The node type is used throughout the editor to identify the node. It must * match the value used by the call to RED.nodes.registerType in the corresponding runtime * script. * @param def The node definition contains all of the information about the node * needed by the editor. */ // eslint-disable-next-line @definitelytyped/no-unnecessary-generics registerNodeType<TProps extends NodeProperties, TCreds = undefined, TInstProps extends TProps = TProps>( nt: string, def: NodeDef<TProps, TCreds, TInstProps>, ): void; removeNodeType(nt: string): void; getNodeType(nt: string): NodeDef<NodeProperties>; setIconSets(sets: Record<string, string[]>): void; getIconSets(): Record<string, string[]>; } interface Nodes { fontAwesome: NodesFontAwesome; registry: NodesRegistry; setNodeList: NodesRegistry["setNodeList"]; getNodeList: NodesRegistry["getNodeList"]; removeNodeSet: NodesRegistry["removeNodeSet"]; enableNodeSet: NodesRegistry["enableNodeSet"]; disableNodeSet: NodesRegistry["disableNodeSet"]; setIconSets: NodesRegistry["setIconSets"]; getIconSets: NodesRegistry["getIconSets"]; /** * Registers a node with the editor. * * @param nt The node type is used throughout the editor to identify the node. It must * match the value used by the call to RED.nodes.registerType in the corresponding runtime * script. * @param def The node definition contains all of the information about the node * needed by the editor. */ registerType: NodesRegistry["registerNodeType"]; getType: NodesRegistry["getNodeType"]; /** * Converts a node to an exportable JSON Object */ convertNode(n: object, exportCreds: boolean): object; add(n: object): void; remove(id: string): { links: object[]; nodes: object[] }; clear(): void; moveNodeToTab(node: object, z: string): void; addLink(l: object): void; removeLink(l: object): void; addWorkspace(ws: object, targetIndex?: number): void; removeWorkspace(id: string): { nodes: object[]; links: object[]; groups: object[] }; getWorkspaceOrder(): object[]; setWorkspaceOrder(): void; workspace(): object; addSubflow(sf: object, createNewIds?: boolean): void; removeSubflow(sf: object): void; subflow(id: string): object; subflowContains(sfid: string, nodeid: string): boolean; addGroup(group: object): void; removeGroup(group: object): void; group(id: string): object; groups(z: string): object; eachNode(cb: (n: object) => boolean): void; eachLink(cb: (l: object) => boolean): void; eachConfig(cb: (conf: object) => boolean): void; eachSubflow(cb: (subf: object) => boolean): void; eachWorkspace(cb: (w: object) => boolean): void; /** * @param id Node id * @returns node or config node, or null if no nodes with such id */ node(id: string): object | null; version(): string; version(version: string): void; originalFlow(): object; originalFlow(flow: object): void; filterNodes(filter: object): object[]; filterLinks(filter: object): object[]; /** * @returns [new_nodes,new_links,new_groups,new_workspaces,new_subflows,missingWorkspace] */ import( newNodesObj: string | object | object[], createNewIds?: boolean, createMissingWorkspace?: boolean, ): [object[], object[], object[], object[], object[], object]; getAllFlowNodes(node: object): object[]; /** * Converts the current node selection to an exportable JSON Object */ createExportableNodeSet( set: object[], exportedIds?: object, exportedSubflows?: object, exportedConfigNodes?: object, ): object[]; createCompleteNodeSet(exportCredentials?: boolean): object[]; updateConfigNodeUsers(n: object): void; id(): string; dirty(): boolean; dirty(d: boolean): void; } interface Settings { init( options: { apiRootUrl: string; }, done: () => void, ): void; load(done: () => void): void; loadUserSettings(done: () => void): void; set(key: string, value: unknown): void; get<T>(key: string, defaultIfUndefined: T): T; remove(key: string): void; theme<T>(property: string, defaultValue: T): T; } interface SettingsWithData extends Settings, RuntimeLocalSettings {} interface User { init(): void; login(done: () => void): void; login(opts: { cancelable?: boolean | undefined; updateMenu?: boolean | undefined }, done: () => void): void; logout(): void; hasPermission(permission: string | object): boolean; } interface Validators { number(blankAllowed?: boolean): (v: any) => boolean; regex(re: RegExp): (v: any) => boolean; typedInput(ptypeName: string, isConfig?: boolean): (v: any) => boolean; } interface Plugins { registerPlugin: PluginsRegistry["registerPluginType"]; } interface PluginsRegistry { /** * Registers a plugin with the editor. * * @param pt The plugin type is used throughout the editor to identify the plugin. It must * match the value used by the call to RED.plugins.registerPlugin in the corresponding runtime * script. * @param def The plugin definition contains all of the information about the plugin * needed by the editor. */ registerPluginType(pt: string, def: PluginDef): void; } interface PluginDef { onadd?: (() => void) | undefined; } interface TextBidi { /** * Sets the text direction preference * @param dir - the text direction preference */ setTextDirection(dir: string): void; /** * Enforces the text direction of a given string by adding * UCC (Unicode Control Characters) * @param value - the string */ enforceTextDirectionWithUCC(value: string): string; /** * Determines the text direction of a given string. * @param value - the string */ resolveBaseTextDir(value: string): string; /** * Adds event listeners to the Input to ensure its text-direction attribute * is properly set based on its content. * @param input - the input field */ prepareInput(input: HTMLInputElement): void; } interface TextFormat { /* * Returns the HTML representation of a given structured text * @param text - the structured text * @param type - could be one of filepath, url, email * @param args - pass additional arguments to the handler. generally null. * @param isRtl - indicates if the GUI is mirrored * @param locale - the browser locale */ getHtml( text: string, type: string, args: { dir?: string | undefined } | null, isRtl: boolean, locale: string, ): string; /* * Handle Structured text correct display for a given HTML element. * @param element - the element : should be of type div contenteditable=true * @param type - could be one of filepath, url, email * @param args - pass additional arguments to the handler. generally null. * @param isRtl - indicates if the GUI is mirrored * @param locale - the browser locale */ attach( element: HTMLDivElement, type: "filepath" | "url" | "email", args: any, isRtl: boolean, locale: string, ): boolean; } interface Text { bidi: TextBidi; format: TextFormat; } interface ActionList { init(): void; show(v: string): void; hide(): void; } interface Actions { add(name: string, handler: () => void): void; remove(name: string): void; get(name: string): () => void; invoke(name: string, ...args: any): void; list(): Array<{ id: string; scope?: string | undefined; key?: string | undefined; user?: boolean | undefined }>; } interface Clipboard { init(): void; import(mode?: string): void; export(mode?: string): void; copyText(value: any, element: HTMLElement, msg: string): boolean; } interface Deploy { /** * options: * type: "default" - Button with drop-down options - no further customisation available * type: "simple" - Button without dropdown. Customisations: * label: the text to display - default: "Deploy" * icon : the icon to use. Null removes the icon. default: "red/images/deploy-full-o.svg" */ init(options?: { type?: "default" | "simple" | undefined; label?: string | undefined; icon?: string | undefined; }): void; setDeployInflight(state: boolean): void; } interface Diff { init(): void; getRemoteDiff(callback: (diff: object) => void): void; showRemoteDiff(diff: object): void; showUnifiedDiff(options: object): void; showCommitDiff(options: object): void; mergeDiff(diff: object): void; } interface Editor { init(): void; edit(node: object): void; /** * @param name - name of the property that holds this config node * @param type - type of config node * @param id - id of config node to edit. _ADD_ for a new one * @param prefix - the input prefix of the parent property */ editConfig(name: string, type: string, id: string, prefix: string): void; editSubflow(subflow: object, defaultTab?: any): void; editGroup(group: object, defaultTab?: any): void; editJavaScript(options: JavaScriptTypeEditorShowOptions): void; editExpression(options: ExpressionTypeEditorShowOptions): void; editJSON(options: JSONTypeEditorShowOptions): void; editMarkdown(options: MarkdownTypeEditorShowOptions): void; editText(options: TextTypeEditorShowOptions): void; editBuffer(options: BufferTypeEditorShowOptions): void; buildEditForm(container: JQuery, formId: string, type: string, ns: string, node: unknown): JQuery; /** * Validate a node * @param node - the node being validated */ validateNode(node: unknown): boolean; /** * Called when the node's properties have changed. * Marks the node as dirty and needing a size check. * Removes any links to non-existant outputs. * @param node - the node that has been updated * @param outputMap - (optional) a map of old->new port numbers if wires should be moved * @returns the links that were removed due to this update */ updateNodeProperties(node: object, outputMap?: Record<string, string>): object[]; showIconPicker( container: JQuery, backgroundColor: string, iconPath: object, faOnly: boolean, done: (res: string) => void, ): void; /** * Show a type editor. * @param type - the type to display * @param options - options for the editor */ showTypeEditor(type: string, options: TypeEditorShowOptions): void; /** * Register a type editor. * @param type - the type name * @param definition - the editor definition */ registerTypeEditor(type: string, definition: TypeEditorDefinition): void; /** * Create a editor ui component * @param options - the editor options */ createEditor(options: { element?: JQuery | undefined; id?: string | undefined; mode?: string | undefined; foldStyle?: string | undefined; options?: object | undefined; readOnly?: boolean | undefined; value?: string | undefined; globals?: object | undefined; }): AceAjax.Editor; } interface TypeEditorDefinition { show(options: any): void; buildToolbar?: (container: JQuery, editor: AceAjax.Editor) => void; } interface TypeEditorShowOptions { title?: string; parent?: JQuery; onclose?: () => void; } interface JavaScriptTypeEditorShowOptions extends TypeEditorShowOptions { value: any; width: number | "Infinite"; stateId: string; mode: string; focus: boolean; cancel: () => void; complete: (value: any, cursor?: any) => void; extraLibs: any[]; } interface ExpressionTypeEditorShowOptions extends TypeEditorShowOptions { value: string; stateId: string; focus: boolean; complete: (value: any) => void; } interface JSONTypeEditorShowOptions extends TypeEditorShowOptions { value: string; stateId?: string; focus?: boolean; complete?: (value: any) => void; title?: string; requireValid?: boolean; readOnly?: boolean; toolbarButtons?: TrayButton[]; } interface MarkdownTypeEditorShowOptions extends TypeEditorShowOptions { value: string; width?: number | "Infinite"; stateId: string; focus?: boolean; cancel?: () => void; complete?: (value: string, cursor?: any) => void; title?: string; header?: JQuery; } interface TextTypeEditorShowOptions extends TypeEditorShowOptions { mode: string; value: string; stateId: string; width: number | "Infinite"; focus: boolean; complete?: (value: string, cursor?: any) => void; } interface BufferTypeEditorShowOptions extends TypeEditorShowOptions { value: any; stateId: string; focus: boolean; complete: (value: any) => void; } interface EventLog { init(): void; show(): void; log(id: any, payload: object): void; startEvent(name: string): void; } interface Group { def: object; init(): void; createGroup(nodes: object[]): object; ungroup(g: object): object[]; addToGroup(group: object, nodes: object | object[]): void; removeFromGroup(group: object, nodes: object | object[], reparent?: boolean): void; getNodes(group: object, recursive: boolean): object[]; contains(group: object, item: object): boolean; markDirty(group: object): void; } interface Keyboard { init(): void; add(scope: string, key: string, modifiers: object, ondown: string | (() => void)): void; remove(key: string, modifiers?: object): void; getShortcut(actionName: string): object; revertToDefault(actionName: string): void; formatKey(key: string, plain?: boolean): string; validateKey(key: string): boolean; } interface Library { init(): void; create(options: { elementPrefix?: string | undefined; editor: | AceAjax.Editor | { // Orion Editor setText: () => void; getText: () => void; }; type: string; url: string; mode?: string | undefined; ext?: string | undefined; fields: string[]; }): void; createBrowser(options: { container: JQuery; onselect?: ((item: object) => void) | undefined; onconfirm?: ((item: object) => void) | undefined; folderTools?: boolean | undefined; }): { select(item: object): void; getSelected(): object; focus(): void; data(content: object[], selectFirst?: boolean): void; }; loadLibraryFolder(library: string, type: string, root: string, done: (items: object[]) => void): void; } type NotificationType = "warning" | "compact" | "success" | "error"; interface Notifications { init(): void; notify( msg: string | JQuery, options: { type?: NotificationType | undefined; fixed?: boolean | undefined; timeout?: number | undefined; id?: string | undefined; modal?: boolean | undefined; width?: number | undefined; buttons?: | Array<{ id?: string | undefined; class?: string | undefined; text: string; click: (event: JQuery.Event) => void; }> | undefined; }, ): HTMLDivElement; notify(msg: string | JQuery, type?: NotificationType, fixed?: boolean, timeout?: number): HTMLDivElement; } interface PaletteEditor { init(): void; install(entry: object, container: object, done: (ret: Error | object) => void): void; } interface Palette { editor: PaletteEditor; init(): void; add(nt: string, def: object): void; remove(nt: string): void; hide(nt: string): void; show(nt: string): void; refresh(): void; getCategories(): Array<{ id: string; label: string }>; } interface Search { init(): void; show(v: string): void; hide(): void; search(val: string): object[]; } interface SidebarConfig { init(): void; /** * @param param - filterUnused or id */ show(param: boolean | string): void; refresh(): void; } interface SidebarContext { init(): void; } interface SidebarHelp { init(): void; show(type?: string): void; set(html: string, title?: string): void; } interface SidebarInfoOutliner { build(): void; search(val: string): void; select(node?: object): void; reveal(node: object): void; } interface SidebarInfo { outliner: SidebarInfoOutliner; init(): void; show(): void; refresh(node?: object | object[]): void; clear(): void; set(html: string, title?: string): void; } interface SidebarVersionControl { init(utils: object): void; show(): void; refresh(full?: boolean, includeRemote?: boolean): void; showLocalChanges(): void; } interface Sidebar { config: SidebarConfig; context: SidebarContext; help: SidebarHelp; info: SidebarInfo; versionControl: SidebarVersionControl; init(): void; addTab(options: { enableOnEdit?: boolean | undefined; toolbar?: HTMLElement | undefined; content?: HTMLElement | undefined; id: string; name: string; label?: string; iconClass?: string | undefined; visible?: boolean | undefined; action?: string; }): void; removeTab(id: string): void; show(id: string): void; containsTab(id: string): boolean; toggleSidebar(state: boolean): void; } interface StatusBar { init(): void; add(options: { id: string; element: JQuery; align?: "left" | "right" | undefined }): void; } interface Subflow { init(): void; createSubflow(): void; convertToSubflow(): void; removeSubflow(id: string): { nodes: object[]; links: object[]; subflows: object[] }; refresh(markChange?: boolean): { instances: object[] } | undefined; removeInput(): { subflowInputs: object[]; links: object[] }; removeOutput(removeSubflowOutputs?: object[]): { subflowOutputs: object[]; links: object[] }; removeStatus(): { links: object[] }; buildEditForm(type: string, node: object): void; buildPropertiesForm(node: object): void; exportSubflowTemplateEnv(list: JQuery, all?: boolean): object[] | null; exportSubflowInstanceEnv(node: object): object[]; } interface Tray { init(): void; show(options?: TrayShowOptions): void; hide(): void; resize(): void; close(done?: () => void): void; } interface TrayShowOptions { buttons?: TrayButton[]; close?: () => void; open?: (tray: any, done?: () => void) => void; resize?: (options: TrayResizeOptions) => void; show?: () => void; title?: string; maximized?: boolean; width?: number; overlay?: boolean; focusElement?: any; } interface TrayResizeOptions { width: number; height?: number; } interface TrayButton { class?: string; click?: (event: any) => void; id?: string; text?: string; } interface TypeSearch { show(opts: object): void; refresh(opts: object): void; hide(fast?: boolean): void; } interface UserSettings { init(): void; toggle(id: string): void; show(initialTab?: string): void; add(options: object): void; } interface Utils { createObjectElement(obj: any, options?: object): JQuery; getMessageProperty(msg: object, expr: string | string[]): any; setMessageProperty(msg: object, prop: string, value: any, createMissing?: boolean): null | undefined; normalisePropertyExpression(str: string, msg?: registry.NodeMessage): Array<string | number>; validatePropertyExpression(str: string): boolean; separateIconPath(icon?: string): { module: string; file: string; }; getDefaultNodeIcon<TProps extends NodeProperties>( def: NodeDef<TProps>, node?: NodeInstance<TProps>, ): { module: string; file: string; }; getNodeIcon<TProps extends NodeProperties>(def: NodeDef<TProps>, node?: NodeInstance<TProps>): string; getNodeLabel(node: NodeInstance, defaultLabel?: string): string; getNodeColor(type: string, def: NodeDef<NodeProperties>): string; clearNodeColorCache(): void; addSpinnerOverlay(container: JQuery, contain?: boolean): JQuery; decodeObject(payload: string, format: string): any; parseContextKey(key: string): { store?: string | undefined; key: string }; /** * Create or update an icon element and append it to iconContainer. * @param iconUrl - Url of icon. * @param iconContainer - Icon container element with red-ui-palette-icon-container class. * @param isLarge - Whether the icon size is large. */ createIconElement(iconUrl: string, iconContainer: JQuery, isLarge?: boolean): void; sanitize(m: string): string; renderMarkdown(txt: string): string; createNodeIcon(node: NodeInstance): JQuery; getDarkerColor(c: string): string; } interface ViewNavigator { init(): void; refresh(): void; resize(): void; toggle(): void; } interface ViewTools { init(): void; /** * Aligns all selected nodes to the current grid */ alignSelectionToGrid(): void; /** * Moves all of the selected nodes by the specified amount * @param dx * @param dy */ moveSelection(dx: number, dy: number): void; } interface View { navigator: ViewNavigator; tools: ViewTools; init(): void; state(): number; state(state: number): void; updateActive(): void; redraw(updateActive?: boolean, syncRedraw?: boolean): void; focus(): void; /** * Imports a new collection of nodes from a JSON String. * - all get new IDs assigned * - all "selected" * - attached to mouse for placing - "IMPORT_DRAGGING" */ importNodes(newNodesStr: string, addNewFlow?: boolean, touchImport?: boolean): void; calculateTextWidth(str: string, className: string): number; select(selection?: string | object): void; selection(): { nodes: object[]; link?: object | undefined; }; scale(): number; getLinksAtPoint(x: number, y: number): object[]; getGroupAtPoint(x: number, y: number): object | null; getActiveGroup(): object; reveal(id: string, triggerHighlight?: boolean): void; gridSize(): number; gridSize(v: number): void; getActiveNodes(): object[]; selectNodes(options: object): void; scroll(x: number, y: number): void; clickNodeButton(n: object): void; } interface Workspaces { init(): void; add(ws: object | false, skipHistoryEntry: boolean, targetIndex: number): object; remove(ws: object): void; order(order: string[]): void; edit(id: string): void; contains(id: string): boolean; count(): number; active(): object; selection(): object[]; show(id: string): void; refresh(): void; resize(): void; enable(id: string): void; disable(id: string): void; } interface TouchRadialMenu { show(obj: HTMLElement, pos: number[], options: object): void; active(): boolean; } interface Touch { radialMenu: TouchRadialMenu; } interface ProjectsSettings { init(utils: object): void; show(initialTab?: string): void; switchProject(): void; } interface ProjectsUserSettings { init(utils: object): void; } interface Projects { settings: ProjectsSettings; userSettings: ProjectsUserSettings; init(): void; showStartup(): void; newProject(): void; selectProject(): void; showCredentialsPrompt(): void; showFilesPrompt(): void; showProjectDependencies(): void; createDefaultFileSet(): void; createDefaultPackageFile(): void; refresh(done?: (activeProject: object | null) => void): void; editProject(): void; getActiveProject(): object; } interface ColorPicker { create(options: { value: string; id: string; palette?: [] | undefined; cellWidth?: number | undefined; cellHeight?: number | undefined; cellMargin?: number | undefined; cellPerRow?: number | undefined; opacity?: number | undefined; }): JQuery<HTMLDivElement>; } interface MenuItemOption { id?: string | undefined; setting?: string | undefined; selected?: boolean | undefined; group?: boolean | undefined; icon?: string | undefined; label?: string | undefined; sublabel?: string | undefined; onselect?: string | ((...args: any[]) => void) | undefined; toggle?: boolean | undefined; href?: string | undefined; options?: Array<MenuItemOption | null> | undefined; disabled?: boolean | undefined; } interface Menu { init(options: { id?: string | undefined; options: Array<MenuItemOption | null> }): JQuery<HTMLUListElement>; setSelected(id: string, state: boolean): void; isSelected(id: string): boolean; toggleSelected(id: string): void; setDisabled(id: string, state: boolean): void; addItem(id: string, opt: MenuItemOption | null): void; removeItem(id: string): void; setAction(id: string, action: string | ((...args: any[]) => void)): void; } interface PanelsInstance { ratio(): number; ratio(ration: number): void; resize(size: number): void; } interface Panels { create(options: { id: string; container?: JQuery | undefined; dir?: "vertical" | undefined; resize?: ((size1: number, size2: number) => void) | undefined; }): PanelsInstance; } interface PopoverInstance { setContent(content: string): PopoverInstance; open(instant?: boolean): PopoverInstance; close(instant?: boolean): PopoverInstance; } interface Popover { create(options: { target: JQuery; direction?: "right" | "left" | "bottom" | "top" | undefined; trigger?: "hover" | "click" | "modal" | undefined; interactive?: boolean | undefined; tooltip?: boolean | undefined; content: string | ((res: PopoverInstance) => void); delay?: { show: number; hide: number } | undefined; autoClose?: boolean | undefined; width?: string | undefined; size?: string | undefined; }): PopoverInstance; tooltip(target: JQuery, content: string, action?: string): PopoverInstance; menu(options: { style?: "compact" | undefined; disposeOnClose?: boolean | undefined; onclose?: ((v: boolean) => void) | undefined; options?: | Array<{ onselect?: (() => void) | undefined; }> | undefined; }): { show(opts: { target: JQuery; align?: "right" | "left" | undefined; offset?: [number, number] | undefined; dispose?: boolean | undefined; }): void; hide(cancelled?: boolean): void; }; panel(content: JQuery): { container: JQuery; show(options: { onclose: () => void; target: JQuery; align?: "right" | "left" | undefined; offset?: [number, number] | undefined; dispose?: boolean | undefined; }): void; hide(dispose?: boolean): void; }; } interface StackInstanceEntry { collapsible?: boolean | undefined; container: JQuery<HTMLDivElement>; header: JQuery<HTMLDivElement>; contentWrap: JQuery<HTMLDivElement>; content: JQuery<HTMLDivElement>; title: JQuery<HTMLDivElement>; toggle(): boolean; expand(): boolean | undefined; collapse(): boolean | undefined; isExpanded(): boolean; } interface StackInstance { add(entry: { collapsible?: boolean | undefined; title: string }): StackInstanceEntry; hide(): StackInstance; show(): StackInstance; resize(): void; } interface Stack { create(options: { container: JQuery; fill?: boolean | undefined; singleExpanded?: boolean | undefined; }): StackInstance; } interface TabsInstance { addTab( tab: { id: string; icon?: string | undefined; iconClass?: string | undefined; label: string; pinned?: boolean | undefined; closeable?: boolean | undefined; }, targetIndex: number, ): void; removeTab(id: string): void; activateTab(link: string | JQuery): void; nextTab(): void; previousTab(): void; resize(): void; count(): number; contains(id: string): boolean; renameTab(id: string, label: string): void; selection(): string[]; order(order: string[]): void; } interface Tabs { create(options: { element?: JQuery | undefined; vertical?: boolean | undefined; addButton?: string | (() => void) | undefined; addButtonCaption?: string | undefined; searchButton?: string | (() => void) | undefined; searchButtonCaption?: string | undefined; scrollable?: boolean | undefined; collapsible?: boolean | undefined; menu?: boolean | undefined; onselect?: ((selection: string[]) => void) | undefined; onclick?: ((item: string) => void) | undefined; ondblclick?: ((item: string) => void) | undefined; onchange?: ((item: string) => void) | undefined; minimumActiveTabWidth?: number | undefined; onremove?: ((item: object) => void) | undefined; }): TabsInstance; } interface RED { // root comms: Comms; events: Events; history: History; i18n: I18n; nodes: Nodes; settings: SettingsWithData; user: User; validators: Validators; plugins: Plugins; // assigned in i18n.js (on init) _: I18nTFunction; // text text: Text; // ui actionList: ActionList; actions: Actions; clipboard: Clipboard; deploy: Deploy; diff: Diff; editor: Editor; eventLog: EventLog; group: Group; keyboard: Keyboard; library: Library; notifications: Notifications; palette: Palette; projects: Projects; search: Search; sidebar: Sidebar; state: { readonly DEFAULT: number; readonly MOVING: number; readonly JOINING: number; readonly MOVING_ACTIVE: number; readonly ADDING: number; readonly EDITING: number; readonly EXPORT: number; readonly IMPORT: number; readonly IMPORT_DRAGGING: number; readonly QUICK_JOINING: number; readonly PANNING: number; readonly SELECTING_NODE: number; readonly GROUP_DRAGGING: number; readonly GROUP_RESIZE: number; }; statusBar: StatusBar; subflow: Subflow; touch: Touch; tray: Tray; typeSearch: TypeSearch; userSettings: UserSettings; utils: Utils; view: View; workspaces: Workspaces; // assigned in ui/notifications.js /* If RED.notifications.hide is set to true, all notifications will be hidden. This is to help with UI testing in certain cases and not intended for the end-user. // Example usage for a modal dialog with buttons var myNotification = RED.notify("This is the message to display",{ modal: true, fixed: true, type: 'warning', // 'compact', 'success', 'warning', 'error' buttons: [ { text: "cancel", click: function(e) { myNotification.close(); } }, { text: "okay", class:"primary", click: function(e) { myNotification.close(); } } ] }); */ notify: Notifications["notify"]; // ui > common colorPicker: ColorPicker; menu: Menu; panels: Panels; popover: Popover; stack: Stack; tabs: Tabs; } /** * Widgets */ interface WidgetEditableListOptions<T> { /** * Determines whether a button is shown below the list that, when clicked, will add a new entry to the list. * If not specified, or set to true (boolean) a button is sh