resend-cli 1.2.2 → 1.3.0

package/src/commands/contacts/update.ts

@@ -1,77 +0,0 @@
-import { Command } from '@commander-js/extra-typings';
-import type { UpdateContactOptions } from 'resend';
-import { runWrite } from '../../lib/actions';
-import type { GlobalOpts } from '../../lib/client';
-import { buildHelpText } from '../../lib/help-text';
-import { contactIdentifier, parsePropertiesJson } from './utils';
-
-export const updateContactCommand = new Command('update')
-  .description("Update a contact's subscription status or custom properties")
-  .argument(
-    '<id>',
-    'Contact UUID or email address — both are accepted by the API',
-  )
-  .option(
-    '--unsubscribed',
-    'Globally unsubscribe the contact from all broadcasts',
-  )
-  .option(
-    '--no-unsubscribed',
-    'Re-subscribe the contact (clears the global unsubscribe flag)',
-  )
-  .option(
-    '--properties <json>',
-    'JSON object of properties to merge (e.g. \'{"company":"Acme"}\'); set a key to null to clear it',
-  )
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `The <id> argument accepts either a UUID or an email address.
-
-Subscription toggle:
-  --unsubscribed   Sets unsubscribed: true  — contact will not receive any broadcasts.
-  --no-unsubscribed Sets unsubscribed: false — re-enables broadcast delivery.
-  Omitting both flags leaves the subscription status unchanged.
-
-Properties: --properties merges the given JSON object with existing properties.
-  Set a key to null to clear it: '{"company":null}'.`,
-      output: `  {"object":"contact","id":"<id>"}`,
-      errorCodes: ['auth_error', 'invalid_properties', 'update_error'],
-      examples: [
-        'resend contacts update 479e3145-dd38-4932-8c0c-e58b548c9e76 --unsubscribed',
-        'resend contacts update user@example.com --no-unsubscribed',
-        `resend contacts update 479e3145-dd38-4932-8c0c-e58b548c9e76 --properties '{"plan":"pro"}'`,
-        'resend contacts update user@example.com --unsubscribed --json',
-      ],
-    }),
-  )
-  .action(async (id, opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-
-    const properties = parsePropertiesJson(opts.properties, globalOpts);
-
-    // contactIdentifier resolves UUID vs email. The spread of a discriminated
-    // union requires an explicit cast because TypeScript cannot narrow it
-    // through a spread at the call site.
-    const payload = {
-      ...contactIdentifier(id),
-      ...(opts.unsubscribed !== undefined && {
-        unsubscribed: opts.unsubscribed,
-      }),
-      ...(properties && { properties }),
-    } as UpdateContactOptions;
-
-    await runWrite(
-      {
-        spinner: {
-          loading: 'Updating contact...',
-          success: 'Contact updated',
-          fail: 'Failed to update contact',
-        },
-        sdkCall: (resend) => resend.contacts.update(payload),
-        errorCode: 'update_error',
-        successMsg: `Contact updated: ${id}`,
-      },
-      globalOpts,
-    );
-  });

package/src/commands/contacts/utils.ts

@@ -1,119 +0,0 @@
-import type { ContactSegmentsBaseOptions, ContactTopic } from 'resend';
-import type { GlobalOpts } from '../../lib/client';
-import { outputError } from '../../lib/output';
-import { renderTable } from '../../lib/table';
-
-// ─── Table renderers ─────────────────────────────────────────────────────────
-
-export function renderContactsTable(
-  contacts: Array<{
-    id: string;
-    email: string;
-    first_name: string | null;
-    last_name: string | null;
-    unsubscribed: boolean;
-  }>,
-): string {
-  const rows = contacts.map((c) => [
-    c.email,
-    c.first_name ?? '',
-    c.last_name ?? '',
-    c.unsubscribed ? 'yes' : 'no',
-    c.id,
-  ]);
-  return renderTable(
-    ['Email', 'First Name', 'Last Name', 'Unsubscribed', 'ID'],
-    rows,
-    '(no contacts)',
-  );
-}
-
-export function renderContactTopicsTable(topics: ContactTopic[]): string {
-  const rows = topics.map((t) => [
-    t.name,
-    t.subscription,
-    t.id,
-    t.description ?? '',
-  ]);
-  return renderTable(
-    ['Name', 'Subscription', 'ID', 'Description'],
-    rows,
-    '(no topic subscriptions)',
-  );
-}
-
-// ─── Contact identifier helpers ───────────────────────────────────────────────
-//
-// The Resend SDK uses two different discriminated-union shapes depending on
-// the API surface:
-//
-//   • contactIdentifier  — produces { id } | { email } for endpoints that
-//     accept SelectingField (update, get, remove) or { id?, email? }
-//     (topics list/update).
-//
-//   • segmentContactIdentifier — produces { contactId } | { email } for the
-//     contacts.segments.* endpoints, which use ContactSegmentsBaseOptions.
-//
-// Centralising the `str.includes('@')` check here prevents it from drifting
-// across six separate command files.
-
-export function contactIdentifier(
-  id: string,
-): { id: string } | { email: string } {
-  return id.includes('@') ? { email: id } : { id };
-}
-
-export function segmentContactIdentifier(
-  id: string,
-): ContactSegmentsBaseOptions {
-  return id.includes('@') ? { email: id } : { contactId: id };
-}
-
-// ─── JSON flag helpers ────────────────────────────────────────────────────────
-
-export function parseTopicsJson(
-  raw: string,
-  globalOpts: GlobalOpts,
-): Array<{ id: string; subscription: 'opt_in' | 'opt_out' }> {
-  let parsed: unknown;
-  try {
-    parsed = JSON.parse(raw);
-  } catch {
-    outputError(
-      {
-        message:
-          'Invalid --topics JSON. Expected an array of {id, subscription} objects.',
-        code: 'invalid_topics',
-      },
-      { json: globalOpts.json },
-    );
-  }
-  if (!Array.isArray(parsed)) {
-    outputError(
-      {
-        message:
-          'Invalid --topics JSON. Expected an array of {id, subscription} objects.',
-        code: 'invalid_topics',
-      },
-      { json: globalOpts.json },
-    );
-  }
-  return parsed as Array<{ id: string; subscription: 'opt_in' | 'opt_out' }>;
-}
-
-export function parsePropertiesJson(
-  raw: string | undefined,
-  globalOpts: GlobalOpts,
-): Record<string, string | number | null> | undefined {
-  if (!raw) {
-    return undefined;
-  }
-  try {
-    return JSON.parse(raw) as Record<string, string | number | null>;
-  } catch {
-    outputError(
-      { message: 'Invalid --properties JSON.', code: 'invalid_properties' },
-      { json: globalOpts.json },
-    );
-  }
-}

package/src/commands/doctor.ts

@@ -1,216 +0,0 @@
-import { Command } from '@commander-js/extra-typings';
-import { Resend } from 'resend';
-import type { GlobalOpts } from '../lib/client';
-import { maskKey, resolveApiKey } from '../lib/config';
-import { buildHelpText } from '../lib/help-text';
-import { errorMessage, outputResult } from '../lib/output';
-import { createSpinner } from '../lib/spinner';
-import { isInteractive } from '../lib/tty';
-import { GITHUB_RELEASES_URL } from '../lib/update-check';
-import { VERSION } from '../lib/version';
-
-type CheckStatus = 'pass' | 'warn' | 'fail';
-
-type CheckResult = {
-  name: string;
-  status: CheckStatus;
-  message: string;
-  detail?: string;
-};
-
-async function checkCliVersion(): Promise<CheckResult> {
-  try {
-    const res = await fetch(GITHUB_RELEASES_URL, {
-      headers: { Accept: 'application/vnd.github.v3+json' },
-      signal: AbortSignal.timeout(5000),
-    });
-    if (!res.ok) {
-      return {
-        name: 'CLI Version',
-        status: 'warn',
-        message: `v${VERSION} (could not check for updates)`,
-      };
-    }
-    const data = (await res.json()) as {
-      tag_name?: string;
-      prerelease?: boolean;
-      draft?: boolean;
-    };
-    if (data.prerelease || data.draft) {
-      return {
-        name: 'CLI Version',
-        status: 'warn',
-        message: `v${VERSION} (could not check for updates)`,
-      };
-    }
-    const latest = data.tag_name?.replace(/^v/, '') ?? 'unknown';
-    if (latest === VERSION) {
-      return {
-        name: 'CLI Version',
-        status: 'pass',
-        message: `v${VERSION} (latest)`,
-      };
-    }
-    return {
-      name: 'CLI Version',
-      status: 'warn',
-      message: `v${VERSION} (latest: v${latest})`,
-      detail: 'Update available',
-    };
-  } catch {
-    return {
-      name: 'CLI Version',
-      status: 'warn',
-      message: `v${VERSION} (could not check for updates)`,
-    };
-  }
-}
-
-function checkApiKeyPresence(flagValue?: string): CheckResult {
-  const resolved = resolveApiKey(flagValue);
-  if (!resolved) {
-    return {
-      name: 'API Key',
-      status: 'fail',
-      message: 'No API key found',
-      detail: 'Run: resend login',
-    };
-  }
-  const teamInfo = resolved.team ? `, team: ${resolved.team}` : '';
-  return {
-    name: 'API Key',
-    status: 'pass',
-    message: `${maskKey(resolved.key)} (source: ${resolved.source}${teamInfo})`,
-  };
-}
-
-async function checkApiValidationAndDomains(
-  flagValue?: string,
-): Promise<CheckResult> {
-  const resolved = resolveApiKey(flagValue);
-  if (!resolved) {
-    return {
-      name: 'API Validation',
-      status: 'fail',
-      message: 'Skipped — no API key',
-    };
-  }
-
-  try {
-    const resend = new Resend(resolved.key);
-    const { data, error } = await resend.domains.list();
-
-    if (error) {
-      return {
-        name: 'API Validation',
-        status: 'fail',
-        message: `API key invalid: ${error.message}`,
-      };
-    }
-
-    const domains = data?.data ?? [];
-    const verified = domains.filter((d) => d.status === 'verified');
-    const pending = domains.filter((d) => d.status !== 'verified');
-
-    if (domains.length === 0) {
-      return {
-        name: 'Domains',
-        status: 'warn',
-        message: 'No domains configured',
-        detail: 'Add a domain at https://resend.com/domains',
-      };
-    }
-
-    if (verified.length === 0) {
-      return {
-        name: 'Domains',
-        status: 'warn',
-        message: `${pending.length} domain(s) pending verification`,
-        detail: domains.map((d) => `${d.name} (${d.status})`).join(', '),
-      };
-    }
-
-    return {
-      name: 'Domains',
-      status: 'pass',
-      message: `${verified.length} verified, ${pending.length} pending`,
-      detail: domains.map((d) => `${d.name} (${d.status})`).join(', '),
-    };
-  } catch (err) {
-    return {
-      name: 'API Validation',
-      status: 'fail',
-      message: errorMessage(err, 'Failed to validate API key'),
-    };
-  }
-}
-
-export const doctorCommand = new Command('doctor')
-  .description('Check CLI version, API key, and domain status')
-  .addHelpText(
-    'after',
-    buildHelpText({
-      setup: true,
-      context: `Checks performed:
-  CLI Version    Is the installed version up to date?
-  API Key        Is a key present (--api-key, RESEND_API_KEY, or credentials file)?
-  API Validation Is the key valid and accepted by the Resend API?`,
-      output: `  {\n    "ok": true,\n    "checks": [\n      {"name":"CLI Version","status":"pass","message":"v0.1.0 (latest)"},\n      {"name":"API Key","status":"pass","message":"re_...abcd (source: env)"},\n      {"name":"Domains","status":"pass","message":"1 verified, 0 pending"}\n    ]\n  }\n  status values: "pass" | "warn" | "fail"\n  Exit code 1 if any check has status "fail"`,
-      examples: ['resend doctor', 'resend doctor --json'],
-    }),
-  )
-  .action(async (_opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-    const checks: CheckResult[] = [];
-    const interactive = isInteractive() && !globalOpts.json;
-
-    if (interactive) {
-      console.log('\n  Resend Doctor\n');
-    }
-
-    // Check 1: CLI Version
-    let spinner = interactive ? createSpinner('Checking CLI version...') : null;
-    const versionCheck = await checkCliVersion();
-    checks.push(versionCheck);
-    if (versionCheck.status === 'warn') {
-      spinner?.warn(versionCheck.message);
-    } else {
-      spinner?.stop(versionCheck.message);
-    }
-
-    // Check 2: API Key
-    spinner = interactive ? createSpinner('Checking API key...') : null;
-    const keyCheck = checkApiKeyPresence(globalOpts.apiKey);
-    checks.push(keyCheck);
-    if (keyCheck.status === 'fail') {
-      spinner?.fail(keyCheck.message);
-    } else {
-      spinner?.stop(keyCheck.message);
-    }
-
-    // Check 3: API Validation + Domains
-    spinner = interactive
-      ? createSpinner('Validating API key & domains...')
-      : null;
-    const domainCheck = await checkApiValidationAndDomains(globalOpts.apiKey);
-    checks.push(domainCheck);
-    if (domainCheck.status === 'fail') {
-      spinner?.fail(domainCheck.message);
-    } else if (domainCheck.status === 'warn') {
-      spinner?.warn(domainCheck.message);
-    } else {
-      spinner?.stop(domainCheck.message);
-    }
-
-    const hasFails = checks.some((c) => c.status === 'fail');
-
-    if (!globalOpts.json && isInteractive()) {
-      console.log('');
-    } else {
-      outputResult({ ok: !hasFails, checks }, { json: globalOpts.json });
-    }
-
-    if (hasFails) {
-      process.exit(1);
-    }
-  });

package/src/commands/domains/create.ts

@@ -1,83 +0,0 @@
-import { Command, Option } from '@commander-js/extra-typings';
-import { runCreate } from '../../lib/actions';
-import type { GlobalOpts } from '../../lib/client';
-import { buildHelpText } from '../../lib/help-text';
-import { requireText } from '../../lib/prompts';
-import { renderDnsRecordsTable } from './utils';
-
-export const createDomainCommand = new Command('create')
-  .description('Create a new domain and receive DNS records to configure')
-  .option('--name <domain>', 'Domain name (e.g. example.com)')
-  .addOption(
-    new Option('--region <region>', 'Sending region').choices([
-      'us-east-1',
-      'eu-west-1',
-      'sa-east-1',
-      'ap-northeast-1',
-    ] as const),
-  )
-  .addOption(
-    new Option('--tls <mode>', 'TLS mode (default: opportunistic)').choices([
-      'opportunistic',
-      'enforced',
-    ] as const),
-  )
-  .option('--sending', 'Enable sending capability (default: enabled)')
-  .option('--receiving', 'Enable receiving capability (default: disabled)')
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context:
-        'Non-interactive: --name is required (no prompts when stdin/stdout is not a TTY)',
-      output:
-        '  Full domain object with DNS records array to configure in your DNS provider.',
-      errorCodes: ['auth_error', 'missing_name', 'create_error'],
-      examples: [
-        'resend domains create --name example.com',
-        'resend domains create --name example.com --region eu-west-1 --tls enforced',
-        'resend domains create --name example.com --receiving --json',
-        'resend domains create --name example.com --sending --receiving --json',
-      ],
-    }),
-  )
-  .action(async (opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-
-    const name = await requireText(
-      opts.name,
-      { message: 'Domain name', placeholder: 'example.com' },
-      { message: 'Missing --name flag.', code: 'missing_name' },
-      globalOpts,
-    );
-
-    await runCreate(
-      {
-        spinner: {
-          loading: 'Creating domain...',
-          success: 'Domain created',
-          fail: 'Failed to create domain',
-        },
-        sdkCall: (resend) =>
-          resend.domains.create({
-            name,
-            ...(opts.region && { region: opts.region }),
-            ...(opts.tls && { tls: opts.tls }),
-            ...((opts.sending || opts.receiving) && {
-              capabilities: {
-                ...(opts.sending && { sending: 'enabled' as const }),
-                ...(opts.receiving && { receiving: 'enabled' as const }),
-              },
-            }),
-          }),
-        onInteractive: (d) => {
-          console.log(`\nDomain created: ${d.name} (id: ${d.id})`);
-          console.log('\nDNS Records to configure:');
-          console.log(renderDnsRecordsTable(d.records, d.name));
-          console.log(
-            `\nRun \`resend domains verify ${d.id}\` after configuring DNS.`,
-          );
-        },
-      },
-      globalOpts,
-    );
-  });

package/src/commands/domains/delete.ts

@@ -1,42 +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 deleteDomainCommand = new Command('delete')
-  .alias('rm')
-  .description('Delete a domain')
-  .argument('<id>', 'Domain ID')
-  .option('--yes', 'Skip confirmation prompt')
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context:
-        'Non-interactive: --yes is required to confirm deletion when stdin/stdout is not a TTY.',
-      output: '  {"object":"domain","id":"<id>","deleted":true}',
-      errorCodes: ['auth_error', 'confirmation_required', 'delete_error'],
-      examples: [
-        'resend domains delete 4dd369bc-aa82-4ff3-97de-514ae3000ee0 --yes',
-        'resend domains delete 4dd369bc-aa82-4ff3-97de-514ae3000ee0 --yes --json',
-      ],
-    }),
-  )
-  .action(async (id, opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-    await runDelete(
-      id,
-      !!opts.yes,
-      {
-        confirmMessage: `Delete domain ${id}?\nThis cannot be undone.`,
-        spinner: {
-          loading: 'Deleting domain...',
-          success: 'Domain deleted',
-          fail: 'Failed to delete domain',
-        },
-        object: 'domain',
-        successMsg: 'Domain deleted.',
-        sdkCall: (resend) => resend.domains.remove(id),
-      },
-      globalOpts,
-    );
-  });

package/src/commands/domains/get.ts

@@ -1,47 +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 { renderDnsRecordsTable, statusIndicator } from './utils';
-
-export const getDomainCommand = new Command('get')
-  .description(
-    'Retrieve a domain with its DNS records and current verification status',
-  )
-  .argument('<id>', 'Domain ID')
-  .addHelpText(
-    'after',
-    buildHelpText({
-      output:
-        '  Full domain object including records array and current status.\n\nDomain status values: not_started | pending | verified | failed | temporary_failure',
-      errorCodes: ['auth_error', 'fetch_error'],
-      examples: [
-        'resend domains get 4dd369bc-aa82-4ff3-97de-514ae3000ee0',
-        'resend domains get 4dd369bc-aa82-4ff3-97de-514ae3000ee0 --json',
-      ],
-    }),
-  )
-  .action(async (id, _opts, cmd) => {
-    const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-    await runGet(
-      {
-        spinner: {
-          loading: 'Fetching domain...',
-          success: 'Domain fetched',
-          fail: 'Failed to fetch domain',
-        },
-        sdkCall: (resend) => resend.domains.get(id),
-        onInteractive: (d) => {
-          console.log(`\n${d.name} — ${statusIndicator(d.status)}`);
-          console.log(`ID: ${d.id}`);
-          console.log(`Region: ${d.region}`);
-          console.log(`Created: ${d.created_at}`);
-          if (d.records.length > 0) {
-            console.log('\nDNS Records:');
-            console.log(renderDnsRecordsTable(d.records, d.name));
-          }
-        },
-      },
-      globalOpts,
-    );
-  });

package/src/commands/domains/index.ts

@@ -1,35 +0,0 @@
-import { Command } from '@commander-js/extra-typings';
-import { buildHelpText } from '../../lib/help-text';
-import { createDomainCommand } from './create';
-import { deleteDomainCommand } from './delete';
-import { getDomainCommand } from './get';
-import { listDomainsCommand } from './list';
-import { updateDomainCommand } from './update';
-import { verifyDomainCommand } from './verify';
-
-export const domainsCommand = new Command('domains')
-  .description('Manage verified sending and receiving domains')
-  .addHelpText(
-    'after',
-    buildHelpText({
-      context: `Domain lifecycle:
-  1. resend domains create --name example.com    (get DNS records)
-  2. Configure DNS records at your DNS provider
-  3. resend domains verify <id>                  (trigger verification)
-  4. resend domains get <id>                     (poll until "verified")`,
-      examples: [
-        'resend domains list',
-        'resend domains create --name example.com --region us-east-1',
-        'resend domains verify 4dd369bc-aa82-4ff3-97de-514ae3000ee0',
-        'resend domains get 4dd369bc-aa82-4ff3-97de-514ae3000ee0',
-        'resend domains update <id> --tls enforced --open-tracking',
-        'resend domains delete <id> --yes',
-      ],
-    }),
-  )
-  .addCommand(createDomainCommand)
-  .addCommand(verifyDomainCommand)
-  .addCommand(getDomainCommand)
-  .addCommand(listDomainsCommand, { isDefault: true })
-  .addCommand(updateDomainCommand)
-  .addCommand(deleteDomainCommand);

package/src/commands/domains/list.ts

@@ -1,53 +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 { renderDomainsTable } from './utils';
-
-export const listDomainsCommand = new Command('list')
-  .alias('ls')
-  .description('List all domains')
-  .option('--limit <n>', 'Maximum number of domains to return (1-100)', '10')
-  .option('--after <cursor>', 'Return domains after this cursor (next page)')
-  .option(
-    '--before <cursor>',
-    'Return domains before this cursor (previous page)',
-  )
-  .addHelpText(
-    'after',
-    buildHelpText({
-      output:
-        '  {"object":"list","data":[...],"has_more":true}\n  The list response does not include DNS records — use "resend domains get <id>" for that.',
-      errorCodes: ['auth_error', 'invalid_limit', 'list_error'],
-      examples: [
-        'resend domains list',
-        'resend domains list --limit 25 --json',
-        'resend domains list --after <cursor> --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 domains...',
-          success: 'Domains fetched',
-          fail: 'Failed to list domains',
-        },
-        sdkCall: (resend) => resend.domains.list(paginationOpts),
-        onInteractive: (list) => {
-          console.log(renderDomainsTable(list.data));
-          printPaginationHint(list);
-        },
-      },
-      globalOpts,
-    );
-  });