@codepunter-labs/mock-brevo

Mock SDK for Brevo API (formerly Sendinblue). Provides fully-typed mock implementations for testing transactional email sending, templates, contacts, and webhooks without making real API calls.

Installation

npm install @codepunter-labs/mock-brevo

Features

• Email Sending: Send transactional emails with HTML, text, or templates
• Templates: Create, update, list, and delete email templates
• Contacts: Manage contacts with attributes and lists
• Webhooks: Create and manage webhooks for email events
• Type-safe: Full TypeScript support with accurate API types
• Test Framework Agnostic: Works with Jest, Vitest, and other spy-based frameworks

Repository

• GitHub: https://github.com/DERRICK-TORKORNOO/mock-sdks/tree/main/packages/mock-brevo
• Source Code: src/
• Tests: tests/

Usage

Basic Setup

import { vi } from 'vitest';
import { createMockBrevo } from '@codepunter-labs/mock-brevo';

const brevo = createMockBrevo({ spy: vi.fn });

Using with Jest

import { createMockBrevo } from '@codepunter-labs/mock-brevo';

const brevo = createMockBrevo({ spy: jest.fn });

Example: Send Email

// Default behavior - returns realistic mock data
const result = await brevo.sendEmail({
  sender: { email: '[email protected]', name: 'Sender' },
  to: [{ email: '[email protected]', name: 'Recipient' }],
  subject: 'Test Email',
  htmlContent: '<p>Hello World</p>'
});

Example: Send Email with Template

const result = await brevo.sendEmail({
  sender: { email: '[email protected]' },
  to: [{ email: '[email protected]' }],
  templateId: 1,
  params: { name: 'John', order: 12345 }
});

Example: Create Template

const result = await brevo.createTemplate({
  name: 'Welcome Email',
  subject: 'Welcome',
  htmlContent: '<h1>Welcome {{name}}</h1>'
});

Example: Create Contact

const result = await brevo.createContact({
  email: '[email protected]',
  attributes: { FIRSTNAME: 'John', LASTNAME: 'Doe' },
  listIds: [1]
});

Example: Override Mock Response

import { makeSendEmailResponse } from '@codepunter-labs/mock-brevo';

brevo.sendEmail.mockResolvedValue({
  code: 200,
  message: 'success',
  data: makeSendEmailResponse({ messageId: '<[email protected]>' })
});

Example: Error Simulation

import { MockErrors } from '@codepunter-labs/mock-core';

brevo.sendEmail.mockRejectedValue(
  MockErrors.badRequest('Invalid email address')
);

API Reference

MockBrevo

• sendEmail(request) - Send transactional email
• createTemplate(request) - Create email template
• updateTemplate(request) - Update email template
• getTemplate(templateId) - Get template details
• listTemplates() - List all templates
• deleteTemplate(templateId) - Delete template
• createContact(request) - Create contact
• updateContact(request) - Update contact
• getContact(email) - Get contact details
• listContacts() - List all contacts
• deleteContact(email) - Delete contact
• createWebhook(request) - Create webhook
• updateWebhook(request) - Update webhook
• getWebhook(id) - Get webhook details
• listWebhooks() - List all webhooks
• deleteWebhook(id) - Delete webhook

Fixture Factories

• makeEmailAddress(email, name?) - Create email address
• makeSendEmailResponse(options?) - Create send email response
• makeTemplate(options?) - Create template
• makeContact(options?) - Create contact
• makeWebhook(options?) - Create webhook

Testing Patterns

Test Success Path

test('should send email successfully', async () => {
  const brevo = createMockBrevo({ spy: vi.fn });
  
  const result = await brevo.sendEmail(request);
  
  expect(result.code).toBe(200);
  expect(result.data.messageId).toBeDefined();
});

Test Error Handling

test('should handle invalid email address error', async () => {
  const brevo = createMockBrevo({ spy: vi.fn });
  
  brevo.sendEmail.mockRejectedValue(
    BrevoErrors.invalidEmail()
  );
  
  await expect(brevo.sendEmail(request)).rejects.toMatchObject({ message: /Invalid email/ });
});

Test with Custom Data

test('should use custom message ID', async () => {
  const brevo = createMockBrevo({ spy: vi.fn });
  
  brevo.sendEmail.mockResolvedValue({
    code: 200,
    message: 'success',
    data: makeSendEmailResponse({ messageId: '<[email protected]>' })
  });
  
  const result = await brevo.sendEmail(request);
  expect(result.data.messageId).toBe('<[email protected]>');
});

License

MIT