@sourceloop/bpmn-service / Exports

@sourceloop/bpmn-service

Table of contents

Namespaces

• WorkflowServiceBindings

Enumerations

• ErrorKeys
• PermissionKey

Classes

• BPMTask
• ExecuteWorkflowDto
• Workflow
• WorkflowController
• WorkflowDto
• WorkflowProvider
• WorkflowRepository
• WorkflowServiceComponent
• WorkflowVersion
• WorkflowVersionRepository

Interfaces

• CaseDefinition
• DecisionDefinition
• DecisionRequirementDefinition
• DeploymentWithDefinitions
• IBPMTask
• ICommand
• IWorkflowServiceConfig
• ProcessDefinition
• ProcessInstance
• Variable
• WorflowManager
• WorkflowRelations
• WorkflowVersionRelations

Type Aliases

• DeployedCaseDefinitions
• DeployedDecisionDefinitions
• DeployedDecisionRequirementDefinitions
• DeployedProcessDefinitions
• ExecutionInputValidator
• Link
• SuccessResponse
• WorkerImplementationFn
• WorkerMap
• WorkerNameCmdPair
• WorkerRegisterFn
• WorkflowVersionWithRelations
• WorkflowWithRelations

Variables

• WorkflowCacheSourceName

Type Aliases

DeployedCaseDefinitions

Ƭ DeployedCaseDefinitions: Object

Index signature

▪ [definitionId: string]: CaseDefinition

Defined in

services/bpmn-service/src/types/camunda/deployement-with-definitions.ts:28

---

DeployedDecisionDefinitions

Ƭ DeployedDecisionDefinitions: Object

Index signature

▪ [definitionId: string]: DecisionDefinition

Defined in

services/bpmn-service/src/types/camunda/deployement-with-definitions.ts:32

---

DeployedDecisionRequirementDefinitions

Ƭ DeployedDecisionRequirementDefinitions: Object

Index signature

▪ [definitionId: string]: DecisionRequirementDefinition

Defined in

services/bpmn-service/src/types/camunda/deployement-with-definitions.ts:36

---

DeployedProcessDefinitions

Ƭ DeployedProcessDefinitions: Object

Index signature

▪ [definitionId: string]: ProcessDefinition

Defined in

services/bpmn-service/src/types/camunda/deployement-with-definitions.ts:24

---

ExecutionInputValidator

Ƭ ExecutionInputValidator<T>: (schema: AnyObject, input: T) => Promise<boolean>

Type parameters

Name	Type
T	AnyObject

Type declaration

▸ (schema, input): Promise<boolean>

Parameters

Name	Type
schema	AnyObject
input	T

Returns

Promise<boolean>

Defined in

services/bpmn-service/src/types/types.ts:41

---

Link

Ƭ Link: Object

Type declaration

Name	Type
href	string
method	string
rel	string

Defined in

services/bpmn-service/src/types/camunda/types.ts:5

---

SuccessResponse

Ƭ SuccessResponse: Object

Type declaration

Name	Type
externalId	string
fileRef?	string
processId	string
provider	string
version	number

Defined in

services/bpmn-service/src/types/types.ts:66

---

WorkerImplementationFn

Ƭ WorkerImplementationFn<T, R>: (worker: WorkerNameCmdPair<T, R>) => Promise<void>

Type parameters

Name	Type
T	AnyObject
R	AnyObject

Type declaration

▸ (worker): Promise<void>

Parameters

Name	Type
worker	WorkerNameCmdPair<T, R>

Returns

Promise<void>

Defined in

services/bpmn-service/src/types/types.ts:62

---

WorkerMap

Ƭ WorkerMap<T, R>: Object

Type parameters

Name	Type
T	AnyObject
R	AnyObject

Index signature

▪ [workflowName: string]: WorkerNameCmdPair<T, R>[]

Defined in

services/bpmn-service/src/types/types.ts:52

---

WorkerNameCmdPair

Ƭ WorkerNameCmdPair<T, R>: Object

Type parameters

Name	Type
T	AnyObject
R	AnyObject

Type declaration

Name	Type
command	BPMTask<T, R>
running	boolean
topic	string

Defined in

services/bpmn-service/src/types/types.ts:56

---

WorkerRegisterFn

Ƭ WorkerRegisterFn<T, R>: (bpmnName: string, topicName: string, commandCtor: BPMTask<T, R>) => Promise<void>

Type parameters

Name	Type
T	AnyObject
R	AnyObject

Type declaration

▸ (bpmnName, topicName, commandCtor): Promise<void>

Parameters

Name	Type
bpmnName	string
topicName	string
commandCtor	BPMTask<T, R>

Returns

Promise<void>

Defined in

services/bpmn-service/src/types/types.ts:46

---

WorkflowVersionWithRelations

Ƭ WorkflowVersionWithRelations: WorkflowVersion & WorkflowVersionRelations

Defined in

services/bpmn-service/src/models/workflow-version.model.ts:68

---

WorkflowWithRelations

Ƭ WorkflowWithRelations: Workflow & WorkflowRelations

Defined in

services/bpmn-service/src/models/workflow.model.ts:76

Variables

WorkflowCacheSourceName

• Const WorkflowCacheSourceName: "WorkflowCache"

Defined in

services/bpmn-service/src/types/types.ts:74