Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hauptmedia/zeebe-exporter-types
Typescript type & JSON Schema definitions for JSON encoded export data used by the Zeebe Workflow Automation Engine
https://github.com/hauptmedia/zeebe-exporter-types
jsonschema jsonschema-generator typescript typescript-definitions typescript-library zeebe zeebe-exporter zeebe-tool
Last synced: about 1 month ago
JSON representation
Typescript type & JSON Schema definitions for JSON encoded export data used by the Zeebe Workflow Automation Engine
- Host: GitHub
- URL: https://github.com/hauptmedia/zeebe-exporter-types
- Owner: hauptmedia
- License: apache-2.0
- Created: 2022-11-22T17:24:07.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-03T11:49:08.000Z (about 2 years ago)
- Last Synced: 2024-04-24T19:04:57.927Z (9 months ago)
- Topics: jsonschema, jsonschema-generator, typescript, typescript-definitions, typescript-library, zeebe, zeebe-exporter, zeebe-tool
- Language: TypeScript
- Homepage: https://hauptmedia.github.io/zeebe-exporter-types/
- Size: 448 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Zeebe JSON Export Typescript Types
==================================
Typescript type & JSON Schema definitions for JSON encoded export data used by the Zeebe Workflow Automation Engine.
You can find the JSON Schema definitions of the Zeebe Events [here](https://github.com/hauptmedia/zeebe-exporter-types/tree/main/src/generated/jsonschema).
## Installation
```shell
npm i --save @hauptmedia/zeebe-exporter-types
```
## Kafka example
This example shows how to leverage this library to process JSON encoded Zeebe event data coming from Kafka.
Use the [zeebe-kafka-exporter](https://github.com/camunda-community-hub/zeebe-kafka-exporter) for Zeebe to export event data to Kafka.
You can find the example project in [examples/kafka](https://github.com/hauptmedia/zeebe-exporter-types/tree/main/examples/kafka).
```typescript
import {
dispatchZeebeRecordToHandler,
NoOpZeebeRecordHandler,
ProcessInstanceRecordValue,
ValueType,
ZeebeRecord,
ZeebeRecordHandlerInterface
} from "@hauptmedia/zeebe-exporter-types";
import {Kafka} from 'kafkajs';
class MyRecordHandler extends NoOpZeebeRecordHandler implements ZeebeRecordHandlerInterface {
// Override the methods for the records you want to process or implement ZeebeRecordHandlerInterface
processInstance(record: ZeebeRecord) {
console.log(`${record.intent} ${record.value.bpmnElementType} ${record.value.elementId}`);
}
}
const kafka = new Kafka({
clientId: 'exampleClientId',
brokers: ['localhost:9093']
}),
zbRecordHandler = new MyRecordHandler(),
consumer = kafka.consumer({groupId: 'exampleGroupId'});
const run = async () => {
await consumer.connect()
await consumer.subscribe({topic: "zeebe"})
await consumer.run({
eachMessage: async ({topic, partition, message, heartbeat, pause}) => {
if (!message.value)
return;
dispatchZeebeRecordToHandler(
JSON.parse(message.value.toString()) as ZeebeRecord,
zbRecordHandler
);
},
})
}
run().catch(console.error);
```
## Structure of Zeebe export data
Please follow the links for the detailed documentation of the data structure.
### Base Record
* [ZeebeRecord](https://hauptmedia.github.io/zeebe-exporter-types/globals.html#zeeberecord)
### Value Types
* [DecisionEvaluationRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/decisionevaluationrecordvalue.html)
* [DecisionRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/decisionrecordvalue.html)
* [DecisionRequirementsRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/decisionrequirementsrecordvalue.html)
* [DeploymentDistributionRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/deploymentdistributionrecordvalue.html)
* [DeploymentRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/deploymentrecordvalue.html)
* [ErrorRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/errorrecordvalue.html)
* [EscalationRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/escalationrecordvalue.html)
* [IncidentRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/incidentrecordvalue.html)
* [JobBatchRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/jobbatchrecordvalue.html)
* [JobRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/jobrecordvalue.html)
* [MessageRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/messagerecordvalue.html)
* [MessageStartEventSubscriptionRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/messagestarteventsubscriptionrecordvalue.html)
* [MessageSubscriptionRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/messagesubscriptionrecordvalue.html)
* [ProcessEventRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/processeventrecordvalue.html)
* [ProcessInstanceCreationRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/processinstancecreationrecordvalue.html)
* [ProcessInstanceRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/processinstancerecordvalue.html)
* [ProcessInstanceModificationRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/processinstancemodificationrecordvalue.html)
* [ProcessInstanceResultRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/processinstanceresultrecordvalue.html)
* [Process](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/process.html)
* [ProcessMessageSubscriptionRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/processmessagesubscriptionrecordvalue.html)
* [TimerRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/timerrecordvalue.html)
* [VariableDocumentRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/variabledocumentrecordvalue.html)
* [VariableRecordValue](https://hauptmedia.github.io/zeebe-exporter-types/interfaces/variablerecordvalue.html)