Fully Supported NodeJS SDK

[engineering-issue-sync-app]

Value Proposition Statement

NodeJS SDK is fully supported and available in the Camunda org.

User Problem

The NodeJS SDK sits in the Camunda Community Hub as a community-supported project, with no defined support criteria. It's maintained by a single developer (@jwulf).

Some developers shy away from community-supported projects for a variety of reasons including perceived lack of support, perceived security issues, and more.

User Stories

As a developer, I prefer using a fully-supported SDK, so that when I run into issues I can create a support ticket or file an official bug with an SLA based on my support contract.

Implementation Notes

See https://docs.google.com/document/d/1o2JuP7F28xqHsHEoxfGEvc-ml46LAYwYSG-G-oxdLbU/edit?usp=sharing.

Validation Criteria

NodeJS SDK is available in https://github.com/camunda and users can submit support tickets (or GitHub issues!) for assistance.

It is important to define the meaning of "Fully Supported" here.

The goal is to complete API feature implementation, but it is not guaranteed to release at the same time as the API. API feature implementation prioritisation will be driven by customer demand.

Security fix release policy: CVEs result in a security fix package release.

Breakdown

This section links to various sub-issues / -tasks contributing to respective epic phase or phase results where appropriate.

Discovery phase

Define phase

The Node.js SDK for Camunda 8 consists of the following components:

• Web Console
• Optimize API Client
• Operate API Client
• Tasklist API Client
• Zeebe API Client
• Web Modeler API Client

It uses the following libraries to hydrate credentials from the environment:

• Camunda 8 Credentials from Environment
• Camunda SaaS OAuth
  No design required.

Documentation Planning

• Add link in APIs & Tools section
  • Add new overview page for working with the SDK

Risk Management
No risk assessment needed.

Implement phase

Tasks

Beta Give feedback

1. https://github.com/camunda/developer-experience/issues/176
2. https://github.com/camunda/developer-experience/issues/175
3. https://github.com/camunda/developer-experience/issues/186
4. Test Tasklist REST client camunda-community-hub/tasklist-client-node-js#14
   good first issue +1
   
5. https://github.com/camunda-community-hub/modeler-client-node-js/issues/2
6. Enable Optimize client with Self-Managed Instances camunda-community-hub/optimize-client-node-js#4
   +0
   
7. Enable Operate API client with Self-Managed instances camunda-community-hub/operate-client-node-js#7
   +0
   
8. Enable Tasklist API client with Self-Managed instances camunda-community-hub/tasklist-client-node-js#15
   +0
   
9. Run all dependency tests before publish allowed camunda-community-hub/camunda-8-sdk-node-js#10
   +0
10. Multi-tenancy for BroadcastSignal camunda-community-hub/zeebe-client-node-js#344
    api-functional-sdk-not enhancement +2
    
11. Add support for MigrateProcessInstance camunda-community-hub/zeebe-client-node-js#346
    api-functional-sdk-not enhancement +2
    
12. Add Support for StreamJobs RPC camunda-community-hub/zeebe-client-node-js#333
    api-functional-sdk-not enhancement +2
    
13. DeleteResource API support camunda-community-hub/zeebe-client-node-js#339
    api-functional-sdk-not enhancement +2
    
14. Create Issue template camunda-community-hub/camunda-8-sdk-node-js#11
    +0
    
15. https://github.com/camunda/developer-experience/issues/187
16. https://github.com/camunda/developer-experience/issues/189
17. https://github.com/camunda/developer-experience/issues/190

Validate phase

Links to additional collateral

^{🤖 This issue is automatically synced from: source}