Merge pull request #51 from muxinc/dj/missing-api-endpoints

Add all missing Mux API operations to CLI

Author: dylanjha

README.md

@@ -0,0 +1,43 @@
+import { describe, expect, test } from 'bun:test';
+import { createCommand } from './create.ts';
+
+// Note: These tests focus on CLI flag parsing and command structure
+// They do NOT test the actual Mux API integration (that's tested via E2E)
+
+describe('mux annotations create command', () => {
+  describe('Command metadata', () => {
+    test('has correct command description', () => {
+      expect(createCommand.getDescription()).toMatch(/annotation/i);
+    });
+  });
+
+  describe('Optional flags', () => {
+    test('has --date flag for specifying annotation date', () => {
+      const dateOption = createCommand
+        .getOptions()
+        .find((opt) => opt.name === 'date');
+      expect(dateOption).toBeDefined();
+    });
+
+    test('has --note flag for specifying annotation note', () => {
+      const noteOption = createCommand
+        .getOptions()
+        .find((opt) => opt.name === 'note');
+      expect(noteOption).toBeDefined();
+    });
+
+    test('has --sub-property-id flag for specifying sub-property', () => {
+      const subPropertyIdOption = createCommand
+        .getOptions()
+        .find((opt) => opt.name === 'sub-property-id');
+      expect(subPropertyIdOption).toBeDefined();
+    });
+
+    test('has --json flag for output formatting', () => {
+      const jsonOption = createCommand
+        .getOptions()
+        .find((opt) => opt.name === 'json');
+      expect(jsonOption).toBeDefined();
+    });
+  });
+});

src/commands/annotations/create.test.ts

@@ -0,0 +1,57 @@
+import { Command } from '@cliffy/command';
+import { createAuthenticatedMuxClient } from '../../lib/mux.ts';
+
+interface CreateOptions {
+  date: number;
+  note: string;
+  subPropertyId?: string;
+  json?: boolean;
+}
+
+export const createCommand = new Command()
+  .description('Create a new annotation in Mux Data')
+  .option('--date <date:number>', 'Unix timestamp for the annotation date', {
+    required: true,
+  })
+  .option('--note <note:string>', 'Note text for the annotation', {
+    required: true,
+  })
+  .option(
+    '--sub-property-id <subPropertyId:string>',
+    'Sub-property ID to associate with the annotation',
+  )
+  .option('--json', 'Output JSON instead of pretty format')
+  .action(async (options: CreateOptions) => {
+    try {
+      const mux = await createAuthenticatedMuxClient();
+
+      const body: Record<string, unknown> = {
+        date: options.date,
+        note: options.note,
+      };
+
+      if (options.subPropertyId) {
+        body.sub_property_id = options.subPropertyId;
+      }
+
+      const annotation = await mux.data.annotations.create(body as never);
+
+      if (options.json) {
+        console.log(JSON.stringify(annotation, null, 2));
+      } else {
+        console.log(`Annotation ID: ${annotation.id}`);
+        console.log(`  Date: ${annotation.date}`);
+        console.log(`  Note: ${annotation.note}`);
+      }
+    } catch (error) {
+      const errorMessage =
+        error instanceof Error ? error.message : String(error);
+
+      if (options.json) {
+        console.error(JSON.stringify({ error: errorMessage }, null, 2));
+      } else {
+        console.error(`Error: ${errorMessage}`);
+      }
+      process.exit(1);
+    }
+  });

src/commands/annotations/create.ts

@@ -0,0 +1,72 @@
+import {
+  afterEach,
+  beforeEach,
+  describe,
+  expect,
+  type Mock,
+  spyOn,
+  test,
+} from 'bun:test';
+import { deleteCommand } from './delete.ts';
+
+// Note: These tests focus on CLI flag parsing and command structure
+// They do NOT test the actual Mux API integration (that's tested via E2E)
+
+describe('mux annotations delete command', () => {
+  let exitSpy: Mock<typeof process.exit>;
+  let consoleErrorSpy: Mock<typeof console.error>;
+
+  beforeEach(() => {
+    // Mock process.exit to prevent it from killing the test runner
+    exitSpy = spyOn(process, 'exit').mockImplementation((() => {
+      throw new Error('process.exit called');
+    }) as never);
+
+    // Spy on console.error to capture error messages
+    consoleErrorSpy = spyOn(console, 'error').mockImplementation(() => {});
+  });
+
+  afterEach(() => {
+    exitSpy?.mockRestore();
+    consoleErrorSpy?.mockRestore();
+  });
+
+  describe('Command metadata', () => {
+    test('has correct command description', () => {
+      expect(deleteCommand.getDescription()).toMatch(/annotation/i);
+    });
+
+    test('requires annotation-id argument', () => {
+      const args = deleteCommand.getArguments();
+      expect(args.length).toBeGreaterThan(0);
+      expect(args[0].name).toBe('annotation-id');
+    });
+  });
+
+  describe('Optional flags', () => {
+    test('has --force flag to skip confirmation', () => {
+      const forceOption = deleteCommand
+        .getOptions()
+        .find((opt) => opt.name === 'force');
+      expect(forceOption).toBeDefined();
+    });
+
+    test('has --json flag for output formatting', () => {
+      const jsonOption = deleteCommand
+        .getOptions()
+        .find((opt) => opt.name === 'json');
+      expect(jsonOption).toBeDefined();
+    });
+  });
+
+  describe('Input validation', () => {
+    test('throws error when annotation-id is not provided', async () => {
+      try {
+        await deleteCommand.parse([]);
+      } catch (_error) {
+        // Expected to throw
+      }
+      expect(exitSpy).toHaveBeenCalled();
+    });
+  });
+});

src/commands/annotations/delete.test.ts

@@ -0,0 +1,59 @@
+import { Command } from '@cliffy/command';
+import { createAuthenticatedMuxClient } from '../../lib/mux.ts';
+import { confirmPrompt } from '../../lib/prompt.ts';
+
+interface DeleteOptions {
+  force?: boolean;
+  json?: boolean;
+}
+
+export const deleteCommand = new Command()
+  .description(
+    'Permanently delete an annotation from Mux Data (cannot be undone)',
+  )
+  .arguments('<annotation-id:string>')
+  .option('-f, --force', 'Skip confirmation prompt')
+  .option('--json', 'Output JSON instead of pretty format')
+  .action(async (options: DeleteOptions, annotationId: string) => {
+    try {
+      const mux = await createAuthenticatedMuxClient();
+
+      // Confirm deletion unless --force flag is provided
+      if (!options.force) {
+        // For JSON mode, require explicit --force flag for safety
+        if (options.json) {
+          throw new Error(
+            'Deletion requires --force flag when using --json output',
+          );
+        }
+
+        const confirmed = await confirmPrompt({
+          message: `Are you sure you want to delete annotation ${annotationId}?`,
+          default: false,
+        });
+
+        if (!confirmed) {
+          console.log('Deletion cancelled.');
+          return;
+        }
+      }
+
+      await mux.data.annotations.delete(annotationId);
+
+      if (options.json) {
+        console.log(JSON.stringify({ success: true, annotationId }, null, 2));
+      } else {
+        console.log(`Annotation ${annotationId} deleted successfully.`);
+      }
+    } catch (error) {
+      const errorMessage =
+        error instanceof Error ? error.message : String(error);
+
+      if (options.json) {
+        console.error(JSON.stringify({ error: errorMessage }, null, 2));
+      } else {
+        console.error(`Error: ${errorMessage}`);
+      }
+      process.exit(1);
+    }
+  });

src/commands/annotations/delete.ts

@@ -0,0 +1,65 @@
+import {
+  afterEach,
+  beforeEach,
+  describe,
+  expect,
+  type Mock,
+  spyOn,
+  test,
+} from 'bun:test';
+import { getCommand } from './get.ts';
+
+// Note: These tests focus on CLI flag parsing and command structure
+// They do NOT test the actual Mux API integration (that's tested via E2E)
+
+describe('mux annotations get command', () => {
+  let exitSpy: Mock<typeof process.exit>;
+  let consoleErrorSpy: Mock<typeof console.error>;
+
+  beforeEach(() => {
+    // Mock process.exit to prevent it from killing the test runner
+    exitSpy = spyOn(process, 'exit').mockImplementation((() => {
+      throw new Error('process.exit called');
+    }) as never);
+
+    // Spy on console.error to capture error messages
+    consoleErrorSpy = spyOn(console, 'error').mockImplementation(() => {});
+  });
+
+  afterEach(() => {
+    exitSpy?.mockRestore();
+    consoleErrorSpy?.mockRestore();
+  });
+
+  describe('Command metadata', () => {
+    test('has correct command description', () => {
+      expect(getCommand.getDescription()).toMatch(/annotation/i);
+    });
+
+    test('requires annotation-id argument', () => {
+      const args = getCommand.getArguments();
+      expect(args.length).toBeGreaterThan(0);
+      expect(args[0].name).toBe('annotation-id');
+    });
+  });
+
+  describe('Optional flags', () => {
+    test('has --json flag for output formatting', () => {
+      const jsonOption = getCommand
+        .getOptions()
+        .find((opt) => opt.name === 'json');
+      expect(jsonOption).toBeDefined();
+    });
+  });
+
+  describe('Input validation', () => {
+    test('throws error when annotation-id is not provided', async () => {
+      try {
+        await getCommand.parse([]);
+      } catch (_error) {
+        // Expected to throw
+      }
+      expect(exitSpy).toHaveBeenCalled();
+    });
+  });
+});

src/commands/annotations/get.test.ts

@@ -0,0 +1,39 @@
+import { Command } from '@cliffy/command';
+import { createAuthenticatedMuxClient } from '../../lib/mux.ts';
+
+interface GetOptions {
+  json?: boolean;
+}
+
+export const getCommand = new Command()
+  .description('Get details about a specific annotation')
+  .arguments('<annotation-id:string>')
+  .option('--json', 'Output JSON instead of pretty format')
+  .action(async (options: GetOptions, annotationId: string) => {
+    try {
+      const mux = await createAuthenticatedMuxClient();
+
+      const annotation = await mux.data.annotations.retrieve(annotationId);
+
+      if (options.json) {
+        console.log(JSON.stringify(annotation, null, 2));
+      } else {
+        console.log(`Annotation ID: ${annotation.id}`);
+        console.log(`  Date: ${annotation.date ?? '-'}`);
+        console.log(`  Note: ${annotation.note ?? '-'}`);
+        if (annotation.sub_property_id) {
+          console.log(`  Sub-property ID: ${annotation.sub_property_id}`);
+        }
+      }
+    } catch (error) {
+      const errorMessage =
+        error instanceof Error ? error.message : String(error);
+
+      if (options.json) {
+        console.error(JSON.stringify({ error: errorMessage }, null, 2));
+      } else {
+        console.error(`Error: ${errorMessage}`);
+      }
+      process.exit(1);
+    }
+  });

src/commands/annotations/get.ts

@@ -0,0 +1,19 @@
+import { Command } from '@cliffy/command';
+import { createCommand } from './create.ts';
+import { deleteCommand } from './delete.ts';
+import { getCommand } from './get.ts';
+import { listCommand } from './list.ts';
+import { updateCommand } from './update.ts';
+
+export const annotationsCommand = new Command()
+  .description(
+    'Manage annotations (event markers for deployments, releases, etc.) in Mux Data',
+  )
+  .action(function () {
+    this.showHelp();
+  })
+  .command('create', createCommand)
+  .command('list', listCommand)
+  .command('get', getCommand)
+  .command('update', updateCommand)
+  .command('delete', deleteCommand);