Merge branch 'release/1.1'

Author: zambrovski

.github/workflows/development.yml

@@ -72,6 +72,6 @@ jobs:
 
       - name: Upload coverage to Codecov
         if: github.event_name == 'push' && github.actor != 'dependabot[bot]'
-        uses: codecov/codecov-action@v5.4.0
+        uses: codecov/codecov-action@v5.4.2
         with:
           token: ${{secrets.CODECOV_TOKEN}}

.github/workflows/master.yml

@@ -47,6 +47,6 @@ jobs:
           OSS_CENTRAL_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
 
       - name: Upload coverage information
-        uses: codecov/codecov-action@v5.4.0
+        uses: codecov/codecov-action@v5.4.2
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

README.md

@@ -12,13 +12,6 @@ of adapters to relevant process engines (Camunda Platform 7, Camunda Platform 8,
 the integration of process engine from the selection of the used engine. This approach fosters an easy migration between engines 
 and tries to achieve to support migrations with minimal (or even no) code modifications. 
 
-## Anatomy
-
-The library contains of the following Maven modules:
-
-- `process-engine-api`: pure API written in Kotlin (100% Java-compatible)
-- `process-engine-api-impl`: commons implementation, which is independent of the selected engine and can be used for adapter implementations.
-
 ## API
 
 The API consists of different parts independent of each other.
@@ -31,21 +24,34 @@ The API consists of different parts independent of each other.
 - User Task Completion API
 - Service Task Completion API
 
-The Task API provides functionality to deal with service tasks. The task handlers can be registered and get invoked when tasks 
-appear in the process engine. Since the Task API allows asynchronous processing, we provide a special API to complete tasks.
+## Helpful Components
+
+- User Task Support
 
-## Available Adapters
+## Available Engine Adapters
 
 If you want to try the API, please refer to one of the adapter implementations matching your infrastructure. For example:
 
-- [Camunda Platform 7 Adapter](https://github.com/bpm-crafters/process-engine-adapters-camunda-7)
-- [Camunda Platform 8 Adapter](https://github.com/bpm-crafters/process-engine-adapters-camunda-8)
+- [Camunda Platform 7 Adapter](https://github.com/bpm-crafters/process-engine-adapters-camunda-7) [![Maven Central Version](https://img.shields.io/maven-central/v/dev.bpm-crafters.process-engine-adapters/process-engine-adapter-camunda-platform-c7-bom?color=#2cc657)](https://maven-badges.herokuapp.com/maven-central/dev.bpm-crafters.process-engine-adapters/process-engine-adapter-camunda-platform-c7-bom)
+
+
+- [Camunda Platform 8 Adapter](https://github.com/bpm-crafters/process-engine-adapters-camunda-8) [![Maven Central Version](https://img.shields.io/maven-central/v/dev.bpm-crafters.process-engine-adapters/process-engine-adapter-camunda-platform-c8-bom?color=#2cc657)](https://maven-badges.herokuapp.com/maven-central/dev.bpm-crafters.process-engine-adapters/process-engine-adapter-camunda-platform-c8-bom)
 
-## Worker
+
+
+## Process Engine Worker
 
 If you are using the Process Engine API to provide workers using Spring Boot, there is a library with improved support for it:
 
-- [Process Engine Worker](https://github.com/bpm-crafters/process-engine-worker)
+- [Process Engine Worker](https://github.com/bpm-crafters/process-engine-worker) [![Maven Central Version](https://img.shields.io/maven-central/v/dev.bpm-crafters.process-engine-worker/process-engine-worker-spring-boot-starter?color=#2cc657)](https://maven-badges.herokuapp.com/maven-central/dev.bpm-crafters.process-engine-worker/process-engine-worker-spring-boot-starter)
+
+
+## Anatomy
+
+The library contains of the following Maven modules:
+
+- `process-engine-api`: pure API written in Kotlin (100% Java-compatible)
+- `process-engine-api-impl`: commons implementation, which is independent of the selected engine and can be used for adapter implementations.
 
 ## Contribution and Development
 

api-impl/pom.xml

@@ -5,7 +5,7 @@
   <parent>
     <groupId>dev.bpm-crafters.process-engine-api</groupId>
     <artifactId>process-engine-api-root</artifactId>
-    <version>1.0</version>
+    <version>1.1</version>
     <relativePath>../pom.xml</relativePath>
   </parent>
 

api/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>dev.bpm-crafters.process-engine-api</groupId>
     <artifactId>process-engine-api-root</artifactId>
-    <version>1.0</version>
+    <version>1.1</version>
   </parent>
 
   <artifactId>process-engine-api</artifactId>

api/src/main/kotlin/dev/bpmcrafters/processengineapi/correlation/CorrelateMessageCmd.kt

@@ -10,4 +10,20 @@ data class CorrelateMessageCmd(
   val messageName: String,
   val payloadSupplier: PayloadSupplier,
   val correlation: CorrelationSupplier
-) : PayloadSupplier by payloadSupplier
+) : PayloadSupplier by payloadSupplier {
+  /**
+   * Constructs a correlation command by message name, payload and correlation.
+   * @param messageName message name.
+   * @param payload payload to use.
+   * @param correlation correlation to use.
+   */
+  constructor(messageName: String, payload: Map<String, Any>, correlation: Correlation) :
+    this(messageName = messageName, payloadSupplier = PayloadSupplier { payload }, correlation = CorrelationSupplier { correlation} )
+  /**
+   * Constructs a correlation command by message name, no payload and correlation.
+   * @param messageName message name.
+   * @param correlation correlation to use.
+   */
+  constructor(messageName: String, correlation: Correlation) : this(messageName, mapOf() , correlation)
+
+}

api/src/main/kotlin/dev/bpmcrafters/processengineapi/correlation/CorrelationSupplier.kt

@@ -6,4 +6,4 @@ import java.util.function.Supplier
  * Correlation supplier.
  * @since 0.0.1
  */
-interface CorrelationSupplier : Supplier<Correlation>
+fun interface CorrelationSupplier : Supplier<Correlation>

api/src/main/kotlin/dev/bpmcrafters/processengineapi/correlation/SendSignalCmd.kt

@@ -10,4 +10,19 @@ data class SendSignalCmd(
   val signalName: String,
   val payloadSupplier: PayloadSupplier,
   val restrictions: Map<String, String>
-) : PayloadSupplier by payloadSupplier
+) : PayloadSupplier by payloadSupplier {
+  /**
+   * Constructs a signal command by signal name, restrictions and given payload.
+   * @param signalName signal name.
+   * @param restrictions restrictions.
+   * @param payload payload to use.
+   */
+  constructor(signalName: String, restrictions: Map<String, String>, payload: Map<String, Any>) : this(signalName, PayloadSupplier { payload }, restrictions )
+  /**
+   * Constructs a signal command by signal name, restrictions and no payload.
+   * @param signalName signal name.
+   * @param restrictions restrictions.
+   */
+  constructor(signalName: String, restrictions: Map<String, String>) : this(signalName, restrictions, mapOf() )
+
+}

api/src/main/kotlin/dev/bpmcrafters/processengineapi/process/StartProcessByDefinitionCmd.kt

@@ -15,4 +15,16 @@ data class StartProcessByDefinitionCmd(
    * Payload supplier to pass to the new process instance.
    */
   val payloadSupplier: PayloadSupplier
-) : StartProcessCommand, PayloadSupplier by payloadSupplier
+) : StartProcessCommand, PayloadSupplier by payloadSupplier {
+  /**
+   * Constructs a start command with definition key and payload.
+   * @param definitionKey process definition key.
+   * @param payload payload to use.
+   */
+  constructor(definitionKey: String, payload: Map<String, Any>) : this(definitionKey, PayloadSupplier { payload } )
+  /**
+   * Constructs a start command with definition key and no payload.
+   * @param definitionKey process definition key.
+   */
+  constructor(definitionKey: String) : this(definitionKey, mapOf() )
+}

api/src/main/kotlin/dev/bpmcrafters/processengineapi/process/StartProcessByMessageCmd.kt

@@ -15,4 +15,17 @@ data class StartProcessByMessageCmd(
    * Payload supplier.
    */
   val payloadSupplier: PayloadSupplier
-) : StartProcessCommand, PayloadSupplier by payloadSupplier
+) : StartProcessCommand, PayloadSupplier by payloadSupplier {
+  /**
+   * Constructs a start command by message name and payload.
+   * @param messageName message name.
+   * @param payload payload to use.
+   */
+  constructor(messageName: String, payload: Map<String, Any>) : this(messageName, PayloadSupplier { payload } )
+  /**
+   * Constructs a start command by message and no payload.
+   * @param messageName message name.
+   */
+  constructor(messageName: String) : this(messageName, mapOf() )
+
+}