bakit 1.0.0-beta.8 → 2.0.0-alpha.1

package/README.md

@@ -0,0 +1,35 @@
+# About us
+
+Bakit is a framework that makes building Discord bots easier.
+It's built on top of [discord.js](https://discord.js.org) and helps you handle the core system for your bot.
+
+<div align="center">
+	<a href="https://npmjs.com/package/bakit"><img src="https://img.shields.io/npm/v/bakit?logo=npm" alt="npm" /></a>
+	<a href="LICENSE"><img src="https://img.shields.io/github/license/louiszn/bakit" alt="License" /></a>
+	<a href="https://discord.gg/pGnKbMfXke"><img src="https://img.shields.io/discord/1353321517437681724?logo=discord&logoColor=white" alt="Discord" /></a>
+</div>
+
+> [!CAUTION]
+> This package is currently being rewritten. Many features from beta v1 have not yet been migrated.
+> It is not production-ready, and use in production environments is strongly discouraged.
+
+## Why Bakit?
+
+- 🧩 **Unified Command System** - write once for both slash and prefix command.
+- 🚀 **Clean API interfaces** - well-structured commands and events.
+- ⚡ **Lightweight** - minimal overhead, only what you need.
+- ✨ **TypeScript + ESM first** - modern JavaScript tooling out of the box.
+
+## Documentation
+
+Official documentation is now at https://bakit.louiszn.xyz.
+
+# Contributing
+
+Contributions are always welcome! But before doing that, make sure you have already checked existing issues and pull requests before making a new one.
+
+# Support
+
+If you like Bakit and want to support its development, you can buy me a coffee:
+
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/louiszn)

package/dist/index.d.ts

@@ -1,96 +1,44 @@
-import { B as BaseEntry, C as ConstructorLike, a as BaseHook, b as BaseMainHookMethod, c as BaseErrorHookMethod, d as BakitClient } from './BakitClient-D9kRvFS3.js';
-export { A as Arg, h as ArgumentOptions, f as ArgumentType, e as BakitClientOptions, g as BaseArgumentOptions, m as BaseCommandEntry, k as BaseCommandEntryOptions, n as BaseCommandGroupEntry, x as BaseContext, y as ChatInputContext, u as ChatInputContextSendOptions, s as Command, q as CommandAPI, r as CommandFactory, o as CommandGroupEntry, j as CommandHook, t as CommandRegistry, J as CommandSyntaxError, H as CommandSyntaxErrorOptions, F as CommandSyntaxErrorType, D as Context, w as ContextSendOptions, l as CreateCommandOptions, E as ErrorCommandHookMethod, G as GetSyntaxErrorMessageFunction, I as IntegerArgumentOptions, i as MainCommandHookMethod, M as MemberArgumentOptions, z as MessageContext, v as MessageContextSendOptions, N as NumberArgumentOptions, R as RootCommandEntry, S as StringArgumentOptions, p as SubcommandEntry, U as UserArgumentOptions } from './BakitClient-D9kRvFS3.js';
-import { AsyncLocalStorage } from 'node:async_hooks';
-import { ClientEvents } from 'discord.js';
-import EventEmitter from 'node:events';
-import { SetOptional } from 'type-fest';
-
-declare function extractId(value: string): string | null;
-
-type States = Record<string | symbol, unknown>;
-declare class StateBox {
-    private static readonly STATES_KEY;
-    static storage: AsyncLocalStorage<States>;
-    private static getState;
-    static run<R>(fn: () => R, store?: {}): R;
-    static wrap<R>(fn: () => R): () => R;
-    static use<T extends object>(defaultValue?: unknown): (target: T, key: keyof T) => void;
-}
-
-type EventsLike = Record<keyof unknown, unknown[]>;
-type MainListenerHookMethod<Args extends unknown[]> = BaseMainHookMethod<Args>;
-type ErrorListenerHookMethod<Args extends unknown[]> = BaseErrorHookMethod<Args>;
-interface ListenerHook<E extends EventsLike, K extends keyof E> extends BaseHook {
-    method: MainListenerHookMethod<E[K] & unknown[]> | ErrorListenerHookMethod<E[K] & unknown[]>;
-}
-interface ListenerEntryOptions<E extends EventsLike, K extends keyof E> {
-    name: K;
-    once: boolean;
-    emitter?: EventEmitter;
-}
-declare class ListenerEntry<E extends EventsLike, K extends keyof E> extends BaseEntry<ConstructorLike, ListenerHook<E, K>, MainListenerHookMethod<E[K] & unknown[]>, ErrorListenerHookMethod<E[K] & unknown[]>> {
-    options: ListenerEntryOptions<E, K>;
-    constructor(options: ListenerEntryOptions<E, K>);
-}
-
-declare namespace ListenerAPI {
-    const ENTRY_KEY: unique symbol;
-    function use<E extends EventsLike, K extends keyof E>(entry: ListenerEntry<E, K>): (target: ConstructorLike) => void;
-    function getEntry<E extends EventsLike, K extends keyof E>(target: ConstructorLike): ListenerEntry<E, K> | undefined;
-}
-declare function ListenerFactory<E extends EventsLike = ClientEvents, K extends keyof E = keyof E>(options: SetOptional<ListenerEntryOptions<E, K>, "once"> | K): ListenerEntry<E, K>;
-declare const Listener: typeof ListenerFactory & typeof ListenerAPI;
-
+import { GatewayIntentBits, ClientOptions, Message, Awaitable, ClientEvents, Client } from 'discord.js';
+import { z } from 'zod';
+
+declare const ProjectConfigSchema: z.ZodObject<{
+    intents: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"auto">, z.ZodBigInt, z.ZodArray<z.ZodEnum<typeof GatewayIntentBits>>]>>;
+    clientOptions: z.ZodOptional<z.ZodCustom<Omit<ClientOptions, "intents">, Omit<ClientOptions, "intents">>>;
+}, z.core.$strip>;
+type ProjectConfigInput = z.input<typeof ProjectConfigSchema>;
+type ProjectConfig = z.output<typeof ProjectConfigSchema>;
 /**
- * The global listener registry of Bakit.
+ * Define config object for your project. This is just a cleaner way to define config.
+ * @param config The partial version of project config.
+ * @returns The same config you provided earlier.
  */
-declare abstract class ListenerRegistry {
-    private static client;
-    static constructors: Set<ConstructorLike>;
-    static instances: WeakMap<ConstructorLike, object>;
-    static executors: WeakMap<object, (...args: unknown[]) => Promise<void>>;
-    /**
-     * Add and register a listener to the registry.
-     * If `options.emitter` is not provided, the registry will use the base `client` by default.
-     * @param constructor The listener class you want to add.
-     */
-    static add(constructor: ConstructorLike): void;
-    /**
-     * Remove and unregister a listener from the registry.
-     * @param constructor The listener class you want to remove.
-     * @returns `boolean`, returns `true` if the listener is removed successfully.
-     */
-    static remove(constructor: ConstructorLike): boolean;
-    /**
-     * Remove and unregister all listeners from the registry.
-     * @returns Amount of removed listeners.
-     */
-    static removeAll(): number;
-    /**
-     * Set base client for the registry to fallback as default emitter. This should be used only by BakitClient and stay untouched.
-     * @param newClient base client to set for the registry.
-     */
-    protected static setClient(newClient: BakitClient): void;
-    private static createExecutor;
-    /**
-     * Load and add all listeners which matched provided glob pattern to the registry.
-     * @param pattern glob pattern to load.
-     * @param parallel load all matched results in parallel, enabled by default.
-     * @returns All loaded listener constructors.
-     */
-    static load(pattern: string, parallel?: boolean): Promise<ConstructorLike[]>;
-}
-
+declare function defineConfig(config: ProjectConfigInput): ProjectConfigInput;
 /**
- * This file is used to redeclare original client to the custom one
- * Most of the structure is from Base, but some might be not
+ * Load the config file and save them for later usage.
+ * @param cwd The location of the config file, uses root by default.
+ * @returns The complete config with default values from the validation.
  */
+declare function loadConfig(cwd?: string): Promise<ProjectConfig>;
+/**
+ * Get the loaded config of the project.
+ * @returns The project config.
+ */
+declare function getConfig(): ProjectConfig;
 
-
-declare module "discord.js" {
-	interface Base {
-		client: BakitClient<true>;
-	}
+type GetPrefixFunction = (message: Message) => Awaitable<string[] | string>;
+interface BakitClientEvents extends ClientEvents {
+    ready: [BakitClient<true>];
+    clientReady: [BakitClient<true>];
+}
+declare class BakitClient<Ready extends boolean = boolean> extends Client<Ready> {
+    constructor(options: ClientOptions);
+    isReady(): this is BakitClient<true>;
+    on<K extends keyof BakitClientEvents>(event: K, listener: (...args: BakitClientEvents[K]) => void): this;
+    once<K extends keyof BakitClientEvents>(event: K, listener: (...args: BakitClientEvents[K]) => void): this;
+    off<K extends keyof BakitClientEvents>(event: K, listener: (...args: BakitClientEvents[K]) => void): this;
+    removeAllListeners(event?: keyof BakitClientEvents): this;
+    removeListener<K extends keyof BakitClientEvents>(event: K, listener: (...args: BakitClientEvents[K]) => void): this;
+    emit<K extends keyof BakitClientEvents>(event: K, ...args: BakitClientEvents[K]): boolean;
 }
 
-export { BakitClient, type ErrorListenerHookMethod, type EventsLike, Listener, ListenerAPI, ListenerEntry, type ListenerEntryOptions, ListenerFactory, type ListenerHook, ListenerRegistry, type MainListenerHookMethod, StateBox, type States, extractId };
+export { BakitClient, type BakitClientEvents, type GetPrefixFunction, type ProjectConfig, type ProjectConfigInput, defineConfig, getConfig, loadConfig };