🚀 Feature: Customized Preference System exposed to bridge

🔖 Feature description

With the new version v2 and the introduced bridge processing, novu could also introduce a custom preference system, where devs can define schemas for the preferences like the existing control/payload schema, which are then exposed to the customer and to the workflows as well.

🎤 Why is this feature needed ?

Several different requests like customized digest for workflows are already requested and I think with this system, the chance to support more of them out of the box is even higher. When used with topics (#6789) the dev can define relations between topics and workflows much more specific

Use Cases I could think of:

Customized digest
Customized E-Mail behavior, f.ex. setting if email should include personal data or should be anonymized

✌️ How do you aim to achieve this?

Define Preference Schema at workflows / maybe also on topics (#6789)
pass them as variables to the workflow

🔄️ Additional Information

Example:

workflow("xxx", async ({ step, subscriber, preferences, topic }) => {
  const { name: topicName, control: topicControl, preferences: topicPreferences } = topic ?? {};;
  await step.digest("custom-digest", () => ({ unit: (topicPreferences?.interval ?? preferences.interval) === 'daily' ? 'day' : 'week', amount: 1 })
}, {
   preferenceSchema: z.object({
      interval: z.enum(["daily", "weekly"]).default("daily"),
   })
})

👀 Have you spent some time to check if this feature request has been raised before?

[X] I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

[X] I have read the Contributing Guidelines

Are you willing to submit PR?

Yes I am willing to submit a PR!

novuhq / novu