dag-api / Exports

dag-api

Table of contents

Classes

• RunProgressEventBus
• DagDesignController
• DagDiagnosticsController
• DagObservabilityController
• DagRuntimeController
• PromptApiController

Interfaces

• IDagControllerCompositionDependencies
• IDagControllerCompositionOptions
• IDagControllerComposition
• IDagExecutionCompositionDependencies
• IDagExecutionCompositionOptions
• IDagExecutionComposition
• IRunProgressLogger
• IRunProgressEventBus
• IApiSuccess
• IApiFailure
• IProblemDetails
• ICreateDefinitionRequest
• IUpdateDraftRequest
• IValidateDefinitionRequest
• IPublishDefinitionRequest
• IGetDefinitionRequest
• IListDefinitionsRequest
• IDefinitionListItem
• IListNodeCatalogRequest
• IDefinitionValidationResult
• IAnalyzeFailureRequest
• IRerunRequest
• IReinjectDeadLetterRequest
• IFailureCodeCount
• IFailureAnalysis
• IQueryRunProjectionRequest
• IQueryLineageProjectionRequest
• IObservabilityDashboardData
• ITriggerRunRequest
• IQueryRunRequest
• ICancelRunRequest
• INodeCatalogService
• IDiagnosticsPolicy

Type Aliases

• TRunProgressEventListener
• TApiResponse
• TDesignApiFailure
• TDesignApiResponse
• TDiagnosticsApiResponse
• TObservabilityApiResponse
• TRuntimeApiResponse

Variables

• DAG_API_PACKAGE_NAME

Functions

• createDagControllerComposition
• createDagExecutionComposition
• toProblemDetails
• toRuntimeProblemDetails

Type Aliases

TRunProgressEventListener

Ƭ TRunProgressEventListener: (event: TRunProgressEvent) => void

Callback type for receiving run progress events.

Type declaration

▸ (event): void

Parameters

Name	Type
event	TRunProgressEvent

Returns

void

Defined in

composition/run-progress-event-bus.ts:4

---

TApiResponse

Ƭ TApiResponse<TData, TError>: IApiSuccess<TData> | IApiFailure<TError>

Discriminated union of success or failure API responses.

Type parameters

Name
TData
TError

Defined in

contracts/common-api.ts:16

---

TDesignApiFailure

Ƭ TDesignApiFailure: IApiFailure<IProblemDetails>

Design API failure response with problem details.

Defined in

contracts/design-api.ts:70

---

TDesignApiResponse

Ƭ TDesignApiResponse<TData>: TApiResponse<TData, IProblemDetails>

Design API response type parameterized by the success data type.

Type parameters

Name
TData

Defined in

contracts/design-api.ts:72

---

TDiagnosticsApiResponse

Ƭ TDiagnosticsApiResponse<TData>: TApiResponse<TData, IProblemDetails>

Diagnostics API response type parameterized by the success data type.

Type parameters

Name
TData

Defined in

contracts/diagnostics-api.ts:40

---

TObservabilityApiResponse

Ƭ TObservabilityApiResponse<TData>: TApiResponse<TData, IProblemDetails>

Observability API response type parameterized by the success data type.

Type parameters

Name
TData

Defined in

contracts/observability-api.ts:24

---

TRuntimeApiResponse

Ƭ TRuntimeApiResponse<TData>: TApiResponse<TData, IProblemDetails>

Runtime API response type parameterized by the success data type.

Type parameters

Name
TData

Defined in

contracts/runtime-api.ts:29

Variables

DAG_API_PACKAGE_NAME

• Const DAG_API_PACKAGE_NAME: "@robota-sdk/dag-api"

Package name constant for @robota-sdk/dag-api.

Defined in

index.ts:19

Functions

createDagControllerComposition

▸ createDagControllerComposition(dependencies, options?): IDagControllerComposition

Creates a fully wired composition of all DAG API controllers.

Parameters

Name	Type	Description
dependencies	IDagControllerCompositionDependencies	Infrastructure ports (storage, queue, clock).
options?	IDagControllerCompositionOptions	Optional diagnostics policy and node catalog configuration.

Returns

IDagControllerComposition

Composed controller instances for design, runtime, observability, and diagnostics.

Defined in

composition/create-dag-controller-composition.ts:52

---

createDagExecutionComposition

▸ createDagExecutionComposition(dependencies, options): IDagExecutionComposition

Creates a fully wired DAG execution composition with orchestrator, worker loop, and event bus.

Parameters

Name	Type	Description
dependencies	IDagExecutionCompositionDependencies	Infrastructure ports (storage, queue, lease, executor, clock).
options	IDagExecutionCompositionOptions	Worker loop policy options.

Returns

IDagExecutionComposition

Composed execution services ready for DAG run processing.

Defined in

composition/create-dag-execution-composition.ts:50

---

toProblemDetails

▸ toProblemDetails(error, instance, correlationId?): IProblemDetails

Converts a DAG error into an RFC 7807-style problem details object.

Parameters

Name	Type	Description
error	IDagError	The DAG domain error to convert.
instance	string	The request URI that triggered the error.
correlationId?	string	Optional correlation ID for request tracing.

Returns

IProblemDetails

Problem details with appropriate HTTP status and category-based title.

Defined in

contracts/design-api.ts:87

---

toRuntimeProblemDetails

▸ toRuntimeProblemDetails(error, instance, correlationId?): IProblemDetails

Converts a DAG error into problem details for runtime API responses.

Parameters

Name	Type	Description
error	IDagError	The DAG domain error to convert.
instance	string	The request URI that triggered the error.
correlationId?	string	Optional correlation ID for request tracing.

Returns

IProblemDetails

Problem details with appropriate HTTP status.

Defined in

contracts/runtime-api.ts:38