+
+[](https://opensource.org/licenses/MIT)
+
+A customizable, batteries-included, powerful discord.js framework to automate and streamline your bot development.
+
+## Installation
+
+```sh
+npm install @sern/handler
+```
+
+```sh
+yarn add @sern/handler
+```
+
+```sh
+pnpm add @sern/handler
+```
+
+## Basic Usage
+
+#### ` index.js (CommonJS)`
+
+```js
+const { Client, GatewayIntentBits } = require('discord.js');
+const { Sern } = require('@sern/handler');
+const { defaultPrefix, token } = require('./config.json');
+
+const client = new Client({
+ intents: [
+ GatewayIntentBits.Guilds,
+ GatewayIntentBits.GuildMembers,
+ GatewayIntentBits.GuildMessages
+ ]
+});
+
+Sern.init({
+ client,
+ defaultPrefix,
+ commands : 'src/commands',
+});
+
+client.login(token);
+```
+
+#### ` ping.js (CommonJS)`
+
+```js
+const { Sern, CommandType } = require('@sern/handler');
+
+exports.default = {
+ description: 'A ping pong command',
+ type: CommandType.Slash,
+ execute(ctx) {
+ ctx.reply('pong!');
+ }
+ };
+```
+
+See our [templates](https://github.com/sern-handler/templates) for TypeScript examples and more
+
+## CLI
+
+It is **highly encouraged** to use the [command line interface](https://github.com/sern-handler/cli) for your project. Don't forget to view it.
+
+## Links
+
+- [Official Documentation](https://sern-handler.js.org)
+- [Support Server](https://discord.com/invite/mmyCTnYtbF)
+
+## Contribute
+
+- Read our contribution [guidelines](https://github.com/sern-handler/handler) carefully
+- Pull up on [issues](https://github.com/sern-handler/handler/issues) and report bugs
+- All kinds of contributions are welcomed.
+
+## Roadmap
+
+You can check our [roadmap](https://github.com/sern-handler/roadmap) to see what's going to be added or patched in the future.
diff --git a/docs/api/interfaces/Controller.md b/docs/api/interfaces/Controller.md
new file mode 100644
index 000000000..751b1e730
--- /dev/null
+++ b/docs/api/interfaces/Controller.md
@@ -0,0 +1,43 @@
+---
+id: "Controller"
+title: "Interface: Controller"
+sidebar_label: "Controller"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+## Properties
+
+### next
+
+• **next**: () => `Ok`<`void`\>
+
+#### Type declaration
+
+▸ (): `Ok`<`void`\>
+
+##### Returns
+
+`Ok`<`void`\>
+
+#### Defined in
+
+[src/handler/plugins/plugin.ts:29](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L29)
+
+___
+
+### stop
+
+• **stop**: () => `Err`<`void`\>
+
+#### Type declaration
+
+▸ (): `Err`<`void`\>
+
+##### Returns
+
+`Err`<`void`\>
+
+#### Defined in
+
+[src/handler/plugins/plugin.ts:30](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L30)
diff --git a/docs/api/interfaces/Wrapper.md b/docs/api/interfaces/Wrapper.md
new file mode 100644
index 000000000..b30da2bb7
--- /dev/null
+++ b/docs/api/interfaces/Wrapper.md
@@ -0,0 +1,59 @@
+---
+id: "Wrapper"
+title: "Interface: Wrapper"
+sidebar_label: "Wrapper"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+An object to be passed into Sern#init() function.
+
+## Properties
+
+### client
+
+• `Readonly` **client**: `Client`<`boolean`\>
+
+#### Defined in
+
+[src/handler/structures/wrapper.ts:10](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/wrapper.ts#L10)
+
+___
+
+### commands
+
+• `Readonly` **commands**: `string`
+
+#### Defined in
+
+[src/handler/structures/wrapper.ts:13](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/wrapper.ts#L13)
+
+___
+
+### defaultPrefix
+
+• `Optional` `Readonly` **defaultPrefix**: `string`
+
+#### Defined in
+
+[src/handler/structures/wrapper.ts:12](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/wrapper.ts#L12)
+
+___
+
+### events
+
+• `Optional` `Readonly` **events**: `string` \| { `absPath`: `string` ; `mod`: `EventModule` }[] \| () => { `absPath`: `string` ; `mod`: `EventModule` }[]
+
+#### Defined in
+
+[src/handler/structures/wrapper.ts:14](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/wrapper.ts#L14)
+
+___
+
+### sernEmitter
+
+• `Optional` `Readonly` **sernEmitter**: [`SernEmitter`](../classes/SernEmitter.md)
+
+#### Defined in
+
+[src/handler/structures/wrapper.ts:11](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/wrapper.ts#L11)
diff --git a/docs/api/interfaces/_category_.yml b/docs/api/interfaces/_category_.yml
new file mode 100644
index 000000000..43bec88cf
--- /dev/null
+++ b/docs/api/interfaces/_category_.yml
@@ -0,0 +1,2 @@
+label: "Interfaces"
+position: 4
\ No newline at end of file
diff --git a/docs/api/modules.md b/docs/api/modules.md
new file mode 100644
index 000000000..132f88281
--- /dev/null
+++ b/docs/api/modules.md
@@ -0,0 +1,627 @@
+---
+id: "modules"
+title: "@sern/handler"
+sidebar_label: "Exports"
+sidebar_position: 0.5
+custom_edit_url: null
+---
+
+## Namespaces
+
+- [Sern](namespaces/Sern.md)
+
+## Enumerations
+
+- [CommandType](enums/CommandType.md)
+- [EventType](enums/EventType.md)
+- [PayloadType](enums/PayloadType.md)
+- [PluginType](enums/PluginType.md)
+
+## Classes
+
+- [Context](classes/Context.md)
+- [SernEmitter](classes/SernEmitter.md)
+
+## Interfaces
+
+- [Controller](interfaces/Controller.md)
+- [Wrapper](interfaces/Wrapper.md)
+
+## Type Aliases
+
+### Args
+
+Ƭ **Args**: [`ParseType`](modules.md#parsetype)<{ `slash`: [`SlashOptions`](modules.md#slashoptions) ; `text`: `string`[] }\>
+
+#### Defined in
+
+[src/types/handler.ts:11](https://github.com/sern-handler/handler/blob/2009593/src/types/handler.ts#L11)
+
+___
+
+### AutocompletePlugin
+
+Ƭ **AutocompletePlugin**: [`Override`](modules.md#override)<`BaseModule`, { `execute`: (`autocmp`: `AutocompleteInteraction`, `controlller`: [`Controller`](interfaces/Controller.md)) => `Awaitable`<`Result`<`void`, `void`\>\> ; `type`: [`Event`](enums/PluginType.md#event) }\>
+
+#### Defined in
+
+[src/handler/plugins/plugin.ts:92](https://github.com/sern-handler/handler/blob/2009593/src/handler/plugins/plugin.ts#L92)
+
+___
+
+### BaseOptions
+
+Ƭ **BaseOptions**: `ApplicationCommandChoicesData` \| `ApplicationCommandNonOptionsData` \| `ApplicationCommandChannelOptionData` \| `ApplicationCommandNumericOptionData` \| `ApplicationCommandAttachmentOption` \| [`SernAutocompleteData`](modules.md#sernautocompletedata)
+
+Type that replaces autocomplete with [SernAutocompleteData](modules.md#sernautocompletedata)
+
+#### Defined in
+
+[src/handler/structures/module.ts:181](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L181)
+
+___
+
+### BothCommand
+
+Ƭ **BothCommand**: [`Override`](modules.md#override)<`BaseModule`, { `alias?`: `string`[] ; `execute`: (`ctx`: [`Context`](classes/Context.md), `args`: [`Args`](modules.md#args)) => `Awaitable`<`void` \| `unknown`\> ; `onEvent`: [`EventPlugin`](modules.md#eventplugin)<[`Both`](enums/CommandType.md#both)\>[] ; `options?`: [`SernOptionsData`](modules.md#sernoptionsdata)[] ; `plugins`: [`CommandPlugin`](modules.md#commandplugin)[] ; `type`: [`Both`](enums/CommandType.md#both) }\>
+
+#### Defined in
+
+[src/handler/structures/module.ts:55](https://github.com/sern-handler/handler/blob/2009593/src/handler/structures/module.ts#L55)
+
+___
+
+### CommandModuleNoPlugins
+
+Ƭ **CommandModuleNoPlugins**: { [T in CommandType]: OmitSo, lets say you want to make a command module that listens to modals.
+ +**Note**: Keep in mind you'll need to send a modal with a custom id `dm-me`. This example below is the response to a modal being sent. +A sern.config.json, although not necessary, allows your project to communicate with our cli.
+ +For example, when installing typescript plugins, the language property is necessary to install from our +[open source repository](https://github.com/sern-handler/awesome-plugins).As of now, modules seem a little underwhelming. It appears that sern doesn't have all the features of a standard handler, +which manages permissions, categorizes, cool-downs, publishes application commands, role permissions, etc.
+ + +Many important parts that manage access and help streamline command creation to make are apparently absent. +Below is an example of an event plugin, one of the types of plugins.
+ +Typescript: +```typescript +export function serenOnly(): EventPluginSo, what does a command module look like with plugins?
+ +Typescript: +```typescript +import { commandModule, CommandType } from '@sern/handler'; + +export default commandModule({ + type: CommandType.Both, + plugins: [ + inDir("other"), + serenOnly() + ], + description: 'A ping command', + //alias : [], + execute: async (ctx, args) => { + await ctx.reply({ content: 'Pong 🏓' }); + }, +}); +``` +Javascript: +```typescript +const { commandModule, CommandType } = require('@sern/handler'); + +exports.default = commandModule({ + type: CommandType.Both, + plugins: [ + inDir("other"), + serenOnly() //The plugins in this section applied to this module! + ], + description: 'A ping command', + //alias : [], + execute: async (ctx, args) => { + await ctx.reply({ content: 'Pong 🏓' }); + }, +}); +``` +Can you predict the behavior of this command? + +- Before loading into sern, this command module will check if this module is in the correct directory `other`. +- Before an event occurs, this command module will check if the user has the id `182326315813306368`. + +:::tip +Event Plugins are good for filtering, preconditions, parsing. +::: + +If all plugins return `controller.next()`, this command replies `Pong 🏓` \ No newline at end of file diff --git a/docs/guide/walkthrough/sern-emitter.md b/docs/guide/walkthrough/sern-emitter.md new file mode 100644 index 000000000..ddbcbb21e --- /dev/null +++ b/docs/guide/walkthrough/sern-emitter.md @@ -0,0 +1,13 @@ +--- +sidebar_position: 6 +--- + +# The SernEmitter class +You're shipped with the SernEmitter. This EventEmitter listens to +- command modules executing and its status, the `module.activate` event +- command modules registered and its status, the `module.register` event +- any error that occurs, the `error` event +- `warn` events, where it is possible to throw errors + +You can put these and other event listeners into [event modules](./first-event.md)! +
-
-
-
- This config file, although not necessary, allows your project to communicate with our cli. For example, - when installing typescript plugins, the language property is necessary to install from our open source - repository. Using the cli and running sern init --sync on pre-existing projects should install this json - file in the root directory given. Or, if this is a brand-new project, sern init automatically installs it. -
- - - - -