stoatx 0.2.0 → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Stoatx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -35,41 +35,33 @@ Make sure to enable decorators in your `tsconfig.json`:
 
 ```typescript
 // index.ts
-import 'reflect-metadata';
-import { Client } from 'stoat.js';
-import { MallyHandler } from 'stoatx';
+import "reflect-metadata";
+import { Client } from "stoatx";
 
-const client = new Client();
-
-const handler = new MallyHandler({
-    client, 
-    prefix: '!', 
-    owners: ['your-user-id']
+const client = new Client({
+  prefix: "!",
+  owners: ["your-user-id"],
 });
 
-await handler.init();
-
-client.on('messageCreate', (message) => {
-  handler.handleMessage(message);
-});
+await client.initCommands();
 
-client.login('your-token');
+client.login("your-token");
 ```
 
 ### 2. Create commands
 
 ```typescript
 // commands/general.ts
-import { Stoat, SimpleCommand, Context } from 'stoatx';
+import { Stoat, SimpleCommand, Context } from "stoatx";
 
 @Stoat()
 export class GeneralCommands {
-  @SimpleCommand({ name: 'ping', description: 'Check bot latency' })
+  @SimpleCommand({ name: "ping", description: "Check bot latency" })
   async ping(ctx: Context) {
     await ctx.reply(`Pong! 🏓`);
   }
 
-  @SimpleCommand({ name: 'hello', aliases: ['hi', 'hey'] })
+  @SimpleCommand({ name: "hello", aliases: ["hi", "hey"] })
   async hello(ctx: Context) {
     await ctx.reply(`Hello, <@${ctx.authorId}>!`);
   }
@@ -115,25 +107,25 @@ async ban(ctx: Context) {
 Adds a guard check before command execution.
 
 ```typescript
-import { Stoat, SimpleCommand, Guard, MallyGuard, Context } from 'stoatx';
+import { Stoat, SimpleCommand, Guard, MallyGuard, Context } from "stoatx";
 
 // Define a guard
 class IsAdmin implements MallyGuard {
   run(ctx: Context): boolean {
-    return ctx.message.member?.hasPermission('Administrator') ?? false;
+    return ctx.message.member?.hasPermission("Administrator") ?? false;
   }
 
   guardFail(ctx: Context): void {
-    ctx.reply('You need Administrator permission!');
+    ctx.reply("You need Administrator permission!");
   }
 }
 
 @Stoat()
 @Guard(IsAdmin)
 export class AdminCommands {
-  @SimpleCommand({ name: 'shutdown' })
+  @SimpleCommand({ name: "shutdown" })
   async shutdown(ctx: Context) {
-    await ctx.reply('Shutting down...');
+    await ctx.reply("Shutting down...");
   }
 }
 ```
@@ -144,16 +136,16 @@ The `Context` object provides:
 
 ```typescript
 interface Context {
-  client: Client;          // Stoat client instance
-  message: Message;        // Original message
-  content: string;         // Raw message content
-  authorId: string;        // Author's user ID
-  channelId: string;       // Channel ID
-  serverId?: string;       // Server/Guild ID
-  args: string[];          // Parsed arguments
-  prefix: string;          // Prefix used
-  commandName: string;     // Command name used
-  
+  client: Client; // Stoat client instance
+  message: Message; // Original message
+  content: string; // Raw message content
+  authorId: string; // Author's user ID
+  channelId: string; // Channel ID
+  serverId?: string; // Server/Guild ID
+  args: string[]; // Parsed arguments
+  prefix: string; // Prefix used
+  commandName: string; // Command name used
+
   reply(content: string): Promise<void>;
 }
 ```
@@ -161,17 +153,17 @@ interface Context {
 ## Handler Options
 
 ```typescript
-interface MallyHandlerOptions {
+interface StoatxHandlerOptions {
   client: Client;
-  commandsDir?: string;          // Legacy mode: explicitly scan this directory
+  commandsDir?: string; // Legacy mode: explicitly scan this directory
   discovery?: {
-    roots?: string[];            // Default: [process.cwd()]
-    include?: string[];          // Glob patterns per root
-    ignore?: string[];           // Additional ignore globs
+    roots?: string[]; // Default: [process.cwd()]
+    include?: string[]; // Glob patterns per root
+    ignore?: string[]; // Additional ignore globs
   };
-  prefix: string | ((ctx: { serverId?: string }) => string | Promise<string>);
-  owners?: string[];             // Owner user IDs
-  extensions?: string[];         // File extensions (default: ['.js', '.mjs', '.cjs'])
+  prefix: string  ((ctx: { serverId?: string }) => string  Promise<string>);
+  owners?: string[]; // Owner user IDs
+  extensions?: string[]; // File extensions (default: ['.js', '.mjs', '.cjs'])
   disableMentionPrefix?: boolean; // Disable @bot prefix
 }
 
@@ -182,31 +174,28 @@ interface MallyHandlerOptions {
 ## Dynamic Prefix
 
 ```typescript
-const handler = new MallyHandler({
-  client,
+const client = new Client({
   prefix: async ({ serverId }) => {
     // Fetch from database, etc.
-    return serverId ? await getServerPrefix(serverId) : '!';
+    return serverId ? await getServerPrefix(serverId) : "!";
   },
 });
 
 // Optional: constrain auto-discovery to specific roots/patterns
-const scopedHandler = new MallyHandler({
-  client,
-  prefix: '!',
+const scopedClient = new Client({
+  prefix: "!",
   discovery: {
     roots: [process.cwd()],
-    include: ['apps/bot/dist/commands/**/*.js'],
+    include: ["apps/bot/dist/commands/**/*.js"],
   },
 });
 
 // TypeScript source discovery is opt-in and requires a TS runtime loader (tsx/ts-node)
-const tsRuntimeHandler = new MallyHandler({
-  client,
-  prefix: '!',
-  extensions: ['.ts'],
+const tsRuntimeClient = new Client({
+  prefix: "!",
+  extensions: [".ts"],
   discovery: {
-    include: ['apps/bot/src/commands/**/*.ts'],
+    include: ["apps/bot/src/commands/**/*.ts"],
   },
 });
 ```
@@ -216,6 +205,3 @@ All commands are defined through `@Stoat()` classes and `@SimpleCommand()` metho
 ## License
 
 AGPL-3.0-or-later
-
-
-