@dench.com/cli 2.2.1 → 2.2.2

package/email.ts

@@ -1,7 +1,7 @@
 import { readFile } from "node:fs/promises";
 import type { ConvexHttpClient } from "convex/browser";
 import { makeFunctionReference } from "convex/server";
-import { getFlag, parseJson } from "./lib/cli-args";
+import { getFlag, hasFlag, parseJson } from "./lib/cli-args";
 
 type EmailCliContext = {
   convex: ConvexHttpClient;
@@ -202,11 +202,29 @@ Usage:
   dench email template create --name "Intro" --subject "Hi {{firstName}}" --html-file body.html [--text-file body.txt] [--json]
   dench email template preview --template <id> --data '{"firstName":"Ada"}' [--json]
   dench email campaign create --name "Q2 outreach" --identity <identityId|fromEmail> --template <id> [--json]
+  dench email campaign list [--status sending] [--limit 25] [--json]
   dench email campaign recipients add --campaign <id> --file recipients.jsonl [--json]
+  dench email campaign recipients list --campaign <id> [--status queued] [--limit 50] [--json]
+  dench email campaign recipients add-from-object --campaign <id> --object prospect --email-field "Email" --entries id1,id2 [--json]
   dench email campaign preview --campaign <id> [--sample 5] [--json]
   dench email campaign submit --campaign <id> [--json]
   dench email campaign status --campaign <id> [--json]
-  dench email campaign pause|resume|cancel --campaign <id> [--json]`);
+  dench email campaign pause|resume|cancel --campaign <id> [--json]
+
+Sequences (automatic multi-step follow-ups):
+  dench email sequence create --name "New-customer follow-up" --identity <identityId|fromEmail> [--stop-on-click] [--no-stop-on-reply] [--json]
+  dench email sequence list [--all] [--json]
+  dench email sequence status --sequence <id> [--json]
+  dench email sequence steps add --sequence <id> --subject "Hi {{firstName}}" --html-file step1.html [--delay-days 0] [--delay-hours 0] [--json]
+  dench email sequence steps update --step <id> [--subject ...] [--html-file ...] [--delay-days 3] [--json]
+  dench email sequence steps remove --step <id> [--json]
+  dench email sequence steps reorder --sequence <id> --steps id1,id2,id3 [--json]
+  dench email sequence activate|deactivate --sequence <id> [--json]
+  dench email sequence enroll --sequence <id> --file recipients.jsonl [--json]
+  dench email sequence enroll-from-object --sequence <id> --object prospect --email-field "Email" --entries id1,id2 [--json]
+  dench email sequence enrollments list --sequence <id> [--status active] [--limit 50] [--json]
+  dench email sequence enrollment pause|resume|stop --enrollment <id> [--json]
+  dench email sequence archive --sequence <id> [--json]`);
 }
 
 export async function runEmailCommand(ctx: EmailCliContext): Promise<void> {
@@ -235,9 +253,22 @@ export async function runEmailCommand(ctx: EmailCliContext): Promise<void> {
     await runCampaign(ctx);
     return;
   }
+  if (group === "sequence") {
+    await runSequence(ctx);
+    return;
+  }
   throw new EmailCliError(`Unknown dench email subcommand: ${group}`);
 }
 
+/** Parse a comma-separated list of CRM entry ids. */
+function parseEntryIds(value: string | undefined): string[] {
+  if (!value?.trim()) return [];
+  return value
+    .split(",")
+    .map((id) => id.trim())
+    .filter(Boolean);
+}
+
 /**
  * Parse a comma-separated address list where each entry is either a bare
  * email or `Name <email>`.
@@ -662,11 +693,60 @@ async function runCampaign(ctx: EmailCliContext) {
     );
     return;
   }
+  if (sub === "list") {
+    const limitRaw = getFlag(ctx.args, "--limit");
+    const status = getFlag(ctx.args, "--status");
+    const payload = await callQuery(
+      ctx,
+      "functions/emailCampaigns:listCampaigns",
+      {
+        paginationOpts: {
+          numItems: limitRaw ? Number(limitRaw) : 25,
+          cursor: null,
+        },
+        status,
+      },
+    );
+    out(ctx, payload, JSON.stringify(payload, null, 2));
+    return;
+  }
   if (sub === "recipients") {
     const nested = ctx.args.shift();
+    if (nested === "list") {
+      const limitRaw = getFlag(ctx.args, "--limit");
+      const status = getFlag(ctx.args, "--status");
+      const payload = await callQuery(
+        ctx,
+        "functions/emailCampaigns:listRecipients",
+        {
+          campaignId: requiredFlag(ctx.args, "--campaign"),
+          paginationOpts: {
+            numItems: limitRaw ? Number(limitRaw) : 50,
+            cursor: null,
+          },
+          status,
+        },
+      );
+      out(ctx, payload, JSON.stringify(payload, null, 2));
+      return;
+    }
+    if (nested === "add-from-object") {
+      const payload = await callMutation(
+        ctx,
+        "functions/emailCampaigns:addRecipientsFromCrm",
+        {
+          campaignId: requiredFlag(ctx.args, "--campaign"),
+          objectName: requiredFlag(ctx.args, "--object"),
+          emailFieldName: getFlag(ctx.args, "--email-field"),
+          entryIds: parseEntryIds(requiredFlag(ctx.args, "--entries")),
+        },
+      );
+      out(ctx, payload, JSON.stringify(payload, null, 2));
+      return;
+    }
     if (nested !== "add") {
       throw new EmailCliError(
-        "Usage: dench email campaign recipients add --campaign <id> --file recipients.jsonl",
+        "Usage: dench email campaign recipients add|list|add-from-object",
       );
     }
     const campaignId = requiredFlag(ctx.args, "--campaign");
@@ -734,6 +814,227 @@ async function runCampaign(ctx: EmailCliContext) {
     return;
   }
   throw new EmailCliError(
-    "Usage: dench email campaign create|recipients|preview|submit|status|pause|resume|cancel",
+    "Usage: dench email campaign create|list|recipients|preview|submit|status|pause|resume|cancel",
+  );
+}
+
+async function runSequence(ctx: EmailCliContext) {
+  const sub = ctx.args.shift();
+  if (sub === "create") {
+    const stopOnReply = !hasFlag(ctx.args, "--no-stop-on-reply");
+    const payload = await callMutation(
+      ctx,
+      "functions/emailSequences:createSequence",
+      {
+        name: requiredFlag(ctx.args, "--name"),
+        identityId: requiredFlag(ctx.args, "--identity"),
+        replyToMode: getFlag(ctx.args, "--reply-to-mode"),
+        stopOnReply,
+        stopOnClick: getFlag(ctx.args, "--stop-on-click") !== undefined,
+      },
+    );
+    out(
+      ctx,
+      payload,
+      `Sequence created: ${(payload as JsonRecord).sequenceId}`,
+    );
+    return;
+  }
+  if (sub === "update") {
+    const payload = await callMutation(
+      ctx,
+      "functions/emailSequences:updateSequence",
+      {
+        sequenceId: requiredFlag(ctx.args, "--sequence"),
+        name: getFlag(ctx.args, "--name"),
+        identityId: getFlag(ctx.args, "--identity"),
+        replyToMode: getFlag(ctx.args, "--reply-to-mode"),
+      },
+    );
+    out(ctx, payload, JSON.stringify(payload, null, 2));
+    return;
+  }
+  if (sub === "activate" || sub === "deactivate") {
+    const payload = await callMutation(
+      ctx,
+      "functions/emailSequences:setSequenceActive",
+      {
+        sequenceId: requiredFlag(ctx.args, "--sequence"),
+        active: sub === "activate",
+      },
+    );
+    out(ctx, payload, JSON.stringify(payload, null, 2));
+    return;
+  }
+  if (sub === "archive") {
+    const payload = await callMutation(
+      ctx,
+      "functions/emailSequences:archiveSequence",
+      { sequenceId: requiredFlag(ctx.args, "--sequence") },
+    );
+    out(ctx, payload, JSON.stringify(payload, null, 2));
+    return;
+  }
+  if (sub === "list") {
+    const payload = await callQuery(
+      ctx,
+      "functions/emailSequences:listSequences",
+      { includeArchived: getFlag(ctx.args, "--all") !== undefined },
+    );
+    out(ctx, payload, JSON.stringify(payload, null, 2));
+    return;
+  }
+  if (sub === "status") {
+    const payload = await callQuery(
+      ctx,
+      "functions/emailSequences:getSequence",
+      { sequenceId: requiredFlag(ctx.args, "--sequence") },
+    );
+    out(ctx, payload, JSON.stringify(payload, null, 2));
+    return;
+  }
+  if (sub === "steps") {
+    const nested = ctx.args.shift();
+    if (nested === "add") {
+      const htmlBody = await readTextFlag(ctx.args, "--html", "--html-file");
+      if (!htmlBody) throw new EmailCliError("Missing --html or --html-file");
+      const delayDaysRaw = getFlag(ctx.args, "--delay-days");
+      const delayHoursRaw = getFlag(ctx.args, "--delay-hours");
+      const delayHours =
+        (delayDaysRaw ? Number(delayDaysRaw) * 24 : 0) +
+        (delayHoursRaw ? Number(delayHoursRaw) : 0);
+      const payload = await callMutation(
+        ctx,
+        "functions/emailSequences:addStep",
+        {
+          sequenceId: requiredFlag(ctx.args, "--sequence"),
+          subject: requiredFlag(ctx.args, "--subject"),
+          htmlBody,
+          textBody: await readTextFlag(ctx.args, "--text", "--text-file"),
+          delayHours,
+        },
+      );
+      out(ctx, payload, `Step added: ${(payload as JsonRecord).stepId}`);
+      return;
+    }
+    if (nested === "update") {
+      const delayDaysRaw = getFlag(ctx.args, "--delay-days");
+      const delayHoursRaw = getFlag(ctx.args, "--delay-hours");
+      const delayHours =
+        delayDaysRaw || delayHoursRaw
+          ? (delayDaysRaw ? Number(delayDaysRaw) * 24 : 0) +
+            (delayHoursRaw ? Number(delayHoursRaw) : 0)
+          : undefined;
+      const payload = await callMutation(
+        ctx,
+        "functions/emailSequences:updateStep",
+        {
+          stepId: requiredFlag(ctx.args, "--step"),
+          subject: getFlag(ctx.args, "--subject"),
+          htmlBody: await readTextFlag(ctx.args, "--html", "--html-file"),
+          textBody: await readTextFlag(ctx.args, "--text", "--text-file"),
+          delayHours,
+        },
+      );
+      out(ctx, payload, JSON.stringify(payload, null, 2));
+      return;
+    }
+    if (nested === "remove") {
+      const payload = await callMutation(
+        ctx,
+        "functions/emailSequences:removeStep",
+        { stepId: requiredFlag(ctx.args, "--step") },
+      );
+      out(ctx, payload, JSON.stringify(payload, null, 2));
+      return;
+    }
+    if (nested === "reorder") {
+      const payload = await callMutation(
+        ctx,
+        "functions/emailSequences:reorderSteps",
+        {
+          sequenceId: requiredFlag(ctx.args, "--sequence"),
+          orderedStepIds: parseEntryIds(requiredFlag(ctx.args, "--steps")),
+        },
+      );
+      out(ctx, payload, JSON.stringify(payload, null, 2));
+      return;
+    }
+    throw new EmailCliError(
+      "Usage: dench email sequence steps add|update|remove|reorder",
+    );
+  }
+  if (sub === "enroll") {
+    const file = getFlag(ctx.args, "--file");
+    const rows = file
+      ? await readRecipients(file)
+      : ((optionalJsonFlag(ctx.args, "--data") as JsonRecord[] | undefined) ??
+        []);
+    if (rows.length === 0) throw new EmailCliError("No recipients provided");
+    const payload = await callMutation(ctx, "functions/emailSequences:enroll", {
+      sequenceId: requiredFlag(ctx.args, "--sequence"),
+      recipients: toRecipients(rows),
+    });
+    out(ctx, payload, JSON.stringify(payload, null, 2));
+    return;
+  }
+  if (sub === "enroll-from-object") {
+    const payload = await callMutation(
+      ctx,
+      "functions/emailSequences:enrollFromCrm",
+      {
+        sequenceId: requiredFlag(ctx.args, "--sequence"),
+        objectName: requiredFlag(ctx.args, "--object"),
+        emailFieldName: getFlag(ctx.args, "--email-field"),
+        entryIds: parseEntryIds(requiredFlag(ctx.args, "--entries")),
+      },
+    );
+    out(ctx, payload, JSON.stringify(payload, null, 2));
+    return;
+  }
+  if (sub === "enrollments") {
+    const nested = ctx.args.shift();
+    if (nested !== "list") {
+      throw new EmailCliError("Usage: dench email sequence enrollments list");
+    }
+    const limitRaw = getFlag(ctx.args, "--limit");
+    const payload = await callQuery(
+      ctx,
+      "functions/emailSequences:listEnrollments",
+      {
+        sequenceId: requiredFlag(ctx.args, "--sequence"),
+        paginationOpts: {
+          numItems: limitRaw ? Number(limitRaw) : 50,
+          cursor: null,
+        },
+        status: getFlag(ctx.args, "--status"),
+      },
+    );
+    out(ctx, payload, JSON.stringify(payload, null, 2));
+    return;
+  }
+  if (sub === "enrollment") {
+    const nested = ctx.args.shift();
+    const fn =
+      nested === "pause"
+        ? "pauseEnrollment"
+        : nested === "resume"
+          ? "resumeEnrollment"
+          : nested === "stop"
+            ? "stopEnrollment"
+            : null;
+    if (!fn) {
+      throw new EmailCliError(
+        "Usage: dench email sequence enrollment pause|resume|stop --enrollment <id>",
+      );
+    }
+    const payload = await callMutation(ctx, `functions/emailSequences:${fn}`, {
+      enrollmentId: requiredFlag(ctx.args, "--enrollment"),
+    });
+    out(ctx, payload, JSON.stringify(payload, null, 2));
+    return;
+  }
+  throw new EmailCliError(
+    "Usage: dench email sequence create|update|activate|deactivate|archive|list|status|steps|enroll|enroll-from-object|enrollments|enrollment",
   );
 }

package/lib/command-registry.ts

@@ -1096,7 +1096,7 @@ const rawApiOperations = [
     id: "crm.templates.removeSampleData",
     group: "crm",
     summary:
-      "Delete a CRM template's sample rows (tagged \"Sample\"); schema, views, and automations stay.",
+      'Delete a CRM template\'s sample rows (tagged "Sample"); schema, views, and automations stay.',
     cli: "dench crm templates remove-sample-data",
     method: "POST",
     path: "/crm/templates/{templateId}/remove-sample-data",
@@ -1410,6 +1410,243 @@ const rawApiOperations = [
     responseSchema: anyResponse,
     backend: convex("mutation", "functions/emailCampaigns:cancelCampaign"),
   }),
+  op({
+    id: "email.campaign.list",
+    group: "email",
+    summary:
+      "List managed email campaigns (paginated, optional status filter).",
+    cli: "dench email campaign list",
+    method: "GET",
+    path: "/email/campaigns",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: convex("query", "functions/emailCampaigns:listCampaigns"),
+  }),
+  op({
+    id: "email.campaign.recipients.list",
+    group: "email",
+    summary:
+      "List a campaign's recipients (paginated, optional status filter).",
+    cli: "dench email campaign recipients list",
+    method: "GET",
+    path: "/email/campaigns/{campaignId}/recipients",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: convex("query", "functions/emailCampaigns:listRecipients"),
+  }),
+  op({
+    id: "email.campaign.recipients.addFromObject",
+    group: "email",
+    summary:
+      "Add campaign recipients from a CRM object: pick the object, the email field, and the entry ids.",
+    cli: "dench email campaign recipients add-from-object",
+    method: "POST",
+    path: "/email/campaigns/{campaignId}/recipients/from-object",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: convex(
+      "mutation",
+      "functions/emailCampaigns:addRecipientsFromCrm",
+    ),
+  }),
+
+  // Managed email sequences (multi-step drip cadences).
+  op({
+    id: "email.sequence.create",
+    group: "email",
+    summary:
+      "Create a follow-up sequence; choose a verified sender and reply/stop behavior.",
+    cli: "dench email sequence create",
+    method: "POST",
+    path: "/email/sequences",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: convex("mutation", "functions/emailSequences:createSequence"),
+  }),
+  op({
+    id: "email.sequence.update",
+    group: "email",
+    summary: "Update a sequence's name, sender, or reply/stop settings.",
+    cli: "dench email sequence update",
+    method: "POST",
+    path: "/email/sequences/{sequenceId}",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: convex("mutation", "functions/emailSequences:updateSequence"),
+  }),
+  op({
+    id: "email.sequence.activate",
+    group: "email",
+    summary: "Activate a sequence so its enrollments begin sending.",
+    cli: "dench email sequence activate",
+    method: "POST",
+    path: "/email/sequences/{sequenceId}/activate",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: {
+      ...convex("mutation", "functions/emailSequences:setSequenceActive"),
+      fixedArgs: { active: true },
+    },
+  }),
+  op({
+    id: "email.sequence.deactivate",
+    group: "email",
+    summary: "Deactivate a sequence (pause sending, revert to draft).",
+    cli: "dench email sequence deactivate",
+    method: "POST",
+    path: "/email/sequences/{sequenceId}/deactivate",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: {
+      ...convex("mutation", "functions/emailSequences:setSequenceActive"),
+      fixedArgs: { active: false },
+    },
+  }),
+  op({
+    id: "email.sequence.archive",
+    group: "email",
+    summary: "Archive a sequence (stops all sending).",
+    cli: "dench email sequence archive",
+    method: "POST",
+    path: "/email/sequences/{sequenceId}/archive",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: convex("mutation", "functions/emailSequences:archiveSequence"),
+  }),
+  op({
+    id: "email.sequence.list",
+    group: "email",
+    summary: "List the workspace's follow-up sequences.",
+    cli: "dench email sequence list",
+    method: "GET",
+    path: "/email/sequences",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: convex("query", "functions/emailSequences:listSequences"),
+  }),
+  op({
+    id: "email.sequence.get",
+    group: "email",
+    summary: "Read a sequence with its ordered steps.",
+    cli: "dench email sequence status",
+    method: "GET",
+    path: "/email/sequences/{sequenceId}",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: convex("query", "functions/emailSequences:getSequence"),
+  }),
+  op({
+    id: "email.sequence.step.add",
+    group: "email",
+    summary: "Add a step (subject, body, and wait delay) to a sequence.",
+    cli: "dench email sequence steps add",
+    method: "POST",
+    path: "/email/sequences/{sequenceId}/steps",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: convex("mutation", "functions/emailSequences:addStep"),
+  }),
+  op({
+    id: "email.sequence.step.update",
+    group: "email",
+    summary: "Update a sequence step's subject, body, or delay.",
+    cli: "dench email sequence steps update",
+    method: "POST",
+    path: "/email/sequences/steps/{stepId}",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: convex("mutation", "functions/emailSequences:updateStep"),
+  }),
+  op({
+    id: "email.sequence.step.remove",
+    group: "email",
+    summary: "Remove a step from a sequence.",
+    cli: "dench email sequence steps remove",
+    method: "POST",
+    path: "/email/sequences/steps/{stepId}/remove",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: convex("mutation", "functions/emailSequences:removeStep"),
+  }),
+  op({
+    id: "email.sequence.step.reorder",
+    group: "email",
+    summary: "Reorder a sequence's steps.",
+    cli: "dench email sequence steps reorder",
+    method: "POST",
+    path: "/email/sequences/{sequenceId}/steps/reorder",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: convex("mutation", "functions/emailSequences:reorderSteps"),
+  }),
+  op({
+    id: "email.sequence.enroll",
+    group: "email",
+    summary: "Enroll explicit recipients into a sequence.",
+    cli: "dench email sequence enroll",
+    method: "POST",
+    path: "/email/sequences/{sequenceId}/enroll",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: convex("mutation", "functions/emailSequences:enroll"),
+  }),
+  op({
+    id: "email.sequence.enrollFromObject",
+    group: "email",
+    summary:
+      "Enroll people from a CRM object: pick the object, the email field, and the entry ids.",
+    cli: "dench email sequence enroll-from-object",
+    method: "POST",
+    path: "/email/sequences/{sequenceId}/enroll/from-object",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: convex("mutation", "functions/emailSequences:enrollFromCrm"),
+  }),
+  op({
+    id: "email.sequence.enrollments.list",
+    group: "email",
+    summary:
+      "List a sequence's enrollments (paginated, optional status filter).",
+    cli: "dench email sequence enrollments list",
+    method: "GET",
+    path: "/email/sequences/{sequenceId}/enrollments",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: convex("query", "functions/emailSequences:listEnrollments"),
+  }),
+  op({
+    id: "email.sequence.enrollment.pause",
+    group: "email",
+    summary: "Pause one enrollment.",
+    cli: "dench email sequence enrollment pause",
+    method: "POST",
+    path: "/email/sequences/enrollments/{enrollmentId}/pause",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: convex("mutation", "functions/emailSequences:pauseEnrollment"),
+  }),
+  op({
+    id: "email.sequence.enrollment.resume",
+    group: "email",
+    summary: "Resume one paused enrollment.",
+    cli: "dench email sequence enrollment resume",
+    method: "POST",
+    path: "/email/sequences/enrollments/{enrollmentId}/resume",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: convex("mutation", "functions/emailSequences:resumeEnrollment"),
+  }),
+  op({
+    id: "email.sequence.enrollment.stop",
+    group: "email",
+    summary: "Stop one enrollment (no further steps send).",
+    cli: "dench email sequence enrollment stop",
+    method: "POST",
+    path: "/email/sequences/enrollments/{enrollmentId}/stop",
+    requestSchema: anyObject,
+    responseSchema: anyResponse,
+    backend: convex("mutation", "functions/emailSequences:stopEnrollment"),
+  }),
 
   // Routines.
   op({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dench.com/cli",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "description": "Dench agent workspace CLI. v2 unifies auth behind `dench signin`; the legacy `dench login` / `dench onboard` / `dench setup` / `dench what-can-i-do` / `dench register` commands now error with a redirect.",
   "type": "module",
   "bin": {