feat(framework): Add InferWorkflowId and InferWorkflowPayload inference utility types
#6812
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
❌ Deploy Preview for novu-stg-vite-dashboard-poc failed. Why did it fail? →
|
commit: |
rifont
requested review from
djabarovgeorge and
SokratisVidros
and removed request for
djabarovgeorge
SokratisVidros
requested changes
Nov 11, 2024
|
|
||
| export type InferWorkflowId<T_Workflow extends Workflow> = T_Workflow extends Workflow<infer Id, never> ? Id : never; | ||
|
|
||
| export type InferWorkflowPayload< |
There was a problem hiding this comment.
This is a lovely DX improvement, but I feel we need to add the BulkEventParams and typedBulkTrigger utilities to the framework to maximize its DX benefits.
The instructions we give Novu users feel more convoluted than hardcoding a workflowId in a constant and reusing it in their code.
Alternatively, how about adding a triggerBulk function on the workflow object?
There was a problem hiding this comment.
I would suggest we close this PR for the time being until the isomorphic @novu/api package is available and ready for close integration with @novu/framework. Then, everything can be bundled together in a much simpler way for user-land consumption.
2 tasks
|
Closing for now, see #6812 (comment) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changed? Why was the change needed?
workflowIda generic type onDiscoverWorkflowOutputand theworkflowresource to allow the identifier to be inferredInferWorkflowIdandInferWorkflowPayloadinference utilsRelated Docs PR: novuhq/docs#726
Screenshots
See the Stackblitz example for live type-safety
https://stackblitz.com/edit/novu-type-safe-bulk-trigger?file=api%2Fnovu%2Froute.tsx&view=editor
Expand for optional sections
Related enterprise PR
Special notes for your reviewer