added docs/api

.gitignore

@@ -13,7 +13,7 @@
 /dist
 # generated docs
 /.docusaurus
-/docs/api
+#/docs/api  - needs them for /README.md
 /build
 # Copied by scripts\copy-readme.ts
 docs/README.md

README.md

@@ -16,9 +16,9 @@ Typically your application has multiple bpmn models, a model is represented in a
 
 Each Model is made of various elements, an `element` can be a `node` in the diagram (events/tasks/gateway) or a  `flow`
 
-Models are saved by `bpmn-server` and can be queried [see API.model](docs/api/interfaces/IAPIModel)
+Models are saved by `bpmn-server` and can be queried [see API.model](docs/api/interfaces/IAPIModel.md)
 
-`bpmn-server` support all bpmn 2.0 elements [see Modeling Support](docs/examples)
+`bpmn-server` support all bpmn 2.0 elements [see Modeling Support](docs/examples.md)
 
 ## Execution
 `bpmn-server` is primiraly an execution engine for bpmn models.
@@ -29,7 +29,7 @@ Execution is based on the model logic that is enhanced by various extensions tha
 
 During Execution, Model Listeners and Application Listeners are invoked.
 
-The execution `engine` is availabe through an API [see API.engine](docs/api/interfaces/IAPIEngine).
+The execution `engine` is availabe through an API [see API.engine](docs/api/interfaces/IAPIEngine.md).
 
 For more details about Invoking Execution Engine [see](docs/invokation.md)
 
@@ -39,9 +39,9 @@ For more details about Execution behaviour [see](docs/execution.md)
 
 At various stages of execution, instance object with its parts is saved into a datastore (defaults to MongoDB)
 
-Instances and Items can be queried through an API [see API.data](docs/api/interfaces/IAPIData)
+Instances and Items can be queried through an API [see API.data](docs/api/interfaces/IAPIData.md)
 
-For more details about data management [see Data](docs/data)
+For more details about data management [see Data](docs/data.md)
 
 # Demo Web Application
 
@@ -185,18 +185,18 @@ npm update bpmn-server
 
 # Documentation
 
-- [Invoking Workflows](/docs/invokation) Ok
-- [Execution](/docs/execution) OK
-- [Scripting](/docs/scripting) OK
-- [Security](/docs/security) Ok
-- [Data](/docs/data) Needs Review
-  -  [Input/Output](/docs/data#input-output-data)
-  -  [Data Query](/docs/data#dataQuery) OK
-- [Examples](/docs/examples) OK
-- [API Summary](/docs/api-summary)
-- [API](/docs/api/readme) OK
-- [Setup](/docs/setup) Needs Review
-- [Application Integration](/docs/customization) Needs work
+- [Invoking Workflows](/docs/invokation.md) Ok
+- [Execution](/docs/execution.md) OK
+- [Scripting](/docs/scripting.md) OK
+- [Security](/docs/security.md) Ok
+- [Data](/docs/data.md) Needs Review
+  -  [Input/Output](/docs/data#input-output-data.md)
+  -  [Data Query](/docs/data#dataQuery.md) OK
+- [Examples](/docs/examples.md) OK
+- [API Summary](/docs/api-summary.md)
+- [API](/docs/api/readme.md) OK
+- [Setup](/docs/setup.md) Needs Review
+- [Application Integration](/docs/customization.md) Needs work
 
 # License
 

docs/api/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/api/API.md

@@ -0,0 +1,214 @@
+bpmn-server
+
+# bpmn-server
+
+## Table of contents
+
+### Enumerations
+
+- [USER\_ROLE](enums/USER_ROLE.md)
+- [TOKEN\_TYPE](enums/TOKEN_TYPE.md)
+- [BPMN\_TYPE](enums/BPMN_TYPE.md)
+- [NODE\_SUBTYPE](enums/NODE_SUBTYPE.md)
+- [EXECUTION\_EVENT](enums/EXECUTION_EVENT.md)
+- [NODE\_ACTION](enums/NODE_ACTION.md)
+- [ITEM\_STATUS](enums/ITEM_STATUS.md)
+- [EXECUTION\_STATUS](enums/EXECUTION_STATUS.md)
+- [TOKEN\_STATUS](enums/TOKEN_STATUS.md)
+- [FLOW\_ACTION](enums/FLOW_ACTION.md)
+
+### Classes
+
+- [BPMNAPI](classes/BPMNAPI.md)
+- [APIEngine](classes/APIEngine.md)
+- [APIData](classes/APIData.md)
+- [APIModel](classes/APIModel.md)
+- [SecureUser](classes/SecureUser.md)
+- [Configuration](classes/Configuration.md)
+- [Logger](classes/Logger.md)
+- [DataStore](classes/DataStore.md)
+- [InstanceLocker](classes/InstanceLocker.md)
+- [BpmnModelData](classes/BpmnModelData.md)
+- [ProcessData](classes/ProcessData.md)
+- [EventData](classes/EventData.md)
+- [ModelsDatastore](classes/ModelsDatastore.md)
+- [ModelsDatastoreDB](classes/ModelsDatastoreDB.md)
+- [MongoDB](classes/MongoDB.md)
+- [Definition](classes/Definition.md)
+- [Element](classes/Element.md)
+- [Event](classes/Event.md)
+- [CatchEvent](classes/CatchEvent.md)
+- [BoundaryEvent](classes/BoundaryEvent.md)
+- [ThrowEvent](classes/ThrowEvent.md)
+- [EndEvent](classes/EndEvent.md)
+- [StartEvent](classes/StartEvent.md)
+- [Flow](classes/Flow.md)
+- [MessageFlow](classes/MessageFlow.md)
+- [Gateway](classes/Gateway.md)
+- [XORGateway](classes/XORGateway.md)
+- [EventBasedGateway](classes/EventBasedGateway.md)
+- [Node](classes/Node.md)
+- [NodeLoader](classes/NodeLoader.md)
+- [Process](classes/Process.md)
+- [ScriptTask](classes/ScriptTask.md)
+- [ServiceTask](classes/ServiceTask.md)
+- [BusinessRuleTask](classes/BusinessRuleTask.md)
+- [SendTask](classes/SendTask.md)
+- [UserTask](classes/UserTask.md)
+- [ReceiveTask](classes/ReceiveTask.md)
+- [SubProcess](classes/SubProcess.md)
+- [CallActivity](classes/CallActivity.md)
+- [Transaction](classes/Transaction.md)
+- [Behaviour](classes/Behaviour.md)
+- [BehaviourLoader](classes/BehaviourLoader.md)
+- [CamundaFormData](classes/CamundaFormData.md)
+- [IOBehaviour](classes/IOBehaviour.md)
+- [LoopBehaviour](classes/LoopBehaviour.md)
+- [MessageEventBehaviour](classes/MessageEventBehaviour.md)
+- [SignalEventBehaviour](classes/SignalEventBehaviour.md)
+- [ScriptBehaviour](classes/ScriptBehaviour.md)
+- [TerminateBehaviour](classes/TerminateBehaviour.md)
+- [TimerBehaviour](classes/TimerBehaviour.md)
+- [DefaultAppDelegate](classes/DefaultAppDelegate.md)
+- [Execution](classes/Execution.md)
+- [Item](classes/Item.md)
+- [Loop](classes/Loop.md)
+- [InstanceObject](classes/InstanceObject.md)
+- [ItemObject](classes/ItemObject.md)
+- [TokenObject](classes/TokenObject.md)
+- [LoopObject](classes/LoopObject.md)
+- [Query](classes/Query.md)
+- [ScriptHandler](classes/ScriptHandler.md)
+- [Token](classes/Token.md)
+- [BPMNServer](classes/BPMNServer.md)
+- [NoCacheManager](classes/NoCacheManager.md)
+- [CacheManager](classes/CacheManager.md)
+- [Cron](classes/Cron.md)
+- [Engine](classes/Engine.md)
+- [ServerComponent](classes/ServerComponent.md)
+
+### Interfaces
+
+- [IAPIEngine](interfaces/IAPIEngine.md)
+- [IAPIData](interfaces/IAPIData.md)
+- [IAPIModel](interfaces/IAPIModel.md)
+- [IBehaviour](interfaces/IBehaviour.md)
+- [IItemData](interfaces/IItemData.md)
+- [IInstanceData](interfaces/IInstanceData.md)
+- [IDefinitionData](interfaces/IDefinitionData.md)
+- [IElementData](interfaces/IElementData.md)
+- [IFlowData](interfaces/IFlowData.md)
+- [IEventData](interfaces/IEventData.md)
+- [IBpmnModelData](interfaces/IBpmnModelData.md)
+- [IProcessData](interfaces/IProcessData.md)
+- [IUserInfo](interfaces/IUserInfo.md)
+- [ISecureUser](interfaces/ISecureUser.md)
+- [IUserService](interfaces/IUserService.md)
+- [IConfiguration](interfaces/IConfiguration.md)
+- [ILogger](interfaces/ILogger.md)
+- [IAppDelegate](interfaces/IAppDelegate.md)
+- [IDataStore](interfaces/IDataStore.md)
+- [IModelsDatastore](interfaces/IModelsDatastore.md)
+- [IDefinition](interfaces/IDefinition.md)
+- [IElement](interfaces/IElement.md)
+- [IFlow](interfaces/IFlow.md)
+- [INode](interfaces/INode.md)
+- [IToken](interfaces/IToken.md)
+- [IExecution](interfaces/IExecution.md)
+- [IItem](interfaces/IItem.md)
+- [IBPMNServer](interfaces/IBPMNServer.md)
+- [IServerComponent](interfaces/IServerComponent.md)
+- [IEngine](interfaces/IEngine.md)
+- [ICron](interfaces/ICron.md)
+- [ICacheManager](interfaces/ICacheManager.md)
+
+### Variables
+
+- [SystemUser](API.md#systemuser)
+- [defaultConfiguration](API.md#defaultconfiguration)
+- [Behaviour\_names](API.md#behaviour_names)
+- [docsFolder](API.md#docsfolder)
+
+### Functions
+
+- [dateDiff](API.md#datediff)
+
+## Variables
+
+### SystemUser
+
+• `Const` **SystemUser**: [`SecureUser`](classes/SecureUser.md)
+
+#### Defined in
+
+[API/SecureUser.ts:230](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/API/SecureUser.ts#L230)
+
+___
+
+### defaultConfiguration
+
+• **defaultConfiguration**: [`Configuration`](classes/Configuration.md)
+
+#### Defined in
+
+[common/DefaultConfiguration.ts:59](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/DefaultConfiguration.ts#L59)
+
+___
+
+### Behaviour\_names
+
+• `Const` **Behaviour\_names**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `TimerEventDefinition` | `string` |
+| `LoopCharacteristics` | `string` |
+| `IOSpecification` | `string` |
+| `TerminateEventDefinition` | `string` |
+| `MessageEventDefinition` | `string` |
+| `SignalEventDefinition` | `string` |
+| `ErrorEventDefinition` | `string` |
+| `EscalationEventDefinition` | `string` |
+| `CancelEventDefinition` | `string` |
+| `CompensateEventDefinition` | `string` |
+| `CamundaFormData` | `string` |
+| `CamundaScript` | `string` |
+| `CamundaScript2` | `string` |
+| `CamundaScript3` | `string` |
+| `CamundaIO` | `string` |
+
+#### Defined in
+
+[elements/behaviours/BehaviourLoader.ts:16](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/elements/behaviours/BehaviourLoader.ts#L16)
+
+___
+
+### docsFolder
+
+• `Const` **docsFolder**: `string`
+
+#### Defined in
+
+[index.ts:9](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/index.ts#L9)
+
+## Functions
+
+### dateDiff
+
+▸ **dateDiff**(`dateStr`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `dateStr` | `any` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[common/timer.ts:4](https://github.com/bpmnServer/bpmn-server/blob/2a5d20f/src/common/timer.ts#L4)