fix(api-service): move workflow dto from shared to api

[tatarco]

Resolve Workflow DTO Issues

What changed? Why was the change needed?

DTO Migration and Enhancements

• All DTOs were moved from shared into API, converted to classes, and assigned the correct OpenAPI decorators.
• All of the workflow V2 DTOs are now generated under the @novu-api. All of our E2E tests are now using the SDK and dogfooding the OpenAPI structure.
• Error DTOs have been enhanced due to issues found in implementation.
• Class validators are now working on DTOs, enforcing bad data from getting into the service.
• The filter has been updated to parse those errors elegantly as well.
• Decoupled the interfaces created in shared from entities; they should not be used anymore. We generate DTOs now, and the client should not care about our database entity; all is clearly presented to him.
• JSON schema was a complete mess; aligned it all the way to the DAL layer. Some as unknown had to be added in the framework to minimize scope.
• The preference controller has been deprecated along with all its DTOs since naming was a big confusion and duplication. Deprecated them all in order to know what is new and what is old.
• Separated DTOs into separate properly named files.

Screenshots

Expand for optional sections

Related enterprise PR

Special notes for your reviewer

[linear]

NV-5295 Align Workflow Controller to SDK

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/novuhq/novu@8009

npm i https://pkg.pr.new/novuhq/novu/@novu/providers@8009

npm i https://pkg.pr.new/novuhq/novu/@novu/shared@8009

commit: 751bd06

[netlify]

✅ Deploy Preview for dashboard-v2-novu-staging canceled.

Name	Link
🔨 Latest commit	751bd06
🔍 Latest deploy log	https://app.netlify.com/sites/dashboard-v2-novu-staging/deploys/6808b18fdab3180008001f8a

[SokratisVidros]

This is an initial high level review. We are in the right direction and I am noting down the next actions in order to wrap this effort up:

1. We need to do another pass around the Preference and Workflow V2 DTOs. There still a lot of duplication between these DTOs for request and responses.
2. We need to solve the dual export issue for the internal SDK generated by speakeasy.

[SokratisVidros]

Do we really need to extend the Speakeasy client at this point? Doesn't it allow us to override its headers on the spot?

[tatarco]

it allows us to do it only at the calls signature, I want to have it injected in all calls done with the instance, hence the requirement for this change.

[SokratisVidros]

Template is the internal modelling of workflows. Some preference DTOs use the term workflow, others the term template. We should stick to workflow.

[tatarco]

I really don't want to make any additional changes besides whats a must in this huge PR, the purpose here is to document the existing state, lets move this to a seperate task