@wolfstar/http-framework-test-utils 3.0.0 → 3.0.2

package/README.md

@@ -0,0 +1,112 @@
+# `@wolfstar/http-framework-test-utils`
+
+Test utilities and fixtures for [`@wolfstar/http-framework`](https://github.com/wolfstar-project/stars-components/tree/main/packages/http-framework) — designed to work with [Vitest](https://vitest.dev/).
+
+## Installation
+
+```bash
+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:
+
+```typescript
+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:
+
+```typescript
+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:
+
+```typescript
+// vitest.setup.ts
+import { expect } from 'vitest';
+import { httpFrameworkMatchers } from '@wolfstar/http-framework-test-utils/vitest';
+
+expect.extend(httpFrameworkMatchers);
+```
+
+Then in tests:
+
+```typescript
+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
+
+```typescript
+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)

package/dist/esm/index.d.ts

@@ -5,7 +5,6 @@ import { APIApplicationCommandAutocompleteInteraction, APIAuthorizingIntegration
 import { Writable } from "node:stream";
 import { Constructor } from "@sapphire/utilities";
 import { ServerResponse } from "node:http";
-
 //#region src/commands.d.ts
 declare function buildSubcommand(name: string, description: string): SlashCommandSubcommandBuilder;
 declare function getAndDelete<Options extends Command.Options>(command: typeof Command<Options>): any;

package/dist/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/commands.ts","../../src/fixtures.ts","../../src/TestableClient.ts","../../src/InteractionTestRunner.ts","../../src/MockServerResponse.ts","../../src/snowflake.ts","../../src/testHarness.ts"],"mappings":";;;;;;;;;iBAKgB,eAAA,CAAgB,IAAA,UAAc,WAAA,WAAsB,6BAA6B;AAAA,iBAIjF,YAAA,iBAA6B,OAAA,CAAQ,OAAA,EAAS,OAAA,SAAgB,OAAA,CAAQ,OAAA;AAAA,iBAQtE,WAAA,iBAA4B,OAAA,CAAQ,OAAA,EAAS,YAAA,EAAc,WAAA,CAAY,OAAA,CAAQ,OAAA,KAAY,OAAA,CAAQ,OAAA;;;cCWtG,QAAA,EAAU,QAAQ,CAAC,OAAA;AAAA,cAWnB,0BAAA,EAA4B,QAAQ,CAAC,yBAAA;AAAA,cAUrC,WAAA,EAAa,QAAQ,CAAC,UAAA;AAAA,cAiBtB,eAAA,EAAiB,WAAiB;AAAA,cAClC,UAAA,EAAY,MAAyB;AAAA,cAErC,mBAAA;EAAA;;;;;;;;;yBAUQ,cAAA;EAAA,yCACkB,kCAAA;EAAA;;cAI1B,6CAAA,EAA+C,4CAI3D;AAAA,cAEY,0CAAA,EAA4C,yCAMxD;AAAA,cAEY,wCAAA,EAA0C,uCAYtD;AAAA,cAEY,qCAAA,EAAuC,oCAOnD;AAAA,cAEY,qCAAA,EAAuC,oCAOnD;AAAA,cAEY,4CAAA,EAA8C,wCAAA,CAAyC,IAOnG;AAAA,cAEY,gDAAA,EAAkD,4CAAA,CAA6C,IAY3G;AAAA,cAEY,yCAAA,EAA2C,qCAAA,CAAsC,IAO7F;AAAA,cAEY,2CAAA,EAA6C,uCAAA,CAAwC,IAOjG;AAAA,cAEY,yCAAA,EAA2C,qCAAA,CAAsC,IAO7F;AAAA,cAEY,0BAAA,EAA4B,yBAMxC;;;cCjLY,cAAA,SAAuB,MAAA;cAChB,OAAA,GAAS,OAAA,CAAQ,aAAA;EAId,iBAAA,CACrB,WAAA,EAAa,OAAA,CAAQ,cAAA,EAAgB,sCAAA,GACrC,QAAA,EAAU,cAAA,GACR,OAAA,CAAQ,cAAA;AAAA;;;cCZC,qBAAA;EAAA;cAGO,MAAA,EAAQ,cAAA;EAId,GAAA,CAAI,WAAA,EAAa,OAAA,CAAQ,cAAA,EAAgB,sCAAA,IAA0C,OAAA,CAAQ,iBAAA;AAAA;;;cCT5F,kBAAA,SAA2B,QAAA;EAAA;EAChC,UAAA;EAAA,SACS,OAAA,EAAS,MAAA;EAGlB,SAAA,CAAU,IAAA,UAAc,KAAA;EAIf,MAAA,CAAO,KAAA,WAAgB,SAAA,EAAW,cAAA,EAAgB,QAAA,GAAW,KAAA,GAAQ,KAAA;EAK9E,OAAA;EAIA,aAAA,iBAA8B,CAAA;EAI9B,KAAA;AAAA;AAAA,iBAOQ,YAAA,IAAgB,cAAc;;;UC9B7B,yBAAA;;EAEhB,SAAA,YAAqB,IAAI;;EAEzB,QAAA;;EAEA,SAAA;;EAEA,SAAA;AAAA;AAAA,iBAWe,iBAAA,CAAkB,OAAuC,GAA9B,yBAA8B;AAAA,iBAkBzD,wBAAA,CAAyB,OAAA,GAAS,IAAI,CAAC,yBAAA;;;iBCnCvC,iBAAA,CAAkB,OAAA,GAAS,OAAA,CAAQ,aAAA;;;;KAMvC,WAAA,GAAc,UAAU,QAAQ,iBAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/commands.ts","../../src/fixtures.ts","../../src/TestableClient.ts","../../src/InteractionTestRunner.ts","../../src/MockServerResponse.ts","../../src/snowflake.ts","../../src/testHarness.ts"],"mappings":";;;;;;;;iBAKgB,gBAAgB,cAAc,sBAAsB;iBAIpD,aAAa,gBAAgB,QAAQ,SAAS,gBAAgB,QAAQ;iBAQtE,YAAY,gBAAgB,QAAQ,SAAS,cAAc,YAAY,QAAQ,YAAY,QAAQ;;;cCWtG,UAAU,SAAS;cAWnB,4BAA4B,SAAS;cAUrC,aAAa,SAAS;cAiBtB,iBAAiB;cACjB,YAAY;cAEZ;;;;;;;;;;WAUQ,cAAA;WACkB,gCAAA;;;cAI1B,+CAA+C;cAM/C,4CAA4C;cAQ5C,0CAA0C;cAc1C,uCAAuC;cASvC,uCAAuC;cASvC,8CAA8C,yCAAyC;cASvF,kDAAkD,6CAA6C;cAc/F,2CAA2C,sCAAsC;cASjF,6CAA6C,wCAAwC;cASrF,2CAA2C,sCAAsC;cASjF,4BAA4B;;;cC3K5B,uBAAuB;EAChB,YAAA,UAAS,QAAQ;EAId,kBACrB,aAAa,QAAQ,gBAAgB,yCACrC,UAAU,iBACR,QAAQ;;;;cCZC;;EAGO,YAAA,QAAQ;EAId,IAAI,aAAa,QAAQ,gBAAgB,0CAA0C,QAAQ;;;;cCT5F,2BAA2B;;EAChC;WACS,SAAS;EAGlB,UAAU,cAAc;EAIf,OAAO,gBAAgB,WAAW,gBAAgB,WAAW,QAAQ;EAK9E;EAIA,cAAc,gBAAgB;EAI9B;;iBAOQ,gBAAgB;;;UC9Bf;;EAEhB,qBAAqB;;EAErB;;EAEA;;EAEA;;iBAWe,kBAAkB,UAAS;iBAkB3B,yBAAyB,UAAS,KAAK;;;iBCnCvC,kBAAkB,UAAS,QAAQ;;;;KAMvC,cAAc,kBAAkB"}

package/dist/esm/index.js

@@ -270,7 +270,7 @@ const ModalSubmitInteractionData = {
 };
 
 //#endregion
-//#region \0@oxc-project+runtime@0.137.0/helpers/esm/typeof.js
+//#region \0@oxc-project+runtime@0.142.0/helpers/esm/typeof.js
 function _typeof(o) {
 	"@babel/helpers - typeof";
 	return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
@@ -281,7 +281,7 @@ function _typeof(o) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.137.0/helpers/esm/toPrimitive.js
+//#region \0@oxc-project+runtime@0.142.0/helpers/esm/toPrimitive.js
 function toPrimitive(t, r) {
 	if ("object" != _typeof(t) || !t) return t;
 	var e = t[Symbol.toPrimitive];
@@ -294,14 +294,14 @@ function toPrimitive(t, r) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.137.0/helpers/esm/toPropertyKey.js
+//#region \0@oxc-project+runtime@0.142.0/helpers/esm/toPropertyKey.js
 function toPropertyKey(t) {
 	var i = toPrimitive(t, "string");
 	return "symbol" == _typeof(i) ? i : i + "";
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.137.0/helpers/esm/defineProperty.js
+//#region \0@oxc-project+runtime@0.142.0/helpers/esm/defineProperty.js
 function _defineProperty(e, r, t) {
 	return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
 		value: t,
@@ -312,26 +312,26 @@ function _defineProperty(e, r, t) {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.137.0/helpers/esm/checkPrivateRedeclaration.js
+//#region \0@oxc-project+runtime@0.142.0/helpers/esm/checkPrivateRedeclaration.js
 function _checkPrivateRedeclaration(e, t) {
 	if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object");
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.137.0/helpers/esm/classPrivateFieldInitSpec.js
+//#region \0@oxc-project+runtime@0.142.0/helpers/esm/classPrivateFieldInitSpec.js
 function _classPrivateFieldInitSpec(e, t, a) {
 	_checkPrivateRedeclaration(e, t), t.set(e, a);
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.137.0/helpers/esm/assertClassBrand.js
+//#region \0@oxc-project+runtime@0.142.0/helpers/esm/assertClassBrand.js
 function _assertClassBrand(e, t, n) {
 	if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n;
 	throw new TypeError("Private element is not present on this object");
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.137.0/helpers/esm/classPrivateFieldGet2.js
+//#region \0@oxc-project+runtime@0.142.0/helpers/esm/classPrivateFieldGet2.js
 function _classPrivateFieldGet2(s, a) {
 	return s.get(_assertClassBrand(s, a));
 }
@@ -370,7 +370,7 @@ function makeResponse() {
 }
 
 //#endregion
-//#region \0@oxc-project+runtime@0.137.0/helpers/esm/classPrivateFieldSet2.js
+//#region \0@oxc-project+runtime@0.142.0/helpers/esm/classPrivateFieldSet2.js
 function _classPrivateFieldSet2(s, a, r) {
 	return s.set(_assertClassBrand(s, a), r), r;
 }

package/dist/esm/types-EeGiyIko.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types-EeGiyIko.d.ts","names":[],"sources":["../../src/types.ts"],"mappings":";UAAiB,iBAAA;EAChB,UAAA;EACA,IAAA;EACA,IAAA,iBAAqB,CAAC;AAAA"}
+{"version":3,"file":"types-EeGiyIko.d.ts","names":[],"sources":["../../src/types.ts"],"mappings":";UAAiB;EAChB;EACA;EACA,KAAK,gBAAgB"}

package/dist/esm/vitest.d.ts

@@ -1,5 +1,4 @@
 import { t as InteractionResult } from "./types-EeGiyIko.js";
-
 //#region src/vitest.d.ts
 interface HttpFrameworkMatchers<R = unknown> {
   toHaveStatus(expected: number): R;

package/dist/esm/vitest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vitest.d.ts","names":[],"sources":["../../src/vitest.ts"],"mappings":";;;UAGiB,qBAAA;EAChB,YAAA,CAAa,QAAA,WAAmB,CAAA;EAChC,UAAA,CAAW,QAAA,WAAmB,CAAA;EAC9B,cAAA,CAAe,QAAA,YAAoB,CAAA;AAAA;AAAA;EAAA,UAKzB,SAAA,kBAA2B,qBAAA,CAAsB,CAAA;EAAA,UACjD,4BAAA,SAAqC,qBAAA;AAAA;AAAA,cA2BnC,qBAAA;8DACW,iBAAA,EAAiB,QAAA;;;;4DAOnB,iBAAA,EAAiB,QAAA;;;;gEAOb,iBAAA,EAAiB,QAAA"}
+{"version":3,"file":"vitest.d.ts","names":[],"sources":["../../src/vitest.ts"],"mappings":";;UAGiB,sBAAsB;EACtC,aAAa,mBAAmB;EAChC,WAAW,mBAAmB;EAC9B,eAAe,oBAAoB;;;YAKzB,UAAU,iBAAiB,sBAAsB;YACjD,qCAAqC;;cA2BnC;EACW,aAAA,uBAAA,cAAA,UAAA,mBAAiB;;;;EAOnB,WAAA,uBAAA,cAAA,UAAA,mBAAiB;;;;EAOb,eAAA,uBAAA,cAAA,UAAA,mBAAiB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wolfstar/http-framework-test-utils",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "Test utilities for @wolfstar/http-framework",
   "keywords": [
     "discord",
@@ -51,14 +51,14 @@
     "@sapphire/pieces": "^4.4.1",
     "@sapphire/utilities": "^3.18.2",
     "discord-api-types": "^0.38.8",
-    "tsdown": "^0.22.3",
+    "tsdown": "^0.22.14",
     "typescript": "~5.8.3",
     "vitest": "^4.1.9",
-    "@wolfstar/http-framework": "3.0.0"
+    "@wolfstar/http-framework": "3.1.1"
   },
   "peerDependencies": {
-    "vitest": ">=4.0.0",
-    "@wolfstar/http-framework": "^3.0.0"
+    "vitest": ">=4.1.9",
+    "@wolfstar/http-framework": "^3.1.1"
   },
   "peerDependenciesMeta": {
     "vitest": {