NPS survey

// src/journeys/nps-survey.ts
import { days, hours, minutes } from "@hogsend/engine";
import { defineJourney, sendEmail } from "@hogsend/engine";
import { Events, Templates } from "./constants/index.js";

export const npsSurvey = defineJourney({
  meta: {
    id: "nps-survey",
    name: "Feedback — NPS survey",
    enabled: true,
    // Any product activity makes them eligible; the entry limit does the
    // cadence — at most one survey per user per 90 days.
    trigger: { event: Events.APP_ACTIVE },
    entryLimit: "once_per_period",
    entryPeriod: days(90),
    suppress: hours(24),
    // No exitOn — and the awaited answer (nps.submitted) must NEVER be one.
  },

  run: async (user, ctx) => {
    await sendEmail({
      to: user.email,
      userId: user.id,
      journeyStateId: user.stateId,
      template: Templates.FEEDBACK_NPS_SURVEY, // "feedback/nps-survey"
      subject: "How likely are you to recommend us?",
      journeyName: user.journeyName,
    });

    // Answers are provisional clicks confirmed ~30s after the scanner-burst
    // window — timeouts are days, never minutes. lookback covers the
    // send→wait gap.
    const answer = await ctx.waitForEvent({
      event: Events.NPS_SUBMITTED,
      timeout: days(7),
      label: "await-score",
      lookback: minutes(30),
    });
    if (answer.timedOut) return; // silence — no chase; next window is in 90 days

    const band = answer.properties?.band;

    if (band === "detractor") {
      // Internal flag, fired immediately after the wait resolves. Scalars
      // only — the alert task resolves email/name server-side from contacts.
      await ctx.trigger({
        event: Events.NPS_DETRACTOR_FLAGGED,
        userId: user.id,
        properties: {
          band: "detractor",
          sourceEvent: Events.NPS_SUBMITTED,
          sourceTemplate: Templates.FEEDBACK_NPS_SURVEY,
          answeredAt: new Date().toISOString(),
        },
      });
      await ctx.checkpoint("detractor-flagged");
      return; // a human follows up — no automated reply to a low score
    }

    if (band === "promoter") {
      if (!(await ctx.guard.isSubscribed())) return;
      await sendEmail({
        to: user.email,
        userId: user.id,
        journeyStateId: user.stateId,
        template: Templates.FEEDBACK_REFERRAL_ASK, // "feedback/referral-ask"
        subject: "Glad it's working — know a team who'd want this?",
        journeyName: user.journeyName,
      });
    }
    // band === "passive" (7–8): the run ends with no follow-up.
  },
});

// src/emails/feedback-nps-survey.tsx (the answer row)
import { EmailAction, HOSTED_ANSWER_HREF } from "@hogsend/email";
import { Events } from "../journeys/constants/index.js";

<Section className="my-6 text-center">
  <EmailAction
    event={Events.NPS_SUBMITTED}
    properties={{ band: "detractor" }}
    href={HOSTED_ANSWER_HREF}
    className="mx-1 inline-block rounded-lg border px-5 py-2"
  >
    0–6
  </EmailAction>
  <EmailAction
    event={Events.NPS_SUBMITTED}
    properties={{ band: "passive" }}
    href={HOSTED_ANSWER_HREF}
    className="mx-1 inline-block rounded-lg border px-5 py-2"
  >
    7–8
  </EmailAction>
  <EmailAction
    event={Events.NPS_SUBMITTED}
    properties={{ band: "promoter" }}
    href={HOSTED_ANSWER_HREF}
    className="mx-1 inline-block rounded-lg border px-5 py-2"
  >
    9–10
  </EmailAction>
</Section>

// src/journeys/constants/index.ts
export const Events = {
  APP_ACTIVE: "app.active",
  NPS_SUBMITTED: "nps.submitted",
  NPS_DETRACTOR_FLAGGED: "nps.detractor_flagged",
} as const;

export const Templates = {
  FEEDBACK_NPS_SURVEY: "feedback/nps-survey",
  FEEDBACK_REFERRAL_ASK: "feedback/referral-ask",
} as const;