@wolfstar/http-framework-test-utils

Test utilities and fixtures for @wolfstar/http-framework — designed to work with Vitest.

Installation

npm install --save-dev @wolfstar/http-framework-test-utils vitest
# or
pnpm add -D @wolfstar/http-framework-test-utils vitest

Usage

createTestHarness

The entry point for most tests. Returns a TestableClient and an InteractionTestRunner wired together:

import { createTestHarness } from '@wolfstar/http-framework-test-utils';

const { client, runner } = createTestHarness();

// Load your commands before running tests
await client.load();

Running interactions

Use InteractionTestRunner.run() to dispatch a Discord interaction and get back a typed result:

import { ChatInputApplicationCommandInteractionData } from '@wolfstar/http-framework-test-utils';

const result = await runner.run({
	...ChatInputApplicationCommandInteractionData,
	data: { id: '0', name: 'ping', type: 1, options: [] }
});

expect(result.statusCode).toBe(200);
expect(result.json()).toMatchObject({ type: 4, data: { content: 'Pong!' } });

Vitest custom matchers

Import and register the matchers in your Vitest setup file:

// vitest.setup.ts
import { expect } from 'vitest';
import { httpFrameworkMatchers } from '@wolfstar/http-framework-test-utils/vitest';

expect.extend(httpFrameworkMatchers);

Then in tests:

expect(result).toHaveStatus(200);
expect(result).toHaveBody('{"type":4}');
expect(result).toHaveJsonBody({ type: 4, data: { content: 'Pong!' } });

toHaveJsonBody performs a strict deep-equality check: the expected object must contain the exact same set of keys as the response body at every level. If you only care about a subset of fields, assert against result.json() with Vitest's built-in toMatchObject instead.

Available fixtures

Pre-built interaction payloads for all interaction types:

| Export | Type | | -------------------------------------------------- | ---------------------------- | | ChatInputApplicationCommandInteractionData | Chat input command | | MessageApplicationCommandInteractionData | Message context menu command | | UserApplicationCommandInteractionData | User context menu command | | ApplicationCommandAutocompleteInteractionData | Autocomplete | | MessageComponentButtonInteractionData | Button | | MessageComponentStringSelectInteractionData | String select menu | | MessageComponentChannelSelectInteractionData | Channel select menu | | MessageComponentRoleSelectInteractionData | Role select menu | | MessageComponentUserSelectInteractionData | User select menu | | MessageComponentMentionableSelectInteractionData | Mentionable select menu | | ModalSubmitInteractionData | Modal submit |

Base data is also exported: UserData, InteractionGuildMemberData, MessageData, BaseInteractionData.

Helper utilities

import { buildSubcommand, getAndDelete, makeCommand } from '@wolfstar/http-framework-test-utils';

// Build a SlashCommandSubcommandBuilder
const sub = buildSubcommand('add', 'Adds two numbers');

// Construct a command instance for unit testing
const cmd = makeCommand(MyCommand);

// Retrieve and clean up a command's registry entry
const entry = getAndDelete(MyCommand);

Exports

| Entry point | Contents | | -------------------------------------------- | ------------------------------------------------ | | @wolfstar/http-framework-test-utils | All utilities, fixtures, runners, and types | | @wolfstar/http-framework-test-utils/vitest | Custom Vitest matchers (httpFrameworkMatchers) |

Requirements

• Node.js >=20
• @wolfstar/http-framework (peer dependency)
• vitest >=4.0.0 (optional peer dependency — only needed for the /vitest entry point)