The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.
TypeScript clickhousemysqlnextjsopen-sourceplanetscaleprismatailwindcsstinybirdtypescriptupstashvercel
Support adding reward change description
Steven Teyb0e693e9e514
diff --git a/apps/web/lib/actions/partners/create-reward.ts b/apps/web/lib/actions/partners/create-reward.tsindex 2a3fb31173..f797f6e4c5 100644--- a/apps/web/lib/actions/partners/create-reward.ts+++ b/apps/web/lib/actions/partners/create-reward.ts@@ -37,6 +37,7 @@ export const createRewardAction = authActionClientgroupId,spendLimitAmount,spendLimitInterval,+ changeDescription,} = parsedInput;throwIfNoPermission({@@ -132,6 +133,7 @@ export const createRewardAction = authActionClientdescription: formatRewardDescription(serializeReward(reward), {includeEarnPrefix: false,}),+ changeDescription,},});@@ -161,6 +163,7 @@ export const createRewardAction = authActionClientparentResourceId: groupId,old: null,new: reward,+ description: changeDescription,}),]),);diff --git a/apps/web/lib/actions/partners/delete-reward.ts b/apps/web/lib/actions/partners/delete-reward.tsindex 60e6c9fed4..511bd4c85b 100644--- a/apps/web/lib/actions/partners/delete-reward.ts+++ b/apps/web/lib/actions/partners/delete-reward.ts@@ -7,23 +7,28 @@ import { serializeReward } from "@/lib/api/partners/serialize-reward";import { getDefaultProgramIdOrThrow } from "@/lib/api/programs/get-default-program-id-or-throw";import { queueRewardProcessing } from "@/lib/api/rewards/queue-reward-processing";import { prisma } from "@/lib/prisma";-import { REWARD_EVENT_COLUMN_MAPPING } from "@/lib/zod/schemas/rewards";+import {+ REWARD_EVENT_COLUMN_MAPPING,+ rewardChangeDescriptionSchema,+} from "@/lib/zod/schemas/rewards";import { formatRewardDescription } from "@/ui/partners/format-reward-description";import { waitUntil } from "@vercel/functions";import * as z from "zod/v4";import { authActionClient } from "../safe-action";import { throwIfNoPermission } from "../throw-if-no-permission";-const deleteRewardSchema = z.object({- workspaceId: z.string(),- rewardId: z.string(),-});+const deleteRewardSchema = z+ .object({+ workspaceId: z.string(),+ rewardId: z.string(),+ })+ .extend(rewardChangeDescriptionSchema.shape);export const deleteRewardAction = authActionClient.inputSchema(deleteRewardSchema).action(async ({ parsedInput, ctx }) => {const { workspace, user } = ctx;- const { rewardId } = parsedInput;+ const { rewardId, changeDescription } = parsedInput;throwIfNoPermission({role: workspace.role,@@ -78,6 +83,7 @@ export const deleteRewardAction = authActionClientdescription: formatRewardDescription(serializeReward(deletedReward), {includeEarnPrefix: false,}),+ changeDescription,},});@@ -107,6 +113,7 @@ export const deleteRewardAction = authActionClientparentResourceId: partnerGroup.id,old: reward,new: null,+ description: changeDescription,}),]),);diff --git a/apps/web/lib/actions/partners/update-reward.ts b/apps/web/lib/actions/partners/update-reward.tsindex 65ca0c84c9..09f64184f5 100644--- a/apps/web/lib/actions/partners/update-reward.ts+++ b/apps/web/lib/actions/partners/update-reward.ts@@ -33,6 +33,7 @@ export const updateRewardAction = authActionClientrewardId,spendLimitAmount,spendLimitInterval,+ changeDescription,} = parsedInput;throwIfNoPermission({@@ -145,6 +146,7 @@ export const updateRewardAction = authActionClientdescription: formatRewardDescription(serializeReward(updatedReward), {includeEarnPrefix: false,}),+ changeDescription,},});@@ -174,6 +176,7 @@ export const updateRewardAction = authActionClientparentResourceId: partnerGroup.id,old: reward,new: updatedReward,+ description: changeDescription,}),// we only cache default group pages for now so we need to invalidate themdiff --git a/apps/web/lib/api/activity-log/track-reward-activity-log.ts b/apps/web/lib/api/activity-log/track-reward-activity-log.tsindex 4945dca914..3d0b6f34e1 100644--- a/apps/web/lib/api/activity-log/track-reward-activity-log.ts+++ b/apps/web/lib/api/activity-log/track-reward-activity-log.ts@@ -128,8 +128,10 @@ function buildModifierChangeSetEntries(export function trackRewardActivityLog({old: oldReward,new: newReward,+ description,...baseInput}: TrackRewardActivityLogParams) {+ const activityDescription = description?.trim() || null;const reward = oldReward || newReward;const resourceType = reward? REWARD_EVENT_TO_RESOURCE_TYPE[reward.event]@@ -149,6 +151,7 @@ export function trackRewardActivityLog({...baseInput,resourceType,action: "reward.created",+ description: activityDescription,changeSet: {reward: {old: null,@@ -158,8 +161,10 @@ export function trackRewardActivityLog({});}- const activityLogs: Pick<TrackActivityLogInput, "action" | "changeSet">[] =- [];+ const activityLogs: Pick<+ TrackActivityLogInput,+ "action" | "changeSet" | "description"+ >[] = [];if (oldReward !== null && newReward !== null) {const oldSnapshot = toRewardActivitySnapshot(@@ -219,6 +224,20 @@ export function trackRewardActivityLog({});}+ if (activityDescription && activityLogs.length > 0) {+ const primaryLogIndex = activityLogs.findIndex((log) =>+ ["reward.created", "reward.updated", "reward.deleted"].includes(+ log.action,+ ),+ );+ const targetIndex = primaryLogIndex >= 0 ? primaryLogIndex : 0;++ activityLogs[targetIndex] = {+ ...activityLogs[targetIndex],+ description: activityDescription,+ };+ }+const batchId = activityLogs.length > 0 ? crypto.randomUUID() : undefined;const finalActivityLogs: TrackActivityLogInput[] = activityLogs.map(diff --git a/apps/web/lib/api/partners/notify-partner-reward-change.ts b/apps/web/lib/api/partners/notify-partner-reward-change.tsindex 7e276962d8..57bf23b11c 100644--- a/apps/web/lib/api/partners/notify-partner-reward-change.ts+++ b/apps/web/lib/api/partners/notify-partner-reward-change.ts@@ -15,7 +15,7 @@ interface NotifyPartnerRewardChangeParams {action: RewardJob["event"];program: Pick<Program, "id" | "name" | "logo" | "slug" | "supportEmail">;reward: Pick<Reward, "id" | "event">;- rewardSnapshot: { description: string };+ rewardSnapshot: { description: string; changeDescription?: string };effectiveAt: Date | string;users: Pick<User, "name" | "email">[];idempotencyKey: string;@@ -59,6 +59,7 @@ export async function notifyPartnerRewardChange({rewardSnapshot: {description: rewardSnapshot.description,icon: REWARD_ICONS[reward.event],+ changeDescription: rewardSnapshot.changeDescription,},effectiveAt,action,diff --git a/apps/web/lib/api/rewards/queue-reward-processing.ts b/apps/web/lib/api/rewards/queue-reward-processing.tsindex f6d3bb1aae..15495d19ab 100644--- a/apps/web/lib/api/rewards/queue-reward-processing.ts+++ b/apps/web/lib/api/rewards/queue-reward-processing.ts@@ -26,6 +26,7 @@ export const rewardJobSchema = z.object({id: z.string(),event: z.enum(EventType),description: z.string(),+ changeDescription: z.string().optional(),}),});diff --git a/apps/web/lib/zod/schemas/rewards.ts b/apps/web/lib/zod/schemas/rewards.tsindex 75207b3b9c..94859b0bac 100644--- a/apps/web/lib/zod/schemas/rewards.ts+++ b/apps/web/lib/zod/schemas/rewards.ts@@ -432,6 +432,18 @@ export const RewardSchema = z.object({export const REWARD_DESCRIPTION_MAX_LENGTH = 100;export const REWARD_TOOLTIP_DESCRIPTION_MAX_LENGTH = 2000;+export const REWARD_CHANGE_DESCRIPTION_MAX_LENGTH = 240;++export const rewardChangeDescriptionSchema = z.object({+ changeDescription: z+ .string()+ .max(REWARD_CHANGE_DESCRIPTION_MAX_LENGTH)+ .optional()+ .transform((value) => {+ const trimmed = value?.trim();+ return trimmed ? trimmed : undefined;+ }),+});export const referralRewardConfigSchema = z.object({@@ -469,14 +481,14 @@ export const createOrUpdateRewardSchema = z.object({...rewardSpendLimitSchema.shape,});-export const createRewardSchema = createOrUpdateRewardSchema.superRefine(- (data) => {+export const createRewardSchema = createOrUpdateRewardSchema+ .extend(rewardChangeDescriptionSchema.shape)+ .superRefine((data) => {if (data.event === EventType.click || data.event === EventType.lead) {data.maxDuration = 0;data.type = "flat";}- },-);+ });export const updateRewardSchema = createOrUpdateRewardSchema.omit({@@ -485,6 +497,7 @@ export const updateRewardSchema = createOrUpdateRewardSchema}).extend({rewardId: z.string(),+ ...rewardChangeDescriptionSchema.shape,});export const rewardPartnersQuerySchema = zdiff --git a/apps/web/ui/activity-logs/action-renderers/reward-activity-renderer.tsx b/apps/web/ui/activity-logs/action-renderers/reward-activity-renderer.tsxindex 6276a55b0f..537b7b5172 100644--- a/apps/web/ui/activity-logs/action-renderers/reward-activity-renderer.tsx+++ b/apps/web/ui/activity-logs/action-renderers/reward-activity-renderer.tsx@@ -105,19 +105,30 @@ export function RewardActivityRenderer({ log }: RewardActivityRendererProps) {</TimestampTooltip></div>- <div className="rounded-lg border border-neutral-200 bg-white px-3 py-2.5 text-xs font-medium leading-4 text-neutral-800">- {config.displayModifiers ? (- <ProgramRewardModifiersTooltipContent- reward={reward}- showBaseReward={false}- showBottomGradient={false}- className="p-0"- />- ) : (- <ProgramRewardDescription- reward={reward}- showModifiersTooltip={false}- />+ <div className="border-border-subtle bg-bg-default rounded-xl border shadow-sm">+ <div className="text-content-default px-3 py-2.5 text-xs font-medium leading-4">+ {config.displayModifiers ? (+ <ProgramRewardModifiersTooltipContent+ reward={reward}+ showBaseReward={false}+ showBottomGradient={false}+ className="p-0"+ />+ ) : (+ <ProgramRewardDescription+ reward={reward}+ showModifiersTooltip={false}+ />+ )}+ </div>++ {log.description && (+ <div className="border-border-subtle bg-bg-muted -mx-px rounded-b-xl border-x border-t px-3 py-2.5 shadow-sm">+ <div className="flex items-start gap-2">+ <ActivityLogUserAvatar user={log.user} />+ <p className="text-content-subtle text-xs">{log.description}</p>+ </div>+ </div>)}</div></div>diff --git a/apps/web/ui/activity-logs/activity-entry-chips.tsx b/apps/web/ui/activity-logs/activity-entry-chips.tsxindex b1dac127b7..1b007ac91b 100644--- a/apps/web/ui/activity-logs/activity-entry-chips.tsx+++ b/apps/web/ui/activity-logs/activity-entry-chips.tsx@@ -2,10 +2,9 @@ import { ActivityLog, GroupProps, ProgramProps } from "@/lib/types";import { getResourceColorData, RAINBOW_CONIC_GRADIENT } from "@/ui/colors";import { PartnerStatusBadges } from "@/ui/partners/partner-status-badges";import { SubmittedLeadStatusBadges } from "@/ui/submitted-leads/submitted-lead-status-badges";-import { ProgramEnrollmentStatus } from "@prisma/client";import { Bolt, Tooltip } from "@dub/ui";import { cn, OG_AVATAR_URL } from "@dub/utils";-import { SubmittedLeadStatus } from "@prisma/client";+import { ProgramEnrollmentStatus, SubmittedLeadStatus } from "@prisma/client";import { ReactNode } from "react";import { UserAvatar } from "../users/user-avatar";import { useActivityLogContext } from "./activity-log-context";@@ -172,10 +171,10 @@ export function ActivityLogUserAvatar({ user }: { user: ActivityLog["user"] }) {</div>}>- <div>+ <div className="shrink-0"><UserAvataruser={user}- className="size-4 shrink-0 transition-transform duration-100 hover:scale-110 hover:cursor-pointer"+ className="size-4 transition-transform duration-100 hover:scale-110 hover:cursor-pointer"/></div></Tooltip>diff --git a/apps/web/ui/modals/confirm-reward-change-modal.tsx b/apps/web/ui/modals/confirm-reward-change-modal.tsxindex 0a8f5a8d5a..14c549d471 100644--- a/apps/web/ui/modals/confirm-reward-change-modal.tsx+++ b/apps/web/ui/modals/confirm-reward-change-modal.tsx@@ -1,12 +1,15 @@"use client";import { RewardProps } from "@/lib/types";+import { REWARD_CHANGE_DESCRIPTION_MAX_LENGTH } from "@/lib/zod/schemas/rewards";import { ProgramRewardDescription } from "@/ui/partners/program-reward-description";import { REWARD_EVENT_DESCRIPTIONS } from "@/ui/partners/rewards/reward-event-descriptions";+import { MaxCharactersCounter } from "@/ui/shared/max-characters-counter";import { Button, Modal } from "@dub/ui";-import { pluralize } from "@dub/utils";+import { cn, pluralize } from "@dub/utils";import { EventType } from "@prisma/client";-import { useState } from "react";+import { useEffect, useState } from "react";+import { useForm } from "react-hook-form";import { PartnerEmailNotificationTooltipHelper } from "../shared/partner-email-notification-tooltip-helper";export type RewardChangeAction = "created" | "updated" | "deleted";@@ -23,6 +26,10 @@ const CONFIRM_TEXT: Record<RewardChangeAction, string> = {deleted: "Delete reward",};+type ConfirmRewardChangeFormData = {+ changeDescription: string;+};+type ConfirmRewardChangeModalProps = {showModal: boolean;setShowModal: (show: boolean) => void;@@ -43,7 +50,7 @@ type ConfirmRewardChangeModalProps = {| "spendLimitInterval">;partnerCount?: number;- onConfirm: () => Promise<void>;+ onConfirm: (changeDescription?: string) => Promise<void>;isPending?: boolean;};@@ -60,21 +67,40 @@ export function ConfirmRewardChangeModal({const [isLoading, setIsLoading] = useState(false);const { icon: Icon, title } = REWARD_EVENT_DESCRIPTIONS[event];+ const {+ register,+ handleSubmit,+ reset,+ control,+ formState: { errors },+ } = useForm<ConfirmRewardChangeFormData>({+ defaultValues: {+ changeDescription: "",+ },+ });++ useEffect(() => {+ if (showModal) {+ reset({ changeDescription: "" });+ }+ }, [showModal, reset]);+const change = {created: "added to",updated: "updated for",deleted: "removed from",}[action];- const handleConfirm = async () => {+ const onSubmit = handleSubmit(async ({ changeDescription }) => {setIsLoading(true);try {- await onConfirm();+ const trimmedDescription = changeDescription.trim();+ await onConfirm(trimmedDescription || undefined);setShowModal(false);} finally {setIsLoading(false);}- };+ });return (<Modal@@ -82,54 +108,106 @@ export function ConfirmRewardChangeModal({setShowModal={setShowModal}className="max-w-md">- <div className="px-5 py-4 text-left">- <h3 className="text-content-emphasis text-base font-semibold">- {TITLES[action]}- </h3>- <p className="text-content-subtle mt-1 text-sm">- The reward below will be {change} the group- {partnerCount && partnerCount > 0 ? (- <>- , and {partnerCount} {pluralize("partner", partnerCount)} will be{" "}- <PartnerEmailNotificationTooltipHelper />- </>- ) : (- ""- )}- .- </p>-- <div className="mt-4 rounded-lg border border-neutral-200 bg-neutral-100 p-3">- <div className="flex items-center gap-3">- <div className="flex size-10 shrink-0 items-center justify-center rounded-md border border-neutral-200 bg-white">- <Icon className="size-4 text-neutral-800" />- </div>- <div className="min-w-0 flex-1 space-y-0.5 py-0.5">- <p className="text-sm font-medium text-neutral-900">{title}</p>- <div className="text-sm text-neutral-600">- <ProgramRewardDescription reward={reward} />+ <form onSubmit={onSubmit}>+ <div className="px-5 py-4 text-left">+ <h3 className="text-content-emphasis text-base font-semibold">+ {TITLES[action]}+ </h3>+ <p className="text-content-subtle mt-1 text-sm">+ The reward below will be {change} the group+ {partnerCount && partnerCount > 0 ? (+ <>+ , and {partnerCount} {pluralize("partner", partnerCount)} will+ be <PartnerEmailNotificationTooltipHelper />+ </>+ ) : (+ ""+ )}+ .+ </p>++ <div className="mt-4 rounded-lg border border-neutral-200 bg-neutral-100 p-3">+ <div className="flex items-center gap-3">+ <div className="flex size-10 shrink-0 items-center justify-center rounded-md border border-neutral-200 bg-white">+ <Icon className="size-4 text-neutral-800" />+ </div>+ <div className="min-w-0 flex-1 space-y-0.5 py-0.5">+ <p className="text-sm font-medium text-neutral-900">{title}</p>+ <div className="text-sm text-neutral-600">+ <ProgramRewardDescription reward={reward} />+ </div></div></div></div>++ <div className="mt-4">+ <div className="flex items-center justify-between">+ <label+ htmlFor="changeDescription"+ className="text-content-emphasis text-sm font-medium"+ >+ Message to partners+ <span className="ml-1 font-normal text-neutral-500">+ (optional)+ </span>+ </label>+ <MaxCharactersCounter+ name="changeDescription"+ maxLength={REWARD_CHANGE_DESCRIPTION_MAX_LENGTH}+ control={control}+ />+ </div>+ <textarea+ id="changeDescription"+ rows={3}+ maxLength={REWARD_CHANGE_DESCRIPTION_MAX_LENGTH}+ placeholder="Add context about this change..."+ className={cn(+ "mt-2 block w-full rounded-md border-neutral-300 text-sm text-neutral-900 placeholder-neutral-400 focus:border-neutral-500 focus:outline-none focus:ring-neutral-500",+ errors.changeDescription && "border-red-600",+ )}+ {...register("changeDescription", {+ maxLength: {+ value: REWARD_CHANGE_DESCRIPTION_MAX_LENGTH,+ message: `Must be ${REWARD_CHANGE_DESCRIPTION_MAX_LENGTH} characters or fewer`,+ },+ })}+ />+ {errors.changeDescription && (+ <p className="mt-1 text-xs text-red-600">+ {errors.changeDescription.message}+ </p>+ )}+ {partnerCount && partnerCount > 0 ? (+ <p className="mt-1.5 text-xs text-neutral-500">+ Included in the partner notification email and activity log+ </p>+ ) : (+ <p className="mt-1.5 text-xs text-neutral-500">+ Saved to the activity log+ </p>+ )}+ </div>+ </div>++ <div className="border-border-subtle flex items-center justify-end gap-2 border-t px-5 py-4">+ <Button+ type="button"+ variant="secondary"+ className="h-8 w-fit px-3"+ text="Cancel"+ onClick={() => setShowModal(false)}+ disabled={isPending || isLoading}+ />+ <Button+ type="submit"+ variant={action === "deleted" ? "danger" : "primary"}+ className="h-8 w-fit px-3"+ text={CONFIRM_TEXT[action]}+ loading={isPending || isLoading}+ /></div>- </div>-- <div className="border-border-subtle flex items-center justify-end gap-2 border-t px-5 py-4">- <Button- variant="secondary"- className="h-8 w-fit px-3"- text="Cancel"- onClick={() => setShowModal(false)}- disabled={isPending || isLoading}- />- <Button- variant={action === "deleted" ? "danger" : "primary"}- className="h-8 w-fit px-3"- text={CONFIRM_TEXT[action]}- loading={isPending || isLoading}- onClick={handleConfirm}- />- </div>+ </form></Modal>);}@@ -139,7 +217,7 @@ export function useConfirmRewardChangeModal() {action: RewardChangeAction;event: EventType;reward: ConfirmRewardChangeModalProps["reward"];- onConfirm: () => Promise<void>;+ onConfirm: (changeDescription?: string) => Promise<void>;isPending?: boolean;partnerCount?: number;} | null>(null);@@ -150,7 +228,7 @@ export function useConfirmRewardChangeModal() {event: EventType;reward: ConfirmRewardChangeModalProps["reward"];partnerCount?: number;- onConfirm: () => Promise<void>;+ onConfirm: (changeDescription?: string) => Promise<void>;isPending?: boolean;}) => setState(options),closeConfirmRewardChangeModal: () => setState(null),diff --git a/apps/web/ui/partners/rewards/add-edit-reward-sheet.tsx b/apps/web/ui/partners/rewards/add-edit-reward-sheet.tsxindex 2e88352014..a4933ce1af 100644--- a/apps/web/ui/partners/rewards/add-edit-reward-sheet.tsx+++ b/apps/web/ui/partners/rewards/add-edit-reward-sheet.tsx@@ -418,16 +418,18 @@ function RewardSheetContent({reward: payload!,partnerCount: partnerCountForConfirm,isPending: isCreating || isUpdating,- onConfirm: async () => {+ onConfirm: async (changeDescription) => {if (!reward) {await createReward({...payload!,groupId: group.id,+ changeDescription,});} else {await updateReward({...payload!,rewardId: reward.id,+ changeDescription,});}},@@ -445,10 +447,11 @@ function RewardSheetContent({reward,partnerCount: partnerCountForConfirm,isPending: isDeleting,- onConfirm: async () => {+ onConfirm: async (changeDescription) => {await deleteReward({workspaceId,rewardId: reward.id,+ changeDescription,});},});diff --git a/packages/email/src/templates/partner-reward-updated.tsx b/packages/email/src/templates/partner-reward-updated.tsxindex 8b195c3f3d..ca9634d297 100644--- a/packages/email/src/templates/partner-reward-updated.tsx+++ b/packages/email/src/templates/partner-reward-updated.tsx@@ -37,6 +37,7 @@ export default function PartnerRewardUpdated({rewardSnapshot = {description: "30% per sale for the customers lifetime",icon: "https://assets.dub.co/email-assets/icons/invoice-dollar.png",+ changeDescription: "We're increasing rewards to better align with market rates.",},effectiveAt = new Date("2026-01-02T20:32:00.000Z"),action = "reward-created",@@ -54,6 +55,7 @@ export default function PartnerRewardUpdated({rewardSnapshot: {description: string;icon: string;+ changeDescription?: string;};effectiveAt: Date | string;action: "reward-created" | "reward-updated" | "reward-deleted";@@ -108,6 +110,13 @@ export default function PartnerRewardUpdated({</Section></Section>+ {rewardSnapshot.changeDescription && (+ <Text className="mb-0 mt-0 text-sm leading-6 text-neutral-600">+ <strong>Message from {program.name}:</strong>{" "}+ {rewardSnapshot.changeDescription}+ </Text>+ )}+<Text className="text-sm leading-6 text-neutral-600">This update is in effect as of{" "}<strong>{formattedEffectiveAt}</strong> and will apply to all