Weekly digest email: template and code

{
  "name": "Weekly activity digest",
  "nodes": [
    {
      "type": "trigger",
      "trigger_type": "api-invoke"
    },
    {
      "type": "add-to-digest",
      "subscription_topic_id": "set-by-setup-digest"
    },
    {
      "type": "exit"
    }
  ]
}

// Creates this recipe's journey from journey.json and the templates/ folder,
// then publishes it. Run it once per workspace:
//
//   COURIER_API_KEY=pk_... node --experimental-strip-types setup.ts
//
// It prints the journey ID and the template IDs it created.
import Courier from "@trycourier/courier";
import { readFileSync, readdirSync } from "node:fs";

const client = new Courier();
const here = new URL(".", import.meta.url);
const readJson = (path: string) =>
  JSON.parse(readFileSync(new URL(path, here), "utf8"));

const spec = readJson("journey.json");

// 1. Create the journey, then the templates its send nodes use.
const journey = await client.journeys.create({
  name: spec.name,
  nodes: [spec.nodes[0], spec.nodes.at(-1)],
});

const templateIds: Record<string, string> = {};
for (const file of readdirSync(new URL("templates/", here))) {
  const key = file.replace(/\.json$/, "");
  const template = await client.journeys.templates.create(
    journey.id,
    readJson(`templates/${file}`)
  );
  await client.journeys.templates.publish(template.id, {
    templateId: journey.id,
  });
  templateIds[key] = template.id;
}

// 2. Save the nodes. In journey.json, "@<template>" stands for the ID of the
// template with that file name. Node IDs must be unique across a workspace,
// so any node ID journey.json names (used by "send_status.<id>" conditions)
// gets this journey's ID added.
const nodeIds = [
  ...JSON.stringify(spec.nodes).matchAll(/"id":"([\w-]+)"/g),
].map((m) => m[1]);
let nodes = JSON.stringify(spec.nodes).replace(/"@([\w-]+)"/g, (_, key) =>
  JSON.stringify(templateIds[key])
);
for (const id of nodeIds)
  nodes = nodes.replace(
    new RegExp(`(?<=[".])${id}(?=")`, "g"),
    `${id}-${journey.id}`
  );
await client.journeys.replace(journey.id, {
  name: spec.name,
  cancelation_token: spec.cancelation_token,
  nodes: JSON.parse(nodes),
});

// 3. Publish, so new runs use this version.
await client.journeys.publish(journey.id);
console.log(JSON.stringify({ journeyId: journey.id, templateIds }));

// Creates the weekly schedule behind this recipe's Send to Digest node: a
// subscription topic whose digest renders with the journey's weekly digest
// template and releases every Monday at 9:00. Then it points the journey at
// the topic and publishes it. It reads the output of setup.ts from stdin, so
// pipe the two together:
//
//   COURIER_API_KEY=pk_... node --experimental-strip-types setup.ts | COURIER_API_KEY=pk_... node --experimental-strip-types setup-digest.ts
//
// Set COURIER_PREFERENCE_SECTION_ID to add the topic to a preference section
// you already have. It prints the journey, section, and topic IDs, which
// stop.ts needs.
import Courier from "@trycourier/courier";
import { readFileSync } from "node:fs";

const client = new Courier();

// 1. The journey and digest template that setup.ts just created.
const { journeyId, templateIds } = JSON.parse(readFileSync(0, "utf8"));
const templateId = templateIds?.["weekly-digest-email"];
if (!journeyId || !templateId)
  throw new Error("Pipe the output of setup.ts into this script");

// 2. A topic with a digest: the template, a weekly schedule, and the latest
// 20 events. Users who never pick a schedule get the default one.
const sectionId =
  process.env.COURIER_PREFERENCE_SECTION_ID ??
  (await client.workspacePreferences.create({ name: "Activity" })).id;
const topic = await client.workspacePreferences.topics.create(sectionId, {
  name: "Weekly activity summary",
  default_status: "OPTED_IN",
  routing_options: ["email"],
  digest: {
    template_id: templateId,
    schedules: [
      {
        frequency: "weekly",
        day_of_week: "monday",
        time: "09:00",
        timezone: "America/New_York",
        is_default: true,
      },
    ],
    categories: [{ category_key: "digest", retain: "LAST", limit: 20 }],
  },
});

// 3. Point the journey's Send to Digest node at the topic, then publish.
const journey = await client.journeys.retrieve(journeyId);
await client.journeys.replace(journeyId, {
  name: journey.name,
  nodes: journey.nodes.map((node: any) =>
    node.type === "add-to-digest"
      ? { ...node, subscription_topic_id: topic.id }
      : node
  ),
});
await client.journeys.publish(journeyId);
console.log(JSON.stringify({ journeyId, sectionId, topicId: topic.id }));

{
  "channel": "email",
  "notification": {
    "name": "Weekly digest (email)",
    "tags": ["recipe", "weekly-digest-email"],
    "brand": null,
    "subscription": null,
    "content": {
      "version": "2022-01-01",
      "elements": [
        {
          "type": "channel",
          "channel": "email",
          "elements": [
            {
              "type": "meta",
              "title": "Your weekly activity summary"
            },
            {
              "type": "text",
              "content": "Here's what happened this week ({{digest.count}} in total). The latest:"
            },
            {
              "type": "text",
              "content": "{{$.item.actor_name}} {{$.item.action}} {{$.item.target_name}}",
              "loop": "data.digest.items"
            },
            {
              "type": "action",
              "content": "See all activity",
              "href": "https://app.acme.com/activity"
            }
          ]
        }
      ]
    }
  }
}