zaileys 4.9.0 → 4.11.0

package/dist/plugin/registry.d.ts

@@ -1,5 +1,5 @@
 import type { Logger } from '../client/types.js';
-import type { Plugin, PluginContext } from './types.js';
+import { type Plugin, type PluginContext } from './types.js';
 export interface PluginHost {
     command(spec: Parameters<PluginContext['command']>[0], handler: Parameters<PluginContext['command']>[1]): unknown;
     unregisterCommand(spec: Parameters<PluginContext["command"]>[0]): void;

package/dist/plugin/types.d.ts

@@ -1,6 +1,7 @@
 import type { Client } from '../client/client.js';
 import type { Logger, ClientEventMap } from '../client/types.js';
-import type { CommandHandler, CommandSpec, Middleware } from '../command/index.js';
+import type { CommandGuards, CommandHandler, CommandMeta, CommandSpec, Middleware } from '../command/index.js';
+import type { InboundEventMap } from '../events/types.js';
 export interface PluginContext {
     client: Client;
     logger: Logger | undefined;
@@ -12,11 +13,24 @@ export interface PluginContext {
     on<E extends keyof ClientEventMap>(event: E, handler: (payload: ClientEventMap[E]) => void): () => void;
     once<E extends keyof ClientEventMap>(event: E, handler: (payload: ClientEventMap[E]) => void): () => void;
 }
-export interface Plugin {
+/** `'poll-vote'` reads as `pollVote()` on a plugin, so the method names stay idiomatic. */
+type Camel<S extends string> = S extends `${infer Head}-${infer Tail}` ? `${Head}${Capitalize<Camel<Tail>>}` : S;
+/** One optional method per inbound event, derived so a new event is available here automatically. */
+export type PluginEventHandlers = {
+    [E in keyof InboundEventMap as Camel<E>]?: (payload: InboundEventMap[E], ctx: PluginContext) => void | Promise<void>;
+};
+/** Every inbound event name, in the order their methods are wired up. */
+export declare const INBOUND_EVENTS: readonly ["message", "text", "image", "video", "audio", "document", "sticker", "reaction", "edit", "delete", "poll-vote", "button-click", "list-select", "mention", "mention-all", "group-update", "group-join", "group-leave", "member-tag", "call-incoming", "call-ended", "history-sync", "limited", "presence", "newsletter"];
+export type Plugin = CommandMeta & CommandGuards & PluginEventHandlers & {
+    /** Identifies the plugin, and names the command that `command()` handles. */
     name: string;
-    setup(ctx: PluginContext): void | (() => void) | Promise<void | (() => void)>;
+    aliases?: string[];
+    /** Handles the command named after this plugin. The metadata above describes it. */
+    command?: (ctx: Parameters<CommandHandler>[0], plugin: PluginContext) => void | Promise<void>;
+    /** Escape hatch for what the methods above cannot express: extra commands, middleware, cleanup. */
+    setup?(ctx: PluginContext): void | (() => void) | Promise<void | (() => void)>;
     onUnload?(): void | Promise<void>;
-}
+};
 export type PluginsOptions = {
     dir?: string;
     watch?: boolean;
@@ -24,4 +38,6 @@ export type PluginsOptions = {
     ignore?: RegExp;
     onError?: (err: unknown, file: string) => void;
 };
+/** Identity helper — gives you autocomplete on the plugin shape at zero runtime cost. */
 export declare const definePlugin: (plugin: Plugin) => Plugin;
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "zaileys",
   "description": "Zaileys - Simplified WhatsApp Node.js TypeScript/JavaScript API",
-  "version": "4.9.0",
+  "version": "4.11.0",
   "license": "MIT",
   "type": "module",
   "main": "./dist/index.cjs",