npm - resend-cli - Versions diffs - 1.2.1 → 1.3.0 - Mend

resend-cli 1.2.1 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (357) hide show

package/src/commands/broadcasts/create.ts DELETED Viewed

@@ -1,196 +0,0 @@
-import * as p from '@clack/prompts';
-import { Command } from '@commander-js/extra-typings';
-import type { CreateBroadcastOptions } from 'resend';
-import { runCreate } from '../../lib/actions';
-import type { GlobalOpts } from '../../lib/client';
-import { readFile } from '../../lib/files';
-import { buildHelpText } from '../../lib/help-text';
-import { outputError } from '../../lib/output';
-import { cancelAndExit } from '../../lib/prompts';
-import { isInteractive } from '../../lib/tty';
-export const createBroadcastCommand = new Command('create')
-  .description('Create a broadcast draft (or send immediately with --send)')
-  .option('--from <address>', 'Sender address — required')
-  .option('--subject <subject>', 'Email subject — required')
-  .option('--segment-id <id>', 'Target segment ID — required')
-  .option(
-    '--html <html>',
-    'HTML body (supports {{{FIRST_NAME|fallback}}} triple-brace variable interpolation)',
-  )
-  .option(
-    '--html-file <path>',
-    'Path to an HTML file for the body (supports {{{FIRST_NAME|fallback}}} variable interpolation)',
-  )
-  .option('--text <text>', 'Plain-text body')
-  .option('--name <name>', 'Internal label for the broadcast (optional)')
-  .option('--reply-to <address>', 'Reply-to address (optional)')
-  .option(
-    '--preview-text <text>',
-    'Preview text shown in inbox below the subject line (optional)',
-  )
-  .option(
-    '--topic-id <id>',
-    'Associate with a topic for subscription filtering (optional)',
-  )
-  .option('--send', 'Send immediately on create instead of saving as draft')
-  .option(
-    '--scheduled-at <datetime>',
-    'Schedule delivery — ISO 8601 or natural language e.g. "in 1 hour", "tomorrow at 9am ET" (only valid with --send)',
-  )
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `Non-interactive: --from, --subject, and --segment-id are required.
-Body: provide exactly one of --html, --html-file, or --text.
-Variable interpolation:
-  HTML bodies support triple-brace syntax for contact properties.
-  Example: {{{FIRST_NAME|Friend}}} — uses FIRST_NAME or falls back to "Friend".
-Scheduling:
-  Use --scheduled-at with --send to schedule delivery.
-  Accepts ISO 8601 (e.g. 2026-08-05T11:52:01Z) or natural language (e.g. "in 1 hour").
-  --scheduled-at without --send is ignored.`,
-      output: `  {"id":"<broadcast-id>"}`,
-      errorCodes: [
-        'auth_error',
-        'missing_from',
-        'missing_subject',
-        'missing_segment',
-        'missing_body',
-        'file_read_error',
-        'create_error',
-      ],
-      examples: [
-        'resend broadcasts create --from hello@domain.com --subject "Weekly Update" --segment-id 7b1e0a3d-4c5f-4e8a-9b2d-1a3c5e7f9b2d --html "<p>Hello {{{FIRST_NAME|there}}}</p>"',
-        'resend broadcasts create --from hello@domain.com --subject "Launch" --segment-id 7b1e0a3d-4c5f-4e8a-9b2d-1a3c5e7f9b2d --html-file ./email.html --send',
-        'resend broadcasts create --from hello@domain.com --subject "Launch" --segment-id 7b1e0a3d-4c5f-4e8a-9b2d-1a3c5e7f9b2d --text "Hello!" --send --scheduled-at "tomorrow at 9am ET"',
-        'resend broadcasts create --from hello@domain.com --subject "News" --segment-id 7b1e0a3d-4c5f-4e8a-9b2d-1a3c5e7f9b2d --html "<p>Hi</p>" --json',
-      ],
-    }),
-  )
-  .action(async (opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-    let from = opts.from;
-    let subject = opts.subject;
-    let segmentId = opts.segmentId;
-    if (!from) {
-      if (!isInteractive()) {
-        outputError(
-          { message: 'Missing --from flag.', code: 'missing_from' },
-          { json: globalOpts.json },
-        );
-      }
-      const result = await p.text({
-        message: 'From address',
-        placeholder: 'hello@domain.com',
-        validate: (v) => (!v ? 'Required' : undefined),
-      });
-      if (p.isCancel(result)) {
-        cancelAndExit('Cancelled.');
-      }
-      from = result;
-    }
-    if (!subject) {
-      if (!isInteractive()) {
-        outputError(
-          { message: 'Missing --subject flag.', code: 'missing_subject' },
-          { json: globalOpts.json },
-        );
-      }
-      const result = await p.text({
-        message: 'Subject',
-        placeholder: 'Weekly Newsletter',
-        validate: (v) => (!v ? 'Required' : undefined),
-      });
-      if (p.isCancel(result)) {
-        cancelAndExit('Cancelled.');
-      }
-      subject = result;
-    }
-    if (!segmentId) {
-      if (!isInteractive()) {
-        outputError(
-          { message: 'Missing --segment-id flag.', code: 'missing_segment' },
-          { json: globalOpts.json },
-        );
-      }
-      const result = await p.text({
-        message: 'Segment ID',
-        placeholder: '7b1e0a3d-4c5f-4e8a-9b2d-1a3c5e7f9b2d',
-        validate: (v) => (!v ? 'Required' : undefined),
-      });
-      if (p.isCancel(result)) {
-        cancelAndExit('Cancelled.');
-      }
-      segmentId = result;
-    }
-    let html = opts.html;
-    let text = opts.text;
-    if (opts.htmlFile) {
-      html = readFile(opts.htmlFile, globalOpts);
-    }
-    if (!html && !text) {
-      if (!isInteractive()) {
-        outputError(
-          {
-            message: 'Missing body. Provide --html, --html-file, or --text.',
-            code: 'missing_body',
-          },
-          { json: globalOpts.json },
-        );
-      }
-      const result = await p.text({
-        message: 'Body (plain text)',
-        placeholder: 'Hello {{{FIRST_NAME|there}}}!',
-        validate: (v) => (!v ? 'Required' : undefined),
-      });
-      if (p.isCancel(result)) {
-        cancelAndExit('Cancelled.');
-      }
-      text = result;
-    }
-    await runCreate(
-      {
-        spinner: {
-          loading: 'Creating broadcast...',
-          success: opts.send ? 'Broadcast sent' : 'Broadcast created',
-          fail: 'Failed to create broadcast',
-        },
-        sdkCall: (resend) =>
-          resend.broadcasts.create({
-            from,
-            subject,
-            segmentId,
-            ...(html && { html }),
-            ...(text && { text }),
-            ...(opts.name && { name: opts.name }),
-            ...(opts.replyTo && { replyTo: opts.replyTo }),
-            ...(opts.previewText && { previewText: opts.previewText }),
-            ...(opts.topicId && { topicId: opts.topicId }),
-            ...(opts.send && { send: true as const }),
-            ...(opts.send &&
-              opts.scheduledAt && { scheduledAt: opts.scheduledAt }),
-          } as CreateBroadcastOptions),
-        onInteractive: (d) => {
-          if (opts.send) {
-            console.log(`\nBroadcast sent: ${d.id}`);
-          } else {
-            console.log(`\nBroadcast created: ${d.id}`);
-            console.log('Status: draft');
-            console.log(`\nSend it with: resend broadcasts send ${d.id}`);
-          }
-        },
-      },
-      globalOpts,
-    );
-  });

package/src/commands/broadcasts/delete.ts DELETED Viewed

@@ -1,46 +0,0 @@
-import { Command } from '@commander-js/extra-typings';
-import { runDelete } from '../../lib/actions';
-import type { GlobalOpts } from '../../lib/client';
-import { buildHelpText } from '../../lib/help-text';
-export const deleteBroadcastCommand = new Command('delete')
-  .alias('rm')
-  .description(
-    'Delete a broadcast — draft broadcasts are removed; scheduled broadcasts are cancelled before delivery',
-  )
-  .argument('<id>', 'Broadcast ID')
-  .option('--yes', 'Skip confirmation prompt')
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `Warning: Deleting a scheduled broadcast cancels its delivery immediately.
-Only draft and scheduled broadcasts can be deleted; sent broadcasts cannot.
-Non-interactive: --yes is required to confirm deletion when stdin/stdout is not a TTY.`,
-      output: `  {"object":"broadcast","id":"<id>","deleted":true}`,
-      errorCodes: ['auth_error', 'confirmation_required', 'delete_error'],
-      examples: [
-        'resend broadcasts delete d1c2b3a4-5e6f-7a8b-9c0d-e1f2a3b4c5d6 --yes',
-        'resend broadcasts delete d1c2b3a4-5e6f-7a8b-9c0d-e1f2a3b4c5d6 --yes --json',
-      ],
-    }),
-  )
-  .action(async (id, opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-    await runDelete(
-      id,
-      !!opts.yes,
-      {
-        confirmMessage: `Delete broadcast ${id}?\nIf scheduled, delivery will be cancelled.`,
-        spinner: {
-          loading: 'Deleting broadcast...',
-          success: 'Broadcast deleted',
-          fail: 'Failed to delete broadcast',
-        },
-        object: 'broadcast',
-        successMsg: 'Broadcast deleted.',
-        sdkCall: (resend) => resend.broadcasts.remove(id),
-      },
-      globalOpts,
-    );
-  });

package/src/commands/broadcasts/get.ts DELETED Viewed

@@ -1,59 +0,0 @@
-import { Command } from '@commander-js/extra-typings';
-import { runGet } from '../../lib/actions';
-import type { GlobalOpts } from '../../lib/client';
-import { buildHelpText } from '../../lib/help-text';
-import { broadcastStatusIndicator } from './utils';
-export const getBroadcastCommand = new Command('get')
-  .description(
-    'Retrieve full details for a broadcast including HTML body, status, and delivery times',
-  )
-  .argument('<id>', 'Broadcast ID')
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `Note: The list command returns summary objects without html/text/from/subject.
-Use this command to retrieve the full broadcast payload.`,
-      output: `  {"id":"...","object":"broadcast","name":"...","segment_id":"...","from":"...","subject":"...","status":"draft|queued|sent","created_at":"...","scheduled_at":null,"sent_at":null}`,
-      errorCodes: ['auth_error', 'fetch_error'],
-      examples: [
-        'resend broadcasts get d1c2b3a4-5e6f-7a8b-9c0d-e1f2a3b4c5d6',
-        'resend broadcasts get d1c2b3a4-5e6f-7a8b-9c0d-e1f2a3b4c5d6 --json',
-      ],
-    }),
-  )
-  .action(async (id, _opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-    await runGet(
-      {
-        spinner: {
-          loading: 'Fetching broadcast...',
-          success: 'Broadcast fetched',
-          fail: 'Failed to fetch broadcast',
-        },
-        sdkCall: (resend) => resend.broadcasts.get(id),
-        onInteractive: (b) => {
-          console.log(`\nBroadcast: ${b.id}`);
-          console.log(`  Status:      ${broadcastStatusIndicator(b.status)}`);
-          console.log(`  Name:        ${b.name ?? '(untitled)'}`);
-          console.log(`  From:        ${b.from ?? '—'}`);
-          console.log(`  Subject:     ${b.subject ?? '—'}`);
-          console.log(`  Segment:     ${b.segment_id ?? '—'}`);
-          if (b.preview_text) {
-            console.log(`  Preview:     ${b.preview_text}`);
-          }
-          if (b.topic_id) {
-            console.log(`  Topic:       ${b.topic_id}`);
-          }
-          console.log(`  Created:     ${b.created_at}`);
-          if (b.scheduled_at) {
-            console.log(`  Scheduled:   ${b.scheduled_at}`);
-          }
-          if (b.sent_at) {
-            console.log(`  Sent:        ${b.sent_at}`);
-          }
-        },
-      },
-      globalOpts,
-    );
-  });

package/src/commands/broadcasts/index.ts DELETED Viewed

@@ -1,43 +0,0 @@
-import { Command } from '@commander-js/extra-typings';
-import { buildHelpText } from '../../lib/help-text';
-import { createBroadcastCommand } from './create';
-import { deleteBroadcastCommand } from './delete';
-import { getBroadcastCommand } from './get';
-import { listBroadcastsCommand } from './list';
-import { sendBroadcastCommand } from './send';
-import { updateBroadcastCommand } from './update';
-export const broadcastsCommand = new Command('broadcasts')
-  .description('Manage broadcasts — bulk email to a segment of contacts')
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `Lifecycle:
-  Broadcasts follow a draft → send flow:
-    1. create  — creates a draft (or sends immediately with --send)
-    2. send    — sends an API-created draft (dashboard broadcasts cannot be sent via API)
-  Scheduled broadcasts can be deleted to cancel delivery; sent broadcasts are immutable.
-Template variables:
-  HTML bodies support triple-brace interpolation for contact properties.
-  Example: {{{FIRST_NAME|Friend}}} — uses FIRST_NAME or falls back to "Friend".
-Scheduling:
-  --scheduled-at accepts ISO 8601 or natural language e.g. "in 1 hour", "tomorrow at 9am ET".`,
-      examples: [
-        'resend broadcasts list',
-        'resend broadcasts create --from hello@domain.com --subject "Launch" --segment-id 7b1e0a3d-4c5f-4e8a-9b2d-1a3c5e7f9b2d --html "<p>Hi {{{FIRST_NAME|there}}}</p>"',
-        'resend broadcasts send d1c2b3a4-5e6f-7a8b-9c0d-e1f2a3b4c5d6',
-        'resend broadcasts send d1c2b3a4-5e6f-7a8b-9c0d-e1f2a3b4c5d6 --scheduled-at "in 1 hour"',
-        'resend broadcasts get d1c2b3a4-5e6f-7a8b-9c0d-e1f2a3b4c5d6',
-        'resend broadcasts update d1c2b3a4-5e6f-7a8b-9c0d-e1f2a3b4c5d6 --subject "Updated Subject"',
-        'resend broadcasts delete d1c2b3a4-5e6f-7a8b-9c0d-e1f2a3b4c5d6 --yes',
-      ],
-    }),
-  )
-  .addCommand(createBroadcastCommand)
-  .addCommand(sendBroadcastCommand)
-  .addCommand(getBroadcastCommand)
-  .addCommand(listBroadcastsCommand, { isDefault: true })
-  .addCommand(updateBroadcastCommand)
-  .addCommand(deleteBroadcastCommand);

package/src/commands/broadcasts/list.ts DELETED Viewed

@@ -1,60 +0,0 @@
-import { Command } from '@commander-js/extra-typings';
-import { runList } from '../../lib/actions';
-import type { GlobalOpts } from '../../lib/client';
-import { buildHelpText } from '../../lib/help-text';
-import {
-  buildPaginationOpts,
-  parseLimitOpt,
-  printPaginationHint,
-} from '../../lib/pagination';
-import { renderBroadcastsTable } from './utils';
-export const listBroadcastsCommand = new Command('list')
-  .alias('ls')
-  .description(
-    'List broadcasts — returns summary objects (use "get <id>" for full details including html/text)',
-  )
-  .option('--limit <n>', 'Maximum number of results to return (1-100)', '10')
-  .option(
-    '--after <cursor>',
-    'Cursor for forward pagination — list items after this ID',
-  )
-  .option(
-    '--before <cursor>',
-    'Cursor for backward pagination — list items before this ID',
-  )
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `Note: List results include name, status, created_at, and id only.
-To retrieve full details (html, from, subject), use: resend broadcasts get <id>`,
-      output: `  {"object":"list","has_more":false,"data":[{"id":"...","name":"...","status":"draft|queued|sent","created_at":"..."}]}`,
-      errorCodes: ['auth_error', 'invalid_limit', 'list_error'],
-      examples: [
-        'resend broadcasts list',
-        'resend broadcasts list --limit 5',
-        'resend broadcasts list --after d1c2b3a4-5e6f-7a8b-9c0d-e1f2a3b4c5d6 --limit 10',
-        'resend broadcasts list --json',
-      ],
-    }),
-  )
-  .action(async (opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-    const limit = parseLimitOpt(opts.limit, globalOpts);
-    const paginationOpts = buildPaginationOpts(limit, opts.after, opts.before);
-    await runList(
-      {
-        spinner: {
-          loading: 'Fetching broadcasts...',
-          success: 'Broadcasts fetched',
-          fail: 'Failed to list broadcasts',
-        },
-        sdkCall: (resend) => resend.broadcasts.list(paginationOpts),
-        onInteractive: (list) => {
-          console.log(renderBroadcastsTable(list.data));
-          printPaginationHint(list);
-        },
-      },
-      globalOpts,
-    );
-  });

package/src/commands/broadcasts/send.ts DELETED Viewed

@@ -1,56 +0,0 @@
-import { Command } from '@commander-js/extra-typings';
-import { runWrite } from '../../lib/actions';
-import type { GlobalOpts } from '../../lib/client';
-import { buildHelpText } from '../../lib/help-text';
-export const sendBroadcastCommand = new Command('send')
-  .description(
-    'Send a draft broadcast (API-created drafts only — dashboard broadcasts cannot be sent via API)',
-  )
-  .argument('<id>', 'Broadcast ID')
-  .option(
-    '--scheduled-at <datetime>',
-    'Schedule delivery — ISO 8601 or natural language e.g. "in 1 hour", "tomorrow at 9am ET"',
-  )
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `Note: Only broadcasts created via the API can be sent via this command.
-Broadcasts created in the Resend dashboard cannot be sent programmatically.
-Scheduling:
-  --scheduled-at accepts ISO 8601 (e.g. 2026-08-05T11:52:01Z) or
-  natural language (e.g. "in 1 hour", "tomorrow at 9am ET").`,
-      output: `  {"id":"<broadcast-id>"}`,
-      errorCodes: ['auth_error', 'send_error'],
-      examples: [
-        'resend broadcasts send d1c2b3a4-5e6f-7a8b-9c0d-e1f2a3b4c5d6',
-        'resend broadcasts send d1c2b3a4-5e6f-7a8b-9c0d-e1f2a3b4c5d6 --scheduled-at "in 1 hour"',
-        'resend broadcasts send d1c2b3a4-5e6f-7a8b-9c0d-e1f2a3b4c5d6 --scheduled-at "2026-08-05T11:52:01Z" --json',
-      ],
-    }),
-  )
-  .action(async (id, opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-    const successMsg = opts.scheduledAt
-      ? `\nBroadcast scheduled: ${id} (sends: ${opts.scheduledAt})`
-      : `\nBroadcast sent: ${id}`;
-    await runWrite(
-      {
-        spinner: {
-          loading: 'Sending broadcast...',
-          success: 'Broadcast sent',
-          fail: 'Failed to send broadcast',
-        },
-        sdkCall: (resend) =>
-          resend.broadcasts.send(id, {
-            ...(opts.scheduledAt && { scheduledAt: opts.scheduledAt }),
-          }),
-        errorCode: 'send_error',
-        successMsg,
-      },
-      globalOpts,
-    );
-  });

package/src/commands/broadcasts/update.ts DELETED Viewed

@@ -1,95 +0,0 @@
-import { Command } from '@commander-js/extra-typings';
-import { runWrite } from '../../lib/actions';
-import type { GlobalOpts } from '../../lib/client';
-import { readFile } from '../../lib/files';
-import { buildHelpText } from '../../lib/help-text';
-import { outputError } from '../../lib/output';
-export const updateBroadcastCommand = new Command('update')
-  .description(
-    'Update a draft broadcast — only drafts can be updated; sent broadcasts are immutable',
-  )
-  .argument('<id>', 'Broadcast ID')
-  .option('--from <address>', 'Update sender address')
-  .option('--subject <subject>', 'Update subject')
-  .option(
-    '--html <html>',
-    'Update HTML body (supports {{{FIRST_NAME|fallback}}} variable interpolation)',
-  )
-  .option(
-    '--html-file <path>',
-    'Path to an HTML file to replace the body (supports {{{FIRST_NAME|fallback}}} variable interpolation)',
-  )
-  .option('--text <text>', 'Update plain-text body')
-  .option('--name <name>', 'Update internal label')
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `Note: Only draft broadcasts can be updated.
-If the broadcast is already sent or sending, the API will return an error.
-Variable interpolation:
-  HTML bodies support triple-brace syntax for contact properties.
-  Example: {{{FIRST_NAME|Friend}}} — uses FIRST_NAME or falls back to "Friend".`,
-      output: `  {"id":"<broadcast-id>"}`,
-      errorCodes: [
-        'auth_error',
-        'no_changes',
-        'file_read_error',
-        'update_error',
-      ],
-      examples: [
-        'resend broadcasts update d1c2b3a4-5e6f-7a8b-9c0d-e1f2a3b4c5d6 --subject "Updated Subject"',
-        'resend broadcasts update d1c2b3a4-5e6f-7a8b-9c0d-e1f2a3b4c5d6 --html-file ./new-email.html',
-        'resend broadcasts update d1c2b3a4-5e6f-7a8b-9c0d-e1f2a3b4c5d6 --name "Q1 Newsletter" --from "news@domain.com" --json',
-      ],
-    }),
-  )
-  .action(async (id, opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-    if (
-      !opts.from &&
-      !opts.subject &&
-      !opts.html &&
-      !opts.htmlFile &&
-      !opts.text &&
-      !opts.name
-    ) {
-      outputError(
-        {
-          message:
-            'Provide at least one option to update: --from, --subject, --html, --html-file, --text, or --name.',
-          code: 'no_changes',
-        },
-        { json: globalOpts.json },
-      );
-    }
-    let html = opts.html;
-    if (opts.htmlFile) {
-      html = readFile(opts.htmlFile, globalOpts);
-    }
-    await runWrite(
-      {
-        spinner: {
-          loading: 'Updating broadcast...',
-          success: 'Broadcast updated',
-          fail: 'Failed to update broadcast',
-        },
-        sdkCall: (resend) =>
-          resend.broadcasts.update(id, {
-            ...(opts.from && { from: opts.from }),
-            ...(opts.subject && { subject: opts.subject }),
-            ...(html && { html }),
-            ...(opts.text && { text: opts.text }),
-            ...(opts.name && { name: opts.name }),
-          }),
-        errorCode: 'update_error',
-        successMsg: `\nBroadcast updated: ${id}`,
-      },
-      globalOpts,
-    );
-  });

package/src/commands/broadcasts/utils.ts DELETED Viewed

@@ -1,35 +0,0 @@
-import { renderTable } from '../../lib/table';
-export function broadcastStatusIndicator(status: string): string {
-  switch (status) {
-    case 'draft':
-      return '○ Draft';
-    case 'queued':
-      return '⏳ Queued';
-    case 'sent':
-      return '✓ Sent';
-    default:
-      return status;
-  }
-}
-export function renderBroadcastsTable(
-  broadcasts: Array<{
-    id: string;
-    name: string | null;
-    status: string;
-    created_at: string;
-  }>,
-): string {
-  const rows = broadcasts.map((b) => [
-    b.name ?? '(untitled)',
-    b.status,
-    b.created_at,
-    b.id,
-  ]);
-  return renderTable(
-    ['Name', 'Status', 'Created', 'ID'],
-    rows,
-    '(no broadcasts)',
-  );
-}