dag-designer / Exports

dag-designer

Table of contents

Classes

• DesignerApiClient

Interfaces

• IRunNodeTrace
• IRunResult
• IDagBindingEdgeData
• IDagDesignerCanvasProps
• INodeState
• IRunProgressState
• IRunProgressHooks
• IDagDesignerRootProps
• IDagDesignerContextValue
• IDagDesignerNodeExplorerProps
• IDagDesignerInspectorProps
• IDagDesignerNodeConfigProps
• IDagDesignerEdgeInspectorProps
• IDagDesignerNodeIoTraceProps
• IDagDesignerRunProgressSummaryProps
• IDagNodeIoTrace
• IDagNodeViewData
• IEdgeInspectorPanelProps
• INodeConfigPanelProps
• INodeExplorerPanelProps
• INodeIoTracePanelProps
• INodeIoViewerProps
• ICreateDefinitionInput
• IUpdateDraftInput
• IValidateDefinitionInput
• IPublishDefinitionInput
• IGetDefinitionInput
• IListDefinitionsInput
• IDesignerCreateRunInput
• IGetRunResultInput
• IDesignerStartRunInput
• ISubscribeRunProgressInput
• IDesignerApiClient
• IDesignerApiClientConfig
• IUseDagDesignApiOptions
• IUseDagDesignApi
• IDagDesignerState
• IDagDesignerActions

Type Aliases

• TNodeExecutionStatus
• TNodeOperationStatus
• TDagCanvasNode

Variables

• DagDesigner
• DAG_DESIGNER_PACKAGE_NAME

Functions

• hasValidRunResult
• DagBindingEdge
• DagDesignerCanvas
• useDagDesignerContext
• DagDesignerRoot
• DagDesignerNodeExplorer
• DagDesignerInspector
• DagDesignerNodeConfig
• DagDesignerEdgeInspector
• DagDesignerNodeIoTrace
• DagDesignerRunProgressSummary
• DagNodeView
• EdgeInspectorPanel
• NodeConfigPanel
• NodeExplorerPanel
• NodeIoTracePanel
• NodeIoViewer
• useDagDesignApi
• useDagDesignerState
• useDagDesignerActions

Type Aliases

TNodeExecutionStatus

Ƭ TNodeExecutionStatus: "idle" | "running" | "success" | "failed"

Defined in

dag-designer/src/components/dag-designer-context.tsx:38

---

TNodeOperationStatus

Ƭ TNodeOperationStatus: "idle" | "uploading" | "running" | "success" | "failed"

Defined in

dag-designer/src/components/dag-designer-context.tsx:40

---

TDagCanvasNode

Ƭ TDagCanvasNode: Node<IDagNodeViewData, "dag-node">

Defined in

dag-designer/src/components/dag-node-view.tsx:26

Variables

DagDesigner

• Const DagDesigner: Object

Type declaration

Name	Type
Root	(props: IDagDesignerRootProps) => ReactElement
Canvas	(props: IDagDesignerCanvasProps) => ReactElement
NodeExplorer	(props: IDagDesignerNodeExplorerProps) => ReactElement
Inspector	(props: IDagDesignerInspectorProps) => ReactElement
NodeConfig	(props: IDagDesignerNodeConfigProps) => ReactElement
NodeIoTrace	(props: IDagDesignerNodeIoTraceProps) => ReactElement
EdgeInspector	(props: IDagDesignerEdgeInspectorProps) => ReactElement
RunProgressSummary	(props: IDagDesignerRunProgressSummaryProps) => ReactElement

Defined in

dag-designer/src/components/dag-designer-canvas.tsx:392

---

DAG_DESIGNER_PACKAGE_NAME

• Const DAG_DESIGNER_PACKAGE_NAME: "@robota-sdk/dag-designer"

Defined in

dag-designer/src/index.ts:18

Functions

hasValidRunResult

▸ hasValidRunResult(run): boolean

Parameters

Name	Type
run	IRunResult

Returns

boolean

Defined in

dag-designer/src/client/designer-api-client.ts:70

---

DagBindingEdge

▸ DagBindingEdge(props): ReactElement

Parameters

Name	Type
props	EdgeProps

Returns

ReactElement

Defined in

dag-designer/src/components/dag-binding-edge.tsx:11

---

DagDesignerCanvas

▸ DagDesignerCanvas(props): ReactElement

Parameters

Name	Type
props	IDagDesignerCanvasProps

Returns

ReactElement

Defined in

dag-designer/src/components/dag-designer-canvas.tsx:91

---

useDagDesignerContext

▸ useDagDesignerContext(): IDagDesignerContextValue

Returns both state and actions. Prefer useDagDesignerState() or useDagDesignerActions() when you only need one — this hook re-renders on every state change.

Returns

IDagDesignerContextValue

Defined in

dag-designer/src/components/dag-designer-context.tsx:198

---

DagDesignerRoot

▸ DagDesignerRoot(props): ReactElement

Parameters

Name	Type
props	IDagDesignerRootProps

Returns

ReactElement

Defined in

dag-designer/src/components/dag-designer-context.tsx:223

---

DagDesignerNodeExplorer

▸ DagDesignerNodeExplorer(props): ReactElement

Parameters

Name	Type
props	IDagDesignerNodeExplorerProps

Returns

ReactElement

Defined in

dag-designer/src/components/dag-designer-panels.tsx:33

---

DagDesignerInspector

▸ DagDesignerInspector(props): ReactElement

Parameters

Name	Type
props	IDagDesignerInspectorProps

Returns

ReactElement

Defined in

dag-designer/src/components/dag-designer-panels.tsx:46

---

DagDesignerNodeConfig

▸ DagDesignerNodeConfig(props): ReactElement

Parameters

Name	Type
props	IDagDesignerNodeConfigProps

Returns

ReactElement

Defined in

dag-designer/src/components/dag-designer-panels.tsx:56

---

DagDesignerEdgeInspector

▸ DagDesignerEdgeInspector(props): ReactElement

Parameters

Name	Type
props	IDagDesignerEdgeInspectorProps

Returns

ReactElement

Defined in

dag-designer/src/components/dag-designer-panels.tsx:92

---

DagDesignerNodeIoTrace

▸ DagDesignerNodeIoTrace(props): ReactElement

Parameters

Name	Type
props	IDagDesignerNodeIoTraceProps

Returns

ReactElement

Defined in

dag-designer/src/components/dag-designer-panels.tsx:106

---

DagDesignerRunProgressSummary

▸ DagDesignerRunProgressSummary(props): ReactElement

Parameters

Name	Type
props	IDagDesignerRunProgressSummaryProps

Returns

ReactElement

Defined in

dag-designer/src/components/dag-designer-panels.tsx:137

---

DagNodeView

▸ DagNodeView(props): ReactElement

Parameters

Name	Type
props	NodeProps<TDagCanvasNode>

Returns

ReactElement

Defined in

dag-designer/src/components/dag-node-view.tsx:63

---

EdgeInspectorPanel

▸ EdgeInspectorPanel(props): ReactElement

Parameters

Name	Type
props	IEdgeInspectorPanelProps

Returns

ReactElement

Defined in

dag-designer/src/components/edge-inspector-panel.tsx:74

---

NodeConfigPanel

▸ NodeConfigPanel(props): ReactElement

Parameters

Name	Type
props	INodeConfigPanelProps

Returns

ReactElement

Defined in

dag-designer/src/components/node-config-panel.tsx:64

---

NodeExplorerPanel

▸ NodeExplorerPanel(props): ReactElement

Parameters

Name	Type
props	INodeExplorerPanelProps

Returns

ReactElement

Defined in

dag-designer/src/components/node-explorer-panel.tsx:21

---

NodeIoTracePanel

▸ NodeIoTracePanel(props): ReactElement

Parameters

Name	Type
props	INodeIoTracePanelProps

Returns

ReactElement

Defined in

dag-designer/src/components/node-io-trace-panel.tsx:16

---

NodeIoViewer

▸ NodeIoViewer(props): ReactElement

Parameters

Name	Type
props	INodeIoViewerProps

Returns

ReactElement

Defined in

dag-designer/src/components/node-io-viewer.tsx:134

---

useDagDesignApi

▸ useDagDesignApi(options): IUseDagDesignApi

Parameters

Name	Type
options	IUseDagDesignApiOptions

Returns

IUseDagDesignApi

Defined in

dag-designer/src/hooks/use-dag-design-api.ts:76

---

useDagDesignerState

▸ useDagDesignerState(): IDagDesignerState

Returns

IDagDesignerState

Defined in

dag-designer/src/hooks/use-dag-designer-state.ts:43

---

useDagDesignerActions

▸ useDagDesignerActions(): IDagDesignerActions

Returns

IDagDesignerActions

Defined in

dag-designer/src/hooks/use-dag-designer-state.ts:74