@robbeverhelst/do 1.285.0 → 1.286.0

package/dist/do.js

@@ -5096,6 +5096,67 @@ var seatingProposals = pgTable("seating_proposals", {
   createdAt: timestamp("created_at", { withTimezone: true }).notNull().defaultNow()
 }, (t) => [index("seating_proposals_list_idx").on(t.guestListId)]);
 
+// ../../packages/schema/src/db/mail.ts
+var mailCampaignStatus = pgEnum("mail_campaign_status", [
+  "draft",
+  "sending",
+  "sent",
+  "cancelled"
+]);
+var mailDeliveryStatus = pgEnum("mail_delivery_status", [
+  "queued",
+  "sending",
+  "sent",
+  "delivered",
+  "bounced",
+  "failed",
+  "skipped"
+]);
+var mailCampaigns = pgTable("mail_campaigns", {
+  id: text("id").primaryKey(),
+  tenantId: text("tenant_id").notNull().references(() => tenants.id),
+  guestListId: text("guest_list_id").references(() => guestLists.id, { onDelete: "cascade" }),
+  kind: text("kind").notNull().default("message"),
+  template: text("template").notNull(),
+  data: jsonb("data").$type().notNull().default({}),
+  replyTo: text("reply_to"),
+  status: mailCampaignStatus("status").notNull().default("draft"),
+  createdByUserId: text("created_by_user_id").references(() => users.id),
+  testSentAt: timestamp("test_sent_at", { withTimezone: true }),
+  startedAt: timestamp("started_at", { withTimezone: true }),
+  finishedAt: timestamp("finished_at", { withTimezone: true }),
+  createdAt: timestamp("created_at", { withTimezone: true }).notNull().defaultNow(),
+  updatedAt: timestamp("updated_at", { withTimezone: true }).notNull().defaultNow()
+}, (t) => [
+  index("mail_campaigns_tenant_idx").on(t.tenantId),
+  index("mail_campaigns_status_idx").on(t.status)
+]);
+var mailDeliveries = pgTable("mail_deliveries", {
+  id: text("id").primaryKey(),
+  tenantId: text("tenant_id").notNull().references(() => tenants.id),
+  campaignId: text("campaign_id").notNull().references(() => mailCampaigns.id, { onDelete: "cascade" }),
+  contactId: text("contact_id").references(() => contacts.id),
+  householdId: text("household_id").references(() => households.id),
+  toEmail: text("to_email").notNull(),
+  language: text("language").notNull().default("nl"),
+  data: jsonb("data").$type().notNull().default({}),
+  status: mailDeliveryStatus("status").notNull().default("queued"),
+  transport: text("transport"),
+  providerMessageId: text("provider_message_id"),
+  attempts: integer("attempts").notNull().default(0),
+  error: text("error"),
+  sentAt: timestamp("sent_at", { withTimezone: true }),
+  deliveredAt: timestamp("delivered_at", { withTimezone: true }),
+  bouncedAt: timestamp("bounced_at", { withTimezone: true }),
+  createdAt: timestamp("created_at", { withTimezone: true }).notNull().defaultNow()
+}, (t) => [
+  index("mail_deliveries_campaign_status_idx").on(t.campaignId, t.status),
+  index("mail_deliveries_sent_at_idx").on(t.sentAt),
+  index("mail_deliveries_household_idx").on(t.householdId),
+  uniqueIndex("mail_deliveries_provider_message_uniq").on(t.providerMessageId),
+  uniqueIndex("mail_deliveries_campaign_email_uniq").on(t.campaignId, t.toEmail)
+]);
+
 // ../../packages/schema/src/db/calendar.ts
 var calendarLinkPurpose = pgEnum("calendar_link_purpose", ["block", "deadline"]);
 var calendarEventLinks = pgTable("calendar_event_links", {
@@ -26739,6 +26800,124 @@ var thankYouViewSchema = object({
   thanked: array(thankYouGiftSchema)
 });
 
+// ../../packages/schema/src/contracts/mail.ts
+var MAIL_LANGUAGES = ["nl", "pt"];
+var mailLanguageSchema = _enum2(MAIL_LANGUAGES);
+var MAIL_CAMPAIGN_STATUSES = ["draft", "sending", "sent", "cancelled"];
+var mailCampaignStatusSchema = _enum2(MAIL_CAMPAIGN_STATUSES);
+var MAIL_DELIVERY_STATUSES = [
+  "queued",
+  "sending",
+  "sent",
+  "delivered",
+  "bounced",
+  "failed",
+  "skipped"
+];
+var mailDeliveryStatusSchema = _enum2(MAIL_DELIVERY_STATUSES);
+var mailCampaignSchema = createSelectSchema(mailCampaigns, {
+  data: record(string2(), unknown()),
+  testSentAt: exports_coerce.date().nullable().default(null),
+  startedAt: exports_coerce.date().nullable(),
+  finishedAt: exports_coerce.date().nullable(),
+  createdAt: exports_coerce.date(),
+  updatedAt: exports_coerce.date()
+});
+var mailDeliverySchema = createSelectSchema(mailDeliveries, {
+  data: record(string2(), unknown()),
+  sentAt: exports_coerce.date().nullable(),
+  deliveredAt: exports_coerce.date().nullable(),
+  bouncedAt: exports_coerce.date().nullable(),
+  createdAt: exports_coerce.date()
+});
+var mailFooterSchema = object({
+  deleteBy: keyDateDaySchema.optional(),
+  contact: email2().max(320).optional()
+}).strict();
+var lineSchema = string2().trim().min(1).max(2000);
+var mailMessageCopySchema = object({
+  subject: string2().trim().min(1).max(200),
+  heading: string2().trim().min(1).max(200),
+  paragraphs: array(lineSchema).max(20).default([]),
+  button: object({ label: string2().trim().min(1).max(80), url: url() }).strict().nullish()
+}).strict();
+var mailMessageDataSchema = object({
+  nl: mailMessageCopySchema,
+  pt: mailMessageCopySchema.optional(),
+  footer: mailFooterSchema.optional()
+}).strict();
+var mailProviderEventSchema = looseObject({
+  type: string2().min(1),
+  created_at: string2().optional(),
+  data: looseObject({
+    email_id: string2().min(1),
+    to: array(string2()).optional(),
+    bounce: looseObject({
+      type: string2().optional(),
+      message: string2().optional()
+    }).optional()
+  })
+});
+var MAIL_CAMPAIGN_KINDS = ["message", "save_the_date", "invitation"];
+var mailCampaignKindSchema = _enum2(MAIL_CAMPAIGN_KINDS);
+var MAIL_TEMPLATES = ["message"];
+var mailTemplateSchema = _enum2(MAIL_TEMPLATES);
+var mailTemplateDataSchemas = {
+  message: mailMessageDataSchema
+};
+function mailTemplateDataError(template, data) {
+  const parsed = mailTemplateDataSchemas[template].safeParse(data);
+  return parsed.success ? null : parsed.error.issues[0]?.message ?? "invalid data";
+}
+var replyToSchema = email2().max(320);
+var createMailCampaignInputSchema = object({
+  id: ulidSchema,
+  guestListId: ulidSchema,
+  kind: mailCampaignKindSchema.default("message"),
+  template: mailTemplateSchema.default("message"),
+  data: record(string2(), unknown()),
+  replyTo: replyToSchema.nullish()
+}).strict().superRefine((input, ctx) => {
+  const error = mailTemplateDataError(input.template, input.data);
+  if (error)
+    ctx.addIssue({ code: "custom", path: ["data"], message: error });
+});
+var updateMailCampaignInputSchema = object({
+  kind: mailCampaignKindSchema.optional(),
+  data: record(string2(), unknown()).optional(),
+  replyTo: replyToSchema.nullish()
+}).strict();
+var mailCampaignsQuerySchema = object({ guestListId: ulidSchema }).strict();
+var mailPreviewQuerySchema = object({ language: mailLanguageSchema.default("nl") }).strict();
+var mailPreviewSchema = object({
+  language: mailLanguageSchema,
+  subject: string2(),
+  html: string2(),
+  text: string2()
+});
+var mailTestResultSchema = object({ to: array(string2()) });
+var sendMailCampaignInputSchema = object({ households: number2().int().positive() }).strict();
+var householdMailStatusSchema = _enum2([
+  "queued",
+  "sent",
+  "delivered",
+  "bounced",
+  "failed",
+  "skipped"
+]);
+var mailRecipientHouseholdSchema = object({
+  householdId: string2().nullable(),
+  name: string2(),
+  language: mailLanguageSchema,
+  addresses: number2().int().nonnegative(),
+  status: householdMailStatusSchema.nullable()
+});
+var mailCampaignViewSchema = mailCampaignSchema.extend({
+  households: array(mailRecipientHouseholdSchema),
+  counts: partialRecord(mailDeliveryStatusSchema, number2().int().nonnegative()),
+  readyToSend: boolean3()
+});
+
 // ../../packages/schema/src/contracts/calendar.ts
 var calendarEventLinkSchema = createSelectSchema(calendarEventLinks, {
   createdAt: exports_coerce.date(),
@@ -28439,7 +28618,7 @@ function parseCapture2(input, now) {
 
 // src/meta.ts
 var CLI_NAME = "do";
-var VERSION = "1.285.0";
+var VERSION = "1.286.0";
 var API_PREFIX = "/api/v1";
 var DEFAULT_API_URL = "http://localhost:3001";
 
@@ -33828,6 +34007,61 @@ var COMMAND_SPECS = [
     scopes: ["contacts:write"],
     returns: "SeatingProposal"
   },
+  {
+    path: ["mail-campaigns", "list"],
+    summary: "A guest list's mail campaigns (save-the-dates, invitations), newest first.",
+    args: [],
+    flags: [{ name: "list", type: "string", description: "The guest list's id (required)." }],
+    scopes: ["contacts:read"],
+    returns: "MailCampaignView",
+    notes: "Each campaign carries the households it reaches (a draft: who it would go to) with their status, its mails by status, and readyToSend."
+  },
+  {
+    path: ["mail-campaigns", "get"],
+    summary: "One mail campaign, with its households and how far it got.",
+    args: [{ name: "id", required: true, description: "The campaign's id." }],
+    flags: [],
+    scopes: ["contacts:read"],
+    returns: "MailCampaignView"
+  },
+  {
+    path: ["mail-campaigns", "create"],
+    summary: "Draft a mail campaign for a guest list; nothing is sent.",
+    args: [],
+    flags: [
+      {
+        name: "data",
+        type: "string",
+        description: 'JSON CreateMailCampaignInput, e.g. {"guestListId":"01\u2026","kind":"save_the_date","template":"message","data":{"nl":{"subject":"\u2026","heading":"\u2026","paragraphs":["\u2026"]},"pt":{\u2026},"footer":{"deleteBy":"2027-12-31"}},"replyTo":"hallo@example.com"}'
+      }
+    ],
+    scopes: ["contacts:write"],
+    returns: "MailCampaignView",
+    notes: "Drafting only: a member previews it, sends a test to the Space's members and sends it from the Mail tab. An agent can never test or send."
+  },
+  {
+    path: ["mail-campaigns", "update"],
+    summary: "Edit a draft campaign (its copy, kind or reply address).",
+    args: [{ name: "id", required: true, description: "The campaign's id." }],
+    flags: [
+      {
+        name: "data",
+        type: "string",
+        description: 'JSON UpdateMailCampaignInput, e.g. {"data":{"nl":{\u2026}}}'
+      }
+    ],
+    scopes: ["contacts:write"],
+    returns: "MailCampaignView",
+    notes: "Only a draft changes (409 otherwise); an edit makes the last test stale."
+  },
+  {
+    path: ["mail-campaigns", "preview"],
+    summary: "Draw a campaign's mail as its first household would get it.",
+    args: [{ name: "id", required: true, description: "The campaign's id." }],
+    flags: [{ name: "language", type: "string", description: "nl (default) or pt." }],
+    scopes: ["contacts:read"],
+    returns: "MailPreview"
+  },
   {
     path: ["guest-lists", "thank-you"],
     summary: "The gifts for the event: the cards still to send, then the ones sent.",
@@ -39006,6 +39240,42 @@ var HANDLERS = {
       render: renderRecord
     };
   },
+  "mail-campaigns list": async ({ flags, requireClient }) => {
+    const list = flagString(flags, "list");
+    if (!list)
+      throw usageError("mail-campaigns list needs --list <guest list id>");
+    parseInput(mailCampaignsQuerySchema, { guestListId: list });
+    return {
+      data: await requireClient().get("/mail-campaigns", { query: { guestListId: list } }),
+      render: renderRecord
+    };
+  },
+  "mail-campaigns get": async ({ args, requireClient }) => {
+    const id = requireArg(args, 0, "campaign id");
+    return { data: await requireClient().get(`/mail-campaigns/${id}`), render: renderRecord };
+  },
+  "mail-campaigns create": async ({ flags, requireClient }) => {
+    const body = parseInput(createMailCampaignInputSchema, { id: ulid3(), ...readDataFlag(flags) });
+    return { data: await requireClient().post("/mail-campaigns", body), render: renderRecord };
+  },
+  "mail-campaigns update": async ({ args, flags, requireClient }) => {
+    const id = requireArg(args, 0, "campaign id");
+    const body = parseInput(updateMailCampaignInputSchema, readDataFlag(flags));
+    return {
+      data: await requireClient().patch(`/mail-campaigns/${id}`, body),
+      render: renderRecord
+    };
+  },
+  "mail-campaigns preview": async ({ args, flags, requireClient }) => {
+    const id = requireArg(args, 0, "campaign id");
+    const query = parseInput(mailPreviewQuerySchema, {
+      language: flagString(flags, "language") ?? "nl"
+    });
+    return {
+      data: await requireClient().get(`/mail-campaigns/${id}/preview`, { query }),
+      render: renderRecord
+    };
+  },
   "guest-lists thank-you": async ({ args, requireClient }) => {
     const id = requireArg(args, 0, "guest list id");
     return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@robbeverhelst/do",
-  "version": "1.285.0",
+  "version": "1.286.0",
   "private": false,
   "description": "do — the agent-drivable CLI over the public /api/v1 surface",
   "homepage": "https://github.com/robbeverhelst/do/tree/main/apps/cli",