meocord 2.0.0-beta.1 → 2.0.0

package/README.md

@@ -41,7 +41,7 @@
 
 ### Prerequisites
 
-- **Runtime**: Node.js (latest LTS) or Bun 1.x+
+- **Runtime**: Node.js 22 or newer, or Bun 1.x+
 - **TypeScript**: 5.0+
 - **Package manager**: npm, yarn, pnpm, or bun
 
@@ -410,6 +410,33 @@ interaction.guildId = 'guild-123'
 
 Works for any discord.js class — interactions, `Message`, `MessageReaction`, and anything else. No per-type maintenance.
 
+**Assignable to the real class** — the returned mock can be passed straight to code that expects the discord.js type. No `as unknown as ButtonInteraction` at the call site.
+
+```typescript
+const interaction = createMockInteraction(ButtonInteraction)
+
+await controller.handleButton(interaction) // takes a real ButtonInteraction
+```
+
+**Property overrides at construction** — pass a second argument to set properties as the mock is built. This is required for anything discord.js declares `readonly` (`ModalSubmitInteraction#customId` and `#fields`, `MessageComponentInteraction#message`, `client`, `guildId` on some classes), since those cannot be assigned afterwards. It is also how you set a property backed by a getter-only prototype accessor, such as `targetUser` or `targetMessage` on a context menu.
+
+```typescript
+import { createMockInteraction, createMockUser } from 'meocord/testing'
+import { ModalSubmitInteraction, UserContextMenuCommandInteraction } from 'discord.js'
+
+const modal = createMockInteraction(ModalSubmitInteraction, {
+  customId: 'wish-import-800000000',
+  fields: { getTextInputValue: () => '{"pulls":[]}' } as unknown as ModalSubmitInteraction['fields'],
+})
+
+const contextMenu = createMockInteraction(UserContextMenuCommandInteraction, {
+  commandName: 'profile',
+  targetUser: createMockUser(),
+})
+```
+
+The override record is typed as `MockProps<T>`, exported from `meocord/testing`. Every key is optional, and a misspelled property name is a compile error.
+
 ### `createChatInputOptions`
 
 Builds a typed options resolver from a plain record. Type routing mirrors the real `CommandInteractionOptionResolver`: wrong-type access returns `null`, `required=true` throws if the option is absent.
@@ -502,6 +529,19 @@ const module = MeoCordTestingModule.create({
 
 `canActivate: () => true` allows the method to run. `() => false` blocks it. Multiple guards chain fluently.
 
+### `overrideProvider`
+
+Replaces a provider already registered on the module. The value is typed as `Partial<T>`, so a double only has to cover the methods the test exercises — a class with a private member could never be satisfied by a full object literal anyway. A misspelled method name is still a compile error.
+
+```typescript
+const module = MeoCordTestingModule.create({
+  controllers: [GreetingSlashController],
+  providers: [{ provide: GreetingService, useValue: realGreetingService }],
+})
+  .overrideProvider(GreetingService).useValue({ buildGreeting: createMockFn() })
+  .compile()
+```
+
 ### Full example
 
 ```typescript

package/dist/cjs/testing/index.cjs

@@ -747,7 +747,14 @@ function createMockMessage() {
  * interaction.options.getSubcommand()  // → 'notes'
  * interaction.options.getNumber('uid') // → 12345678
  * ```
- */ function createChatInputOptions(opts = {}) {
+ */ // `any` is the default rather than `CacheType` because TypeScript types a generic
+// class's `prototype` with `any` for its parameters, and createMockInteraction infers
+// T from exactly that — `createMockInteraction(ChatInputCommandInteraction)` produces
+// an interaction whose `options` is `CommandInteractionOptionResolver<any>`. Defaulting
+// to `CacheType` instead makes CacheTypeReducer widen getChannel's return with a `null`
+// the target rejects, and the resolver stops being assignable to the property it exists
+// to fill. Pass Cached explicitly when the interaction under test is pinned.
+function createChatInputOptions(opts = {}) {
     const { subcommandGroup = null, subcommand = null, ...values } = opts;
     function resolveOrThrow(name, value, required) {
         if (value === null) {

package/dist/esm/testing/mock-interaction.js

@@ -434,7 +434,14 @@ function createMockMessage() {
  * interaction.options.getSubcommand()  // → 'notes'
  * interaction.options.getNumber('uid') // → 12345678
  * ```
- */ function createChatInputOptions(opts = {}) {
+ */ // `any` is the default rather than `CacheType` because TypeScript types a generic
+// class's `prototype` with `any` for its parameters, and createMockInteraction infers
+// T from exactly that — `createMockInteraction(ChatInputCommandInteraction)` produces
+// an interaction whose `options` is `CommandInteractionOptionResolver<any>`. Defaulting
+// to `CacheType` instead makes CacheTypeReducer widen getChannel's return with a `null`
+// the target rejects, and the resolver stops being assignable to the property it exists
+// to fill. Pass Cached explicitly when the interaction under test is pinned.
+function createChatInputOptions(opts = {}) {
     const { subcommandGroup = null, subcommand = null, ...values } = opts;
     function resolveOrThrow(name, value, required) {
         if (value === null) {

package/dist/types/testing/index.d.ts

@@ -1,6 +1,6 @@
 import { ServiceIdentifier, Container } from 'inversify';
 import { GuardInterface } from '../interface/index.js';
-import { CommandInteractionOptionResolver, Channel, Client, Guild, Message, User } from 'discord.js';
+import { CacheType, CommandInteractionOptionResolver, Channel, Client, Guild, Message, User } from 'discord.js';
 import 'webpack';
 import '../controller.enum-QA-IuReF.js';
 
@@ -272,7 +272,7 @@ interface ChatInputOptions {
  * interaction.options.getNumber('uid') // → 12345678
  * ```
  */
-declare function createChatInputOptions(opts?: ChatInputOptions): DeepMocked<CommandInteractionOptionResolver>;
+declare function createChatInputOptions<Cached extends CacheType = any>(opts?: ChatInputOptions): DeepMocked<CommandInteractionOptionResolver<Cached>>;
 
 export { MeoCordTestingModule, TestingModule, TestingModuleBuilder, createChatInputOptions, createMockChannel, createMockClient, createMockFn, createMockGuild, createMockInteraction, createMockMessage, createMockUser, isMockFunction };
 export type { ChatInputOptions, ClassProvider, DeepMocked, Mock, MockInstance, MockProps, MockResult, MockState, MockedFunction, Provider, TestingModuleOptions, ValueProvider };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "meocord",
   "description": "Decorator-based Discord bot framework built on discord.js. Brings NestJS-style controllers, dependency injection, guards, and testing utilities to bot development — with a full CLI and TypeScript-first design.",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0",
   "type": "module",
   "engines": {
     "node": ">=22"