OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.
import { z } from 'zod';
// Keys must match the template `category` in @openpanel/email. Each entry's
// label + description drive the account email-preferences toggles.
export const emailCategories = {
onboarding: {
label: 'Onboarding',
description: 'Get started tips and guidance emails',
},
weekly_digest: {
label: 'Weekly digest',
description: 'A weekly summary of your analytics with AI-surfaced insights',
},
product_alerts: {
label: 'Product alerts',
description:
'Important notices about your projects: tracking stopped sending data, event limits, and alerts from your notification rules',
},
// Kept separate from `onboarding` on purpose: opting out of getting-started
// tips must not also opt you out of being told your account is winding down.
// The final deletion warning has no category at all, so it always sends.
account_lifecycle: {
label: 'Account status',
description:
'Notices about your trial ending, event ingestion being paused, and data scheduled for removal',
},
} as const;
export type EmailCategory = keyof typeof emailCategories;
/**
* The account email-preference toggles.
*
* `partialRecord`, not `record`: an enum-keyed `record` is EXHAUSTIVE in zod 4,
* and the form sends only the toggles that changed. Keying off `emailCategories`
* is what stops an unknown category reaching `emailUnsubscribe`, where nothing
* would ever read it again.
*/
export const zUpdateEmailPreferences = z.object({
categories: z.partialRecord(
z.enum(Object.keys(emailCategories) as [EmailCategory, ...EmailCategory[]]),
z.boolean()
),
});
export type IUpdateEmailPreferences = z.infer<typeof zUpdateEmailPreferences>;