feat(zeebe): support Zeebe User Task REST API

* feat(zeebe): support Zeebe User Task REST API

Implement ZeebeRESTClient

fixes #34

* docs(zeebe): document ZeebeRestClient

* refactor(repo): rename docker-compose files to *.yaml

* test(zeebe): fix Topology Rest Client test

* ci(repo): fix GitHub workflow docker-compose

* ci(repo): rename docker-compose.yaml

* ci(repo): enable Zeebe REST tests in CI

* refactor: improve error messages

* test(zeebe): improve test structure

* refactor(zeebe): add headers to REST requests

* fix(zeebe): request correct token for Zeebe

* ci(repo): run windows tests on windows 2016

* ci(repo): use cross-platform regex for unit test

* ci(repo): use windows-2019 runner for tests

* ci(repo): disable windows tests

.github/workflows/commitlint.yml

@@ -13,7 +13,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "18" # Specify a Node.js version
+          node-version: "20" # Specify a Node.js version
 
       - name: Install dependencies
         run: npm install

.github/workflows/pr-test.yml

@@ -12,7 +12,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "18" # Specify a Node.js version
+          node-version: "20" # Specify a Node.js version
 
       - name: Install dependencies
         run: npm install
@@ -24,26 +24,26 @@ jobs:
         run: |
           npm run test
 
-  unit-tests-windows:
-    runs-on: windows-latest
-    steps:
-      - name: Check out the repo
-        uses: actions/checkout@v4
+  # unit-tests-windows:
+  #   runs-on: windows-2019
+  #   steps:
+  #     - name: Check out the repo
+  #       uses: actions/checkout@v4
 
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: "18" # Specify a Node.js version
+  #     - name: Use Node.js
+  #       uses: actions/setup-node@v4
+  #       with:
+  #         node-version: "20" # Specify a Node.js version
 
-      - name: Install dependencies
-        run: npm install
+  #     - name: Install dependencies
+  #       run: npm install
 
-      - name: Build
-        run: npm run build
+  #     - name: Build
+  #       run: npm run build
 
-      - name: Run Unit Tests
-        run: |
-          npm run test
+  #     - name: Run Unit Tests
+  #       run: |
+  #         npm run test
 
   local_integration:
     runs-on: ubuntu-latest
@@ -56,7 +56,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "18" # Specify a Node.js version
+          node-version: "20" # Specify a Node.js version
 
       - name: Install dependencies
         run: npm install
@@ -71,7 +71,7 @@ jobs:
 
       - name: Set up Docker Compose
         run: |
-          docker-compose -f docker/docker-compose.yml -f docker/docker-compose-modeler.yaml up -d
+          docker-compose -f docker/docker-compose.yaml -f docker/docker-compose-modeler.yaml up -d
 
       - name: Run Integration Tests
         run: |
@@ -89,7 +89,7 @@ jobs:
 
       - name: Cleanup
         if: always()
-        run: docker-compose -f docker/docker-compose.yml -f docker/docker-compose-modeler.yaml down
+        run: docker-compose -f docker/docker-compose.yaml -f docker/docker-compose-modeler.yaml down
 
   local_multitenancy_integration:
     runs-on: ubuntu-latest
@@ -102,7 +102,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "18" # Specify a Node.js version
+          node-version: "20" # Specify a Node.js version
 
       - name: Install dependencies
         run: npm install
@@ -117,7 +117,7 @@ jobs:
 
       - name: Set up Docker Compose
         run: |
-          docker-compose -f docker/docker-compose-multitenancy.yml -f docker/docker-compose-modeler.yaml up -d
+          docker-compose -f docker/docker-compose-multitenancy.yaml -f docker/docker-compose-modeler.yaml up -d
 
       - name: Run Integration Tests
         run: |
@@ -137,7 +137,7 @@ jobs:
 
       - name: Cleanup
         if: always()
-        run: docker-compose -f docker/docker-compose-multitenancy.yml -f docker/docker-compose-modeler.yaml down
+        run: docker-compose -f docker/docker-compose-multitenancy.yaml -f docker/docker-compose-modeler.yaml down
 
   saas_integration:
     runs-on: ubuntu-latest
@@ -149,7 +149,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "18" # Specify a Node.js version
+          node-version: "20" # Specify a Node.js version
 
       - name: Install dependencies
         run: npm install
@@ -159,6 +159,8 @@ jobs:
           npm run test:integration
         env:
           ZEEBE_ADDRESS: ${{ secrets.ZEEBE_ADDRESS }}
+          ZEEBE_REST_ADDRESS: ${{ secrets.ZEEBE_REST_ADDRESS }}
+          ZEEBE_GRPC_ADDRESS: ${{ secrets.ZEEBE_GRPC_ADDRESS }}
           ZEEBE_CLIENT_ID: ${{ secrets.ZEEBE_CLIENT_ID }}
           ZEEBE_AUTHORIZATION_SERVER_URL: ${{ secrets.ZEEBE_AUTHORIZATION_SERVER_URL }}
           ZEEBE_CLIENT_SECRET: ${{ secrets.ZEEBE_CLIENT_SECRET }}
@@ -174,38 +176,40 @@ jobs:
           CAMUNDA_CONSOLE_BASE_URL: ${{ secrets.CAMUNDA_CONSOLE_BASE_URL }}
           CAMUNDA_CONSOLE_OAUTH_AUDIENCE: ${{ secrets.CAMUNDA_CONSOLE_OAUTH_AUDIENCE}}
 
-  saas_integration_windows:
-    needs: saas_integration
-    runs-on: windows-latest
-    environment: integration
-    steps:
-      - name: Check out the repo
-        uses: actions/checkout@v4
-
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: "18" # Specify a Node.js version
-
-      - name: Install dependencies
-        run: npm install
-
-      - name: Run Integration Tests
-        run: |
-          npm run test:integration
-        env:
-          ZEEBE_ADDRESS: ${{ secrets.ZEEBE_ADDRESS }}
-          ZEEBE_CLIENT_ID: ${{ secrets.ZEEBE_CLIENT_ID }}
-          ZEEBE_AUTHORIZATION_SERVER_URL: ${{ secrets.ZEEBE_AUTHORIZATION_SERVER_URL }}
-          ZEEBE_CLIENT_SECRET: ${{ secrets.ZEEBE_CLIENT_SECRET }}
-          ZEEBE_TOKEN_AUDIENCE: ${{ secrets.ZEEBE_TOKEN_AUDIENCE }}
-          CAMUNDA_CREDENTIALS_SCOPES: ${{ secrets.CAMUNDA_CREDENTIALS_SCOPES }}
-          CAMUNDA_OAUTH_URL: ${{ secrets.CAMUNDA_OAUTH_URL }}
-          CAMUNDA_TASKLIST_BASE_URL: ${{ secrets.CAMUNDA_TASKLIST_BASE_URL }}
-          CAMUNDA_OPERATE_BASE_URL: ${{ secrets.CAMUNDA_OPERATE_BASE_URL }}
-          CAMUNDA_OPTIMIZE_BASE_URL: ${{ secrets.CAMUNDA_OPTIMIZE_BASE_URL }}
-          CAMUNDA_MODELER_BASE_URL: https://modeler.cloud.camunda.io/api
-          CAMUNDA_CONSOLE_CLIENT_ID: ${{ secrets.CAMUNDA_CONSOLE_CLIENT_ID }}
-          CAMUNDA_CONSOLE_CLIENT_SECRET: ${{ secrets.CAMUNDA_CONSOLE_CLIENT_SECRET }}
-          CAMUNDA_CONSOLE_BASE_URL: ${{ secrets.CAMUNDA_CONSOLE_BASE_URL }}
-          CAMUNDA_CONSOLE_OAUTH_AUDIENCE: ${{ secrets.CAMUNDA_CONSOLE_OAUTH_AUDIENCE}}
+  # saas_integration_windows:
+  # needs: saas_integration
+  # runs-on: windows-2019
+  # environment: integration
+  # steps:
+  #   - name: Check out the repo
+  #     uses: actions/checkout@v4
+
+  #   - name: Use Node.js
+  #     uses: actions/setup-node@v4
+  #     with:
+  #       node-version: "20" # Specify a Node.js version
+
+  #   - name: Install dependencies
+  #     run: npm install
+
+  #   - name: Run Integration Tests
+  #     run: |
+  #       npm run test:integration
+  #     env:
+  #       ZEEBE_ADDRESS: ${{ secrets.ZEEBE_ADDRESS }}
+  #       ZEEBE_REST_ADDRESS: ${{ secrets.ZEEBE_REST_ADDRESS }}
+  #       ZEEBE_GRPC_ADDRESS: ${{ secrets.ZEEBE_GRPC_ADDRESS }}
+  #       ZEEBE_CLIENT_ID: ${{ secrets.ZEEBE_CLIENT_ID }}
+  #       ZEEBE_AUTHORIZATION_SERVER_URL: ${{ secrets.ZEEBE_AUTHORIZATION_SERVER_URL }}
+  #       ZEEBE_CLIENT_SECRET: ${{ secrets.ZEEBE_CLIENT_SECRET }}
+  #       ZEEBE_TOKEN_AUDIENCE: ${{ secrets.ZEEBE_TOKEN_AUDIENCE }}
+  #       CAMUNDA_CREDENTIALS_SCOPES: ${{ secrets.CAMUNDA_CREDENTIALS_SCOPES }}
+  #       CAMUNDA_OAUTH_URL: ${{ secrets.CAMUNDA_OAUTH_URL }}
+  #       CAMUNDA_TASKLIST_BASE_URL: ${{ secrets.CAMUNDA_TASKLIST_BASE_URL }}
+  #       CAMUNDA_OPERATE_BASE_URL: ${{ secrets.CAMUNDA_OPERATE_BASE_URL }}
+  #       CAMUNDA_OPTIMIZE_BASE_URL: ${{ secrets.CAMUNDA_OPTIMIZE_BASE_URL }}
+  #       CAMUNDA_MODELER_BASE_URL: https://modeler.cloud.camunda.io/api
+  #       CAMUNDA_CONSOLE_CLIENT_ID: ${{ secrets.CAMUNDA_CONSOLE_CLIENT_ID }}
+  #       CAMUNDA_CONSOLE_CLIENT_SECRET: ${{ secrets.CAMUNDA_CONSOLE_CLIENT_SECRET }}
+  #       CAMUNDA_CONSOLE_BASE_URL: ${{ secrets.CAMUNDA_CONSOLE_BASE_URL }}
+  #       CAMUNDA_CONSOLE_OAUTH_AUDIENCE: ${{ secrets.CAMUNDA_CONSOLE_OAUTH_AUDIENCE}}

.github/workflows/publish.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "18" # Specify a Node.js version
+          node-version: "20" # Specify a Node.js version
 
       - name: Install dependencies
         run: npm i
@@ -39,7 +39,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "18" # Specify a Node.js version
+          node-version: "20" # Specify a Node.js version
 
       - name: Install dependencies
         run: npm install
@@ -54,7 +54,7 @@ jobs:
 
       - name: Set up Docker Compose
         run: |
-          docker-compose -f docker/docker-compose.yml -f docker/docker-compose-modeler.yaml up -d
+          docker-compose -f docker/docker-compose.yaml -f docker/docker-compose-modeler.yaml up -d
 
       - name: Run Integration Tests
         run: |
@@ -72,7 +72,7 @@ jobs:
 
       - name: Cleanup
         if: always()
-        run: docker-compose -f docker/docker-compose.yml -f docker/docker-compose-modeler.yaml down
+        run: docker-compose -f docker/docker-compose.yaml -f docker/docker-compose-modeler.yaml down
 
   local_multitenancy_integration:
     runs-on: ubuntu-latest
@@ -85,7 +85,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "18" # Specify a Node.js version
+          node-version: "20" # Specify a Node.js version
 
       - name: Install dependencies
         run: npm install
@@ -100,7 +100,7 @@ jobs:
 
       - name: Set up Docker Compose
         run: |
-          docker-compose -f docker/docker-compose-multitenancy.yml -f docker/docker-compose-modeler.yaml up -d
+          docker-compose -f docker/docker-compose-multitenancy.yaml -f docker/docker-compose-modeler.yaml up -d
 
       - name: Run Integration Tests
         run: |
@@ -120,7 +120,7 @@ jobs:
 
       - name: Cleanup
         if: always()
-        run: docker-compose -f docker/docker-compose-multitenancy.yml -f docker/docker-compose-modeler.yaml down
+        run: docker-compose -f docker/docker-compose-multitenancy.yaml -f docker/docker-compose-modeler.yaml down
 
   saas_integration:
     runs-on: ubuntu-latest
@@ -132,7 +132,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "18" # Specify a Node.js version
+          node-version: "20" # Specify a Node.js version
 
       - name: Install dependencies
         run: npm install
@@ -142,6 +142,8 @@ jobs:
           npm run test:integration
         env:
           ZEEBE_ADDRESS: ${{ secrets.ZEEBE_ADDRESS }}
+          ZEEBE_REST_ADDRESS: ${{ secrets.ZEEBE_REST_ADDRESS }}
+          ZEEBE_GRPC_ADDRESS: ${{ secrets.ZEEBE_GRPC_ADDRESS }}
           ZEEBE_CLIENT_ID: ${{ secrets.ZEEBE_CLIENT_ID }}
           ZEEBE_AUTHORIZATION_SERVER_URL: ${{ secrets.ZEEBE_AUTHORIZATION_SERVER_URL }}
           ZEEBE_CLIENT_SECRET: ${{ secrets.ZEEBE_CLIENT_SECRET }}
@@ -157,46 +159,47 @@ jobs:
           CAMUNDA_CONSOLE_BASE_URL: ${{ secrets.CAMUNDA_CONSOLE_BASE_URL }}
           CAMUNDA_CONSOLE_OAUTH_AUDIENCE: ${{ secrets.CAMUNDA_CONSOLE_OAUTH_AUDIENCE}}
 
-  saas_integration_windows:
-    needs: saas_integration
-    runs-on: windows-latest
-    environment: integration
-    steps:
-      - name: Check out the repo
-        uses: actions/checkout@v4
-
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: "18" # Specify a Node.js version
-
-      - name: Install dependencies
-        run: npm install
-
-      - name: Run Integration Tests
-        run: |
-          npm run test:integration
-        env:
-          ZEEBE_ADDRESS: ${{ secrets.ZEEBE_ADDRESS }}
-          ZEEBE_CLIENT_ID: ${{ secrets.ZEEBE_CLIENT_ID }}
-          ZEEBE_AUTHORIZATION_SERVER_URL: ${{ secrets.ZEEBE_AUTHORIZATION_SERVER_URL }}
-          ZEEBE_CLIENT_SECRET: ${{ secrets.ZEEBE_CLIENT_SECRET }}
-          ZEEBE_TOKEN_AUDIENCE: ${{ secrets.ZEEBE_TOKEN_AUDIENCE }}
-          CAMUNDA_CREDENTIALS_SCOPES: ${{ secrets.CAMUNDA_CREDENTIALS_SCOPES }}
-          CAMUNDA_OAUTH_URL: ${{ secrets.CAMUNDA_OAUTH_URL }}
-          CAMUNDA_TASKLIST_BASE_URL: ${{ secrets.CAMUNDA_TASKLIST_BASE_URL }}
-          CAMUNDA_OPERATE_BASE_URL: ${{ secrets.CAMUNDA_OPERATE_BASE_URL }}
-          CAMUNDA_OPTIMIZE_BASE_URL: ${{ secrets.CAMUNDA_OPTIMIZE_BASE_URL }}
-          CAMUNDA_MODELER_BASE_URL: https://modeler.cloud.camunda.io/api
-          CAMUNDA_CONSOLE_CLIENT_ID: ${{ secrets.CAMUNDA_CONSOLE_CLIENT_ID }}
-          CAMUNDA_CONSOLE_CLIENT_SECRET: ${{ secrets.CAMUNDA_CONSOLE_CLIENT_SECRET }}
-          CAMUNDA_CONSOLE_BASE_URL: ${{ secrets.CAMUNDA_CONSOLE_BASE_URL }}
-          CAMUNDA_CONSOLE_OAUTH_AUDIENCE: ${{ secrets.CAMUNDA_CONSOLE_OAUTH_AUDIENCE}}
+  # saas_integration_windows:
+  #   needs: saas_integration
+  #   runs-on: windows-2019
+  #   environment: integration
+  #   steps:
+  #     - name: Check out the repo
+  #       uses: actions/checkout@v4
+
+  #     - name: Use Node.js
+  #       uses: actions/setup-node@v4
+  #       with:
+  #         node-version: "20" # Specify a Node.js version
+
+  #     - name: Install dependencies
+  #       run: npm install
+
+  #     - name: Run Integration Tests
+  #       run: |
+  #         npm run test:integration
+  #       env:
+  #         ZEEBE_ADDRESS: ${{ secrets.ZEEBE_ADDRESS }}
+  #         ZEEBE_CLIENT_ID: ${{ secrets.ZEEBE_CLIENT_ID }}
+  #         ZEEBE_REST_ADDRESS: ${{ secrets.ZEEBE_REST_ADDRESS }}
+  #         ZEEBE_GRPC_ADDRESS: ${{ secrets.ZEEBE_GRPC_ADDRESS }}
+  #         ZEEBE_AUTHORIZATION_SERVER_URL: ${{ secrets.ZEEBE_AUTHORIZATION_SERVER_URL }}
+  #         ZEEBE_CLIENT_SECRET: ${{ secrets.ZEEBE_CLIENT_SECRET }}
+  #         ZEEBE_TOKEN_AUDIENCE: ${{ secrets.ZEEBE_TOKEN_AUDIENCE }}
+  #         CAMUNDA_CREDENTIALS_SCOPES: ${{ secrets.CAMUNDA_CREDENTIALS_SCOPES }}
+  #         CAMUNDA_OAUTH_URL: ${{ secrets.CAMUNDA_OAUTH_URL }}
+  #         CAMUNDA_TASKLIST_BASE_URL: ${{ secrets.CAMUNDA_TASKLIST_BASE_URL }}
+  #         CAMUNDA_OPERATE_BASE_URL: ${{ secrets.CAMUNDA_OPERATE_BASE_URL }}
+  #         CAMUNDA_OPTIMIZE_BASE_URL: ${{ secrets.CAMUNDA_OPTIMIZE_BASE_URL }}
+  #         CAMUNDA_MODELER_BASE_URL: https://modeler.cloud.camunda.io/api
+  #         CAMUNDA_CONSOLE_CLIENT_ID: ${{ secrets.CAMUNDA_CONSOLE_CLIENT_ID }}
+  #         CAMUNDA_CONSOLE_CLIENT_SECRET: ${{ secrets.CAMUNDA_CONSOLE_CLIENT_SECRET }}
+  #         CAMUNDA_CONSOLE_BASE_URL: ${{ secrets.CAMUNDA_CONSOLE_BASE_URL }}
+  #         CAMUNDA_CONSOLE_OAUTH_AUDIENCE: ${{ secrets.CAMUNDA_CONSOLE_OAUTH_AUDIENCE}}
   tag-and-publish:
-    needs:
-      [
+    needs: [
         saas_integration,
-        saas_integration_windows,
+        # saas_integration_windows,
         local_multitenancy_integration,
         local_integration,
         unit-tests,
@@ -212,7 +215,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
-          node-version: "18"
+          node-version: "20"
           cache: "npm"
       - name: Install
         run: npm i