typings/ci: Split typings

package.json

@@ -37,7 +37,7 @@
   "scripts": {
     "lint": "yarn run lint:js && yarn run lint:ts",
     "lint:js": "eslint src examples *.js",
-    "lint:ts": "eslint index.d.ts",
+    "lint:ts": "eslint index.d.ts types/**/*.ts",
     "tsc": "tsc index.d.ts",
     "test": "yarn run lint && yarn run tsc",
     "test:push": "eslint src examples *.js",

types/AxonClient.ts

@@ -0,0 +1,244 @@
+
+export declare class AxonClient extends EventEmitter {
+    /** Configs (webhooks, template, custom) */
+    private _configs: AxonConfs;
+    /** Bot settings */
+    public settings: AxonParams;
+    /** General infos about the current application */
+    public infos: Infos;
+    public axoncore: AxonInfos;
+    /** The Logger instance */
+    public logger: ALogger;
+    /** Util methods (AxonCore) */
+    public axonUtils: AxonUtils;
+
+    /** Discord library Client */
+    private _botClient: LibClient;
+    public library: LibraryInterface;
+    /** Utils methods (general) */
+    public utils: Utils;
+    /** The DBProvider instance */
+    public DBProvider: ADBProvider
+
+    /** Registry holding all modules */
+    public moduleRegistry: ModuleRegistry;
+    /** Registry holding all commands */
+    public commandRegistry: CommandRegistry;
+    /** Registry holding all listeners */
+    public listenerRegistry: ListenerRegistry;
+    /** The EventManager instance that handle all AxonCore listeners */
+    public eventManager: EventManager;
+
+    /** The Manager that handles GuildConfigs (cache / DB etc) */
+    public guildConfigs: GuildConfigCache;
+    /** The AxonConfig object that handles globally blacklisted users and guilds */
+    public axonConfig?: AxonConfig;
+
+    /** Load, unload modules. */
+    public moduleLoader: ModuleLoader;
+    /** Dispatch commands onMessageCreate. */
+    public dispatcher: CommandDispatcher;
+    /** Message manager object accessible with `<AxonClient>.l` */
+    private _messageManager: MessageManager;
+
+    /** Bot Staff (owners, admins, +...) */
+    public staff: AxonStaffIDs;
+
+    /**
+     * Creates an AxonClient instance.
+     *
+     * @param botClient - Eris or Discordjs Client instance
+     * @param axonOptions - Axon options
+     * @param modules - Object with all modules to add in the bot
+     * @memberof AxonClient
+     */
+    constructor(botClient: LibClient, AxonOptions: AxonOptions, modules: object);
+
+    /**
+     * Returns the bot client instance
+     *
+     * @readonly
+     * @memberof AxonClient
+     */
+    readonly botClient: LibClient;
+    /**
+     * Returns all event handlers in eventManager
+     *
+     * @readonly
+     * @memberof AxonClient
+     */
+    readonly handlers: Collection<AHandler>;
+    /**
+     * Returns all registered listeners for the discord event name
+     *
+     * @memberof AxonClient
+     */
+    getListeners(eventName: string): Listener[];
+    /**
+     * Returns all the resolver for the default current library used.
+     * Can be easily overridden with a custom Resolver by overriding this getter.
+     *
+     * @readonly
+     * @memberof AxonClient
+     */
+    readonly Resolver: Resolver;
+    /**
+     * Return the webhooks config
+     *
+     * @readonly
+     * @memberof AxonClient
+     */
+    readonly webhooks: Webhooks;
+    /**
+     * Returns the template config
+     *
+     * @readonly
+     * @memberof AxonClient
+     */
+    readonly template: AxonTemplate;
+    /**
+     * Returns the custom config
+     *
+     * @readonly
+     * @memberof AxonClient
+     */
+    readonly custom: object | null;
+    /**
+     * Return the MessageManager instance
+     *
+     * @readonly
+     * @memberof AxonClient
+     */
+    readonly l: MessageManager;
+
+    /**
+     * Get a module from AxonClient with the given label.
+     *
+     * @param module - Module label
+     * @memberof AxonClient
+     */
+    getModule(module: string): Module | null;
+    /**
+     * Get a command/subcommand from AxonClient with the given full label.
+     *
+     * @param fullLabel - Full command (or subcommand) label
+     * @memberof AxonClient
+     */
+    getCommand(fullLabel: string): Command | null;
+
+    /**
+     * Start AxonClient.
+     * Start bot client.
+     * Bind error listeners and event listeners.
+     *
+     * Calls custom onStart() method at the beginning.
+     * Calls custom onReady() method when AxonClient is ready.
+     *
+     * @async
+     * @memberof AxonClient
+     */
+    public start(): Promise<void>;
+    /**
+     * Override this method.
+     * Method executed after the object is finished to be constructed (in the constructor)
+     *
+     * @memberof AxonClient
+     */
+    public onInit(): true;
+    /**
+     * Override this method.
+     * Method executed at the beginning of the start method.
+     *
+     * @memberof AxonClient
+     */
+    public onStart(): Promise<true>;
+    /**
+     * Override this method.
+     * Method executed at the end of the start method (when the AxonClient is ready).
+     *
+     * @memberof AxonClient
+     */
+    public onReady(): Promise<true>;
+    /**
+     * Log both to console and to the correct webhook
+     *
+     * @param level - The LOG-LEVEL
+     * @param content - The content or the error to log
+     * @param ctx - Additional context to be passed to logger
+     * @param execWebhook - Whether to execute the webhook
+     * @memberof AxonClient
+     */
+    public log(level: LOG_LEVELS, content: Error | string, ctx?: Ctx, execWebhook?: boolean): void;
+    /**
+     * Function executed on the global messageCreate event and dispatch to the correct command and execution
+     *
+     * @memberof AxonClient
+     */
+    private _onMessageCreate(msg: LibMessage): void;
+
+    /**
+     * Function executed when the bot client is ready.
+     * Bind events and initialise client status/game.
+     * @memberof AxonClient
+     */
+    private _onReady(): void;
+    /**
+     * Initialize error listeners and webhooks.
+     * Override this method to setup your own error listeners.
+     * @memberof AxonClient
+     */
+    public initErrorListeners(): void;
+    /**
+     * Set the bot status. Override to setup your own status.
+     * Called after the client ready event.
+     * @memberof AxonClient
+     */
+    public initStatus(): void;
+
+    public _execCommand(msg: LibMessage, args: string[], command: Command, guildConfig: GuildConfig, optionals: { isAdmin: boolean; isOwner: boolean; } ): void;
+    public _execHelp(msg: LibMessage, args: string[], command: Command, guildConfig: GuildConfig, optionals: { isAdmin: boolean; isOwner: boolean; } ): void;
+    public _execListener(listener: Listener, guildConfig: GuildConfig, ...args: any[] ): void;
+
+    /**
+     * Send full help in DM.
+     * Doesn't show commands that the user can't execute.
+     * This method can be overridden in child.
+     *
+     * @param msg - The message object
+     *
+     * @memberof AxonClient
+     */
+    public sendFullHelp(msg: LibMessage, guildConfig?: GuildConfig): Promise<void>;
+    /**
+     * Register a guild prefix.
+     * Shortcut to guildConfig.registerPrefix()
+     *
+     * @param gID - The guild ID
+     * @param prefixArr - The array of prefixes
+     * @returns The guild Schema from the DB / Error if error
+     *
+     * @memberof AxonClient
+     */
+    public registerGuildPrefixes(gID: string, prefixArr: string[] ): Promise<GuildConfig>;
+    /**
+     * Custom toString method.
+     *
+     * @memberof AxonClient
+     */
+    toString(): string;
+    /**
+     * Custom ToJSON method.
+     * (Based of Eris')
+     *
+     * @returns JSON-like Object
+     * @memberof AxonClient
+     */
+    toJSON(): object;
+
+    // events
+    on(event: 'debug', listener: (debugMessage: string) => void): this;
+    on(event: 'commandExecution', listener: (status: boolean, commandFullLabel: string, data: { msg: LibMessage; command: Command; guildConfig: GuildConfig; context: CommandContext;} ) => void): this;
+    on(event: 'commandError', listener: (commandFullLabel: string, data: { msg: LibMessage; command: Command; guildConfig: GuildConfig; error: AxonCommandError; } ) => void): this;
+    on(event: 'listenerExecution', listener: (status: boolean, eventName: string, listenerName: string, data: { listener: Listener; guildConfig: GuildConfig; } ) => void): this;
+    on(event: 'listenerError', listener: (eventName: string, listenerName: string, data: { listener: Listener; guildConfig: GuildConfig; error: Error; } ) => void): this;
+}

types/AxonOptions.ts

@@ -0,0 +1,56 @@
+
+export declare class AxonOptions {
+    /**
+     * The discord token to automatically connect the bot client
+     */
+    private _token: string;
+    /**
+     * Bot prefixes
+     */
+    public prefixes: AxonOptionsPrefixes;
+    /**
+     * Bot settings
+     */
+    public settings: AOptionsSettings;
+    /**
+     * Translation file
+     */
+    public lang: Languages;
+    /**
+     * Custom function that will log a custom logo on startup
+     */
+    public logo: ( () => void) | null;
+    /**
+     * General info about the bot
+     */
+    public info: AxonOptionsInfo;
+    /**
+     * The bot staff (owner, admins)
+     */
+    public staff: AxonOptionsStaff;
+    /**
+     * Template information (colours / formatting / emojis)
+     */
+    public template: AxonTemplate;
+    /**
+     * Custom configs that can be provided
+     */
+    public custom: object | null;
+    /**
+     * Webhooks tokens / id
+     */
+    public webhooks: Webhooks;
+    /**
+     * Classes overrides
+     */
+    public extensions: AxonOptionsExtensions;
+    /**
+     * Creates an instance of AxonOptions.
+     *
+     * @param data - AxonOptions data
+     * @param webhooks - Webhooks tokens / id
+     * @param extensions - Classes overrides
+     * @memberof AxonOptions
+     */
+    constructor(data?: AxonOptionsBase | {}, webhooks?: Webhooks | {}, extensions?: AxonOptionsExtensions | {} )
+}