Skip to content

ADR 0002 - TypeScript guidelines and rules

  • Status: Accepted
  • Date: 2023-05-20

Decisions

You will have a lot of freedom regarding things like where the orchestrator gets its customer info, if any at all. A pragmatic vision for the type system is needed as we want to keep the source code as type safe as possible.

We decided to allow some types that are Orchestrator-specific in the library. To make it possible to extend and change the reusable components, we want to define some rules to make the components in the library flexible enough to adapt to common business scenarios.

Action items

  • We will have some basic type definitions in the library: Subscriptions, Subscription, Processes, Process
  • We will not use the generated GraphQL types directly in the components; instead we map them to and from generated types
  • We assume that most users will only want to add columns/fields in Subscriptions, Subscription, Processes, Process
  • We assume that certain fields are not changeable, for example fields that are used by workflow engine-related objects, like workflow status and subscription status
  • When components can be extended, GenericFields will be used to extend Base types. Components should implement functionality to render extra attributes/fields.

Attendees

  • René Dohmen
  • Ricardo van der Heijden