Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/hauptmedia/zeebe-gateway-types

Zeebe gRPC Gateway Protocol Client, Typescript Types & JSON Schemas
https://github.com/hauptmedia/zeebe-gateway-types
grpc grpc-client json-schema jsonschema jsonschema-generator zeebe zeebe-client
Last synced: 2 days ago
JSON representation
Zeebe gRPC Gateway Protocol Client, Typescript Types & JSON Schemas
Host: GitHub
URL: https://github.com/hauptmedia/zeebe-gateway-types
Owner: hauptmedia
License: apache-2.0
Created: 2022-11-28T14:29:26.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2022-12-01T20:03:08.000Z (almost 2 years ago)
Last Synced: 2024-09-20T08:02:13.383Z (7 days ago)
Topics: grpc, grpc-client, json-schema, jsonschema, jsonschema-generator, zeebe, zeebe-client
Language: TypeScript
Homepage: https://hauptmedia.github.io/zeebe-gateway-types/
Size: 706 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        Zeebe gRPC Gateway Protocol Client, Typescript Types & JSON Schemas

===================================================================

![Compatible with: Camunda Platform 8](https://img.shields.io/badge/Compatible%20with-Camunda%20Platform%208-0072Ce)

Follow this link for the [Zeebe gRPC Gateway Protocol Documentation](https://docs.camunda.io/docs/apis-clients/grpc/).

This library provides:

* a ready to use [grpc-js client](https://www.npmjs.com/package/@grpc/grpc-js) for the Zeebe Gateway Protocol

* Typescript type definitions for requests and responses including JSON transformers

* [JSON Schemas](https://json-schema.org/) for all requests and responses objects

## Installation

```shell

npm i --save @hauptmedia/zeebe-gateway-types

```

## Supported Messages

| Message Type 
|---------------------- 
| ActivateJobsRequest 
| ActivateJobsResponse 
| CancelProcessInstanceRequest 
| CancelProcessInstanceResponse 
| CompleteJobRequest 
| CompleteJobResponse 
| CreateProcessInstanceRequest 
| CreateProcessInstanceResponse 
| CreateProcessInstance 
| CreateProcessInstance 
| DeployResourceRequest 
| DeployResourceResponse 
| FailJobRequest 
| FailJobResponse 
| ModifyProcessInstanceRequest 
| ModifyProcessInstanceResponse 
| PublishMessageRequest 
| PublishMessageResponse 
| ResolveIncidentRequest 
| ResolveIncidentResponse 
| SetVariablesRequest 
| SetVariablesResponse 
| ThrowErrorRequest 
| ThrowErrorResponse 
| TopologyRequest 
| TopologyResponse 
| UpdateJobRetriesRequest 
| UpdateJobRetriesResponse

| Docs                                                                                                             | JSON Schema                                                                                                             | -------------------|------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------| | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/activatejobsrequest.html)                     | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/ActivateJobsRequest.json)                     | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/activatejobsresponse.html)                    | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/ActivateJobsResponse.json)                    | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/cancelprocessinstancerequest.html)            | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/CancelProcessInstanceRequest.json)            | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/cancelprocessinstanceresponse.html)           | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/CancelProcessInstanceResponse.json)           | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/completejobrequest.html)                      | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/CompleteJobRequest.json)                      | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/completejobresponse.html)                     | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/CompleteJobResponse.json)                     | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/createprocessinstancerequest.html)            | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/CreateProcessInstanceRequest.json)            | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/createprocessinstanceresponse.html)           | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/CreateProcessInstanceResponse.json)           | WithResultRequest  | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/createprocessinstancewithresultrequest.html)  | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/CreateProcessInstanceWithResultRequest.json)  | WithResultResponse | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/createprocessinstancewithresultresponse.html) | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/CreateProcessInstanceWithResultResponse.json) | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/deployresourcerequest.html)                   | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/DeployResourceRequest.json)                   | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/deployresourceresponse.html)                  | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/DeployResourceResponse.json)                  | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/failjobrequest.html)                          | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/FailJobRequest.json)                          | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/failjobresponse.html)                         | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/FailJobResponse.json)                         | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/modifyprocessinstancerequest.html)            | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/ModifyProcessInstanceRequest.json)            | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/modifyprocessinstanceresponse.html)           | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/ModifyProcessInstanceResponse.json)           | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/publishmessagerequest.html)                   | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/PublishMessageRequest.json)                   | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/publishmessageresponse.html)                  | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/PublishMessageResponse.json)                  | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/resolveincidentrequest.html)                  | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/ResolveIncidentRequest.json)                  | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/resolveincidentresponse.html)                 | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/ResolveIncidentResponse.json)                 | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/setvariablesrequest.html)                     | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/SetVariablesRequest.json)                     | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/setvariablesresponse.html)                    | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/SetVariablesResponse.json)                    | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/throwerrorrequest.html)                       | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/ThrowErrorRequest.json)                       | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/throwerrorresponse.html)                      | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/ThrowErrorResponse.json)                      | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/topologyrequest.html)                         | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/TopologyRequest.json)                         | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/topologyresponse.html)                        | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/TopologyResponse.json)                        | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/updatejobretriesrequest.html)                 | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/UpdateJobRetriesRequest.json)                 | | [docs](https://hauptmedia.github.io/zeebe-gateway-types/interfaces/updatejobretriesresponse.html)                | [JSON Schema](https://hauptmedia.github.io/zeebe-gateway-types/jsonschema/UpdateJobRetriesResponse.json)                |

## Usage for the grpc-js client

```typescript

import {GatewayClient, DeployResourceRequest} from "@hauptmedia/zeebe-gateway-types";

import {ChannelCredentials} from "@grpc/grpc-js";

const zbc = new GatewayClient("localhost:26500", ChannelCredentials.createInsecure());

const req = DeployResourceRequest.fromJSON({

    "resources": [

        {

            "name": "test.bpmn",

            "content": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPGJwbW46ZGVmaW5pdGlvbnMgeG1sbnM6YnBtbj0iaHR0cDovL3d3dy5vbWcub3JnL3NwZWMvQlBNTi8yMDEwMDUyNC9NT0RFTCIgeG1sbnM6YnBtbmRpPSJodHRwOi8vd3d3Lm9tZy5vcmcvc3BlYy9CUE1OLzIwMTAwNTI0L0RJIiB4bWxuczpkYz0iaHR0cDovL3d3dy5vbWcub3JnL3NwZWMvREQvMjAxMDA1MjQvREMiIHhtbG5zOmRpPSJodHRwOi8vd3d3Lm9tZy5vcmcvc3BlYy9ERC8yMDEwMDUyNC9ESSIgeG1sbnM6bW9kZWxlcj0iaHR0cDovL2NhbXVuZGEub3JnL3NjaGVtYS9tb2RlbGVyLzEuMCIgaWQ9IkRlZmluaXRpb25zXzF3cXR5eWkiIHRhcmdldE5hbWVzcGFjZT0iaHR0cDovL2JwbW4uaW8vc2NoZW1hL2JwbW4iIGV4cG9ydGVyPSJDYW11bmRhIE1vZGVsZXIiIGV4cG9ydGVyVmVyc2lvbj0iNS40LjEiIG1vZGVsZXI6ZXhlY3V0aW9uUGxhdGZvcm09IkNhbXVuZGEgQ2xvdWQiIG1vZGVsZXI6ZXhlY3V0aW9uUGxhdGZvcm1WZXJzaW9uPSI4LjEuMCI+CjxicG1uOnByb2Nlc3MgaWQ9IlByb2Nlc3NfMTF6bG5lZyIgaXNFeGVjdXRhYmxlPSJ0cnVlIj4KPGJwbW46c3RhcnRFdmVudCBpZD0iU3RhcnRFdmVudF8xIj4KPGJwbW46b3V0Z29pbmc+Rmxvd18wanQ4bHUzPC9icG1uOm91dGdvaW5nPgo8L2JwbW46c3RhcnRFdmVudD4KPGJwbW46ZW5kRXZlbnQgaWQ9IkV2ZW50XzE3anp2eGwiPgo8YnBtbjppbmNvbWluZz5GbG93XzBqdDhsdTM8L2JwbW46aW5jb21pbmc+CjwvYnBtbjplbmRFdmVudD4KPGJwbW46c2VxdWVuY2VGbG93IGlkPSJGbG93XzBqdDhsdTMiIHNvdXJjZVJlZj0iU3RhcnRFdmVudF8xIiB0YXJnZXRSZWY9IkV2ZW50XzE3anp2eGwiIC8+CjwvYnBtbjpwcm9jZXNzPgo8YnBtbmRpOkJQTU5EaWFncmFtIGlkPSJCUE1ORGlhZ3JhbV8xIj4KPGJwbW5kaTpCUE1OUGxhbmUgaWQ9IkJQTU5QbGFuZV8xIiBicG1uRWxlbWVudD0iUHJvY2Vzc18xMXpsbmVnIj4KPGJwbW5kaTpCUE1OU2hhcGUgaWQ9Il9CUE1OU2hhcGVfU3RhcnRFdmVudF8yIiBicG1uRWxlbWVudD0iU3RhcnRFdmVudF8xIj4KPGRjOkJvdW5kcyB4PSIxNzkiIHk9Ijc5IiB3aWR0aD0iMzYiIGhlaWdodD0iMzYiIC8+CjwvYnBtbmRpOkJQTU5TaGFwZT4KPGJwbW5kaTpCUE1OU2hhcGUgaWQ9IkV2ZW50XzE3anp2eGxfZGkiIGJwbW5FbGVtZW50PSJFdmVudF8xN2p6dnhsIj4KPGRjOkJvdW5kcyB4PSIyOTIiIHk9Ijc5IiB3aWR0aD0iMzYiIGhlaWdodD0iMzYiIC8+CjwvYnBtbmRpOkJQTU5TaGFwZT4KPGJwbW5kaTpCUE1ORWRnZSBpZD0iRmxvd18wanQ4bHUzX2RpIiBicG1uRWxlbWVudD0iRmxvd18wanQ4bHUzIj4KPGRpOndheXBvaW50IHg9IjIxNSIgeT0iOTciIC8+CjxkaTp3YXlwb2ludCB4PSIyOTIiIHk9Ijk3IiAvPgo8L2JwbW5kaTpCUE1ORWRnZT4KPC9icG1uZGk6QlBNTlBsYW5lPgo8L2JwbW5kaTpCUE1ORGlhZ3JhbT4KPC9icG1uOmRlZmluaXRpb25zPg=="

        }

    ]

});

zbc.deployResource(req, (error, response) => {

    if (error)

        throw error;

    else

        console.log(response);

});

```