fix(templates): resolve alias before opening a template in the dashboard (#411)

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Felipe Freitag <felipe.freitag@resend.com>

Author: 3 people

skills/resend-cli/references/templates.md

@@ -74,4 +74,4 @@ Same optional flags as `create` (including `--react-email`, `--text-file`, and `
 
 Open a template (or the templates list) in the Resend dashboard.
 
-**Argument:** `[id]` — Template ID (omit to open the list)
+**Argument:** `[id|alias]` — Template ID or alias (omit to open the list)

src/commands/templates/open.ts

@@ -1,25 +1,51 @@
 import { Command } from '@commander-js/extra-typings';
 import { openInBrowserOrLog, RESEND_URLS } from '../../lib/browser';
 import type { GlobalOpts } from '../../lib/client';
+import { requireClient } from '../../lib/client';
 import { buildHelpText } from '../../lib/help-text';
+import { withSpinner } from '../../lib/spinner';
+
+const UUID_PATTERN =
+  /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
 
 export const openTemplateCommand = new Command('open')
   .description('Open a template or the templates list in the Resend dashboard')
-  .argument('[id]', 'Template ID — omit to open the templates list')
+  .argument('[id]', 'Template ID or alias — omit to open the templates list')
   .addHelpText(
     'after',
     buildHelpText({
       context: `Opens the Resend dashboard in your default browser.
-  With an ID: opens that template's page for editing or viewing.
+  With an ID or alias: opens that template's page for editing or viewing.
   Without an ID: opens the templates list.`,
       examples: [
         'resend templates open',
         'resend templates open 78261eea-8f8b-4381-83c6-79fa7120f1cf',
+        'resend templates open my-template-alias',
       ],
     }),
   )
-  .action(async (id: string | undefined, _opts, cmd) => {
-    const url = id ? RESEND_URLS.template(id) : RESEND_URLS.templates;
+  .action(async (idOrAlias: string | undefined, _opts, cmd) => {
     const globalOpts = cmd.optsWithGlobals() as GlobalOpts;
-    await openInBrowserOrLog(url, globalOpts);
+    if (!idOrAlias) {
+      await openInBrowserOrLog(RESEND_URLS.templates, globalOpts);
+      return;
+    }
+
+    // The dashboard only routes template pages by ID, so an alias would 404.
+    const id = UUID_PATTERN.test(idOrAlias)
+      ? idOrAlias
+      : await resolveTemplateId(idOrAlias, globalOpts);
+    await openInBrowserOrLog(RESEND_URLS.template(id), globalOpts);
   });
+
+async function resolveTemplateId(alias: string, globalOpts: GlobalOpts) {
+  const resend = await requireClient(globalOpts);
+  const template = await withSpinner(
+    'Finding template...',
+    () => resend.templates.get(alias),
+    'fetch_error',
+    globalOpts,
+    { retryTransient: true },
+  );
+  return template.id;
+}

tests/commands/templates/open.test.ts

@@ -1,13 +1,39 @@
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import { openTemplateCommand } from '../../../src/commands/templates/open';
 import * as browser from '../../../src/lib/browser';
+import {
+  captureTestEnv,
+  expectExit1,
+  mockExitThrow,
+  setNonInteractive,
+  setupOutputSpies,
+} from '../../helpers';
+
+const templateId = '78261eea-8f8b-4381-83c6-79fa7120f1cf';
+
+const mockGet = vi.fn(async (_id: string) => ({
+  data: { object: 'template' as const, id: templateId },
+  error: null as { message: string } | null,
+}));
+
+vi.mock('resend', () => ({
+  Resend: class MockResend {
+    constructor(public key: string) {}
+    templates = { get: mockGet };
+  },
+}));
 
 describe('templates open command', () => {
+  const restoreEnv = captureTestEnv();
+
   beforeEach(() => {
+    process.env.RESEND_API_KEY = 're_test_key';
     vi.spyOn(browser, 'openInBrowserOrLog').mockResolvedValue();
+    mockGet.mockClear();
   });
 
   afterEach(() => {
+    restoreEnv();
     vi.restoreAllMocks();
   });
 
@@ -21,16 +47,38 @@ describe('templates open command', () => {
     );
   });
 
-  it('with id opens template URL', async () => {
-    await openTemplateCommand.parseAsync(
-      ['78261eea-8f8b-4381-83c6-79fa7120f1cf'],
-      { from: 'user' },
+  it('with id opens template URL without an API call', async () => {
+    await openTemplateCommand.parseAsync([templateId], { from: 'user' });
+
+    expect(mockGet).not.toHaveBeenCalled();
+    expect(browser.openInBrowserOrLog).toHaveBeenCalledWith(
+      browser.RESEND_URLS.template(templateId),
+      expect.any(Object),
     );
+  });
 
-    expect(browser.openInBrowserOrLog).toHaveBeenCalledTimes(1);
+  it('with alias opens the URL of the template it resolves to', async () => {
+    await openTemplateCommand.parseAsync(['welcome-email'], { from: 'user' });
+
+    expect(mockGet).toHaveBeenCalledWith('welcome-email');
     expect(browser.openInBrowserOrLog).toHaveBeenCalledWith(
-      browser.RESEND_URLS.template('78261eea-8f8b-4381-83c6-79fa7120f1cf'),
+      browser.RESEND_URLS.template(templateId),
       expect.any(Object),
     );
   });
+
+  it('with unknown alias exits without opening the browser', async () => {
+    setNonInteractive();
+    setupOutputSpies();
+    mockExitThrow();
+    mockGet.mockResolvedValueOnce({
+      data: null as never,
+      error: { message: 'Template not found' },
+    });
+
+    await expectExit1(() =>
+      openTemplateCommand.parseAsync(['missing-alias'], { from: 'user' }),
+    );
+    expect(browser.openInBrowserOrLog).not.toHaveBeenCalled();
+  });
 });