mirror of
https://github.com/sern-handler/handler
synced 2026-06-06 01:16:55 +00:00
Compare commits
13 Commits
v4.2.0
...
jacoobes-p
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
62ff8e9d69 | ||
|
|
70c6236802 | ||
|
|
1f25aa64b9 | ||
|
|
7cddee30aa | ||
|
|
e7286eee9f | ||
|
|
a67450328e | ||
|
|
47401f46a3 | ||
|
|
1059065980 | ||
|
|
974c30fa6c | ||
|
|
3a569726d8 | ||
|
|
1b7f2a49a8 | ||
|
|
97fa2a2d78 | ||
|
|
a52ad270d8 |
6
.github/workflows/npm-publish.yml
vendored
6
.github/workflows/npm-publish.yml
vendored
@@ -13,9 +13,9 @@ jobs:
|
||||
- uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3
|
||||
- uses: actions/setup-node@1a4442cacd436585916779262731d5b162bc6ec7 # v3
|
||||
with:
|
||||
node-version: 17
|
||||
- run: yarn --immutable
|
||||
- run: yarn build:prod
|
||||
node-version: 18
|
||||
- run: npm i
|
||||
- run: npm run build:prod
|
||||
- uses: JS-DevTools/npm-publish@0f451a94170d1699fd50710966d48fb26194d939 # v1
|
||||
with:
|
||||
token: ${{ secrets.NPM_TOKEN }}
|
||||
|
||||
5
.github/workflows/test.yml
vendored
5
.github/workflows/test.yml
vendored
@@ -24,6 +24,5 @@ jobs:
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
cache: 'npm'
|
||||
- run: npm install -g yarn
|
||||
- run: yarn install
|
||||
- run: yarn test
|
||||
- run: npm install
|
||||
- run: npm run test
|
||||
|
||||
873
.yarn/releases/yarn-3.5.1.cjs
vendored
873
.yarn/releases/yarn-3.5.1.cjs
vendored
File diff suppressed because one or more lines are too long
@@ -1,5 +0,0 @@
|
||||
enableGlobalCache: true
|
||||
|
||||
nodeLinker: node-modules
|
||||
|
||||
yarnPath: .yarn/releases/yarn-3.5.1.cjs
|
||||
14
CHANGELOG.md
14
CHANGELOG.md
@@ -1,5 +1,19 @@
|
||||
# Changelog
|
||||
|
||||
## [4.2.2](https://github.com/sern-handler/handler/compare/v4.2.1...v4.2.2) (2025-02-03)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* faster autocomplete lookup ([#387](https://github.com/sern-handler/handler/issues/387)) ([974c30f](https://github.com/sern-handler/handler/commit/974c30fa6cccaae7b1c2c3246ffa9eecb6bc7bf9))
|
||||
|
||||
## [4.2.1](https://github.com/sern-handler/handler/compare/v4.2.0...v4.2.1) (2025-01-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* context-interactions error ([#382](https://github.com/sern-handler/handler/issues/382)) ([a52ad27](https://github.com/sern-handler/handler/commit/a52ad270d843e92db5bf2049d07527eed59d428c))
|
||||
|
||||
## [4.2.0](https://github.com/sern-handler/handler/compare/v4.1.1...v4.2.0) (2025-01-18)
|
||||
|
||||
|
||||
|
||||
28
README.md
28
README.md
@@ -7,6 +7,7 @@
|
||||
|
||||
<div align="center" styles="margin-top: 10px">
|
||||
<img src="https://img.shields.io/badge/open-source-brightgreen" />
|
||||
<img src="https://img.shields.io/badge/built_with-sern-pink?labelColor=%230C3478&color=%23ed5087&link=https%3A%2F%2Fsern.dev"/>
|
||||
<a href="https://www.npmjs.com/package/@sern/handler"><img src="https://img.shields.io/npm/v/@sern/handler?maxAge=3600" alt="NPM version" /></a>
|
||||
<a href="https://www.npmjs.com/package/@sern/handler"><img src="https://img.shields.io/npm/dt/@sern/handler?maxAge=3600" alt="NPM downloads" /></a>
|
||||
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-brightgreen" alt="License MIT" /></a>
|
||||
@@ -19,7 +20,7 @@
|
||||
- Lightweight. Does a lot while being small.
|
||||
- Latest features. Support for discord.js v14 and all of its interactions.
|
||||
- Start quickly. Plug and play or customize to your liking.
|
||||
- works with [bun](https://bun.sh/) and [node](https://nodejs.org/en) out the box!
|
||||
- Works with [bun](https://bun.sh/) and [node](https://nodejs.org/en) out the box!
|
||||
- Use it with TypeScript or JavaScript. CommonJS and ESM supported.
|
||||
- Active and growing community, always here to help. [Join us](https://sern.dev/discord)
|
||||
- Unleash its full potential with a powerful CLI and awesome plugins.
|
||||
@@ -43,20 +44,29 @@ export default commandModule({
|
||||
```
|
||||
</details>
|
||||
|
||||
# Show off your sern Discord Bot!
|
||||
|
||||
## Badge
|
||||
- Copy this and add it to your [README.md](https://img.shields.io/badge/built_with-sern-pink?labelColor=%230C3478&color=%23ed5087&link=https%3A%2F%2Fsern.dev)
|
||||
<img src="https://img.shields.io/badge/built_with-sern-pink?labelColor=%230C3478&color=%23ed5087&link=https%3A%2F%2Fsern.dev">
|
||||
|
||||
## 🤖 Bots Using sern
|
||||
- [Community Bot](https://github.com/sern-handler/sern-community), the community bot for our [discord server](https://sern.dev/discord).
|
||||
- [Vinci](https://github.com/SrIzan10/vinci), the bot for Mara Turing.
|
||||
- [Bask](https://github.com/baskbotml/bask), Listen your favorite artists on Discord.
|
||||
- [Murayama](https://github.com/murayamabot/murayama), :pepega:
|
||||
- [Protector](https://github.com/GlitchApotamus/Protector), Just a simple bot to help enhance a private minecraft server.
|
||||
- [SmokinWeed 💨](https://github.com/Peter-MJ-Parker/sern-bud), A fun bot for a small - but growing - server.
|
||||
- [Man Nomic](https://github.com/jacoobes/man-nomic), A simple information bot to provide information to the nomic-ai discord community.
|
||||
- [Linear-Discord](https://github.com/sern-handler/linear-discord) Display and manage a linear dashboard.
|
||||
- [Community Bot](https://github.com/sern-handler/sern-community) - The community bot for our [Discord server](https://sern.dev/discord).
|
||||
- [Vinci](https://github.com/SrIzan10/vinci) - The bot for Mara Turing.
|
||||
- [Bask](https://github.com/baskbotml/bask) - Listen to your favorite artists on Discord.
|
||||
- [Murayama](https://github.com/murayamabot/murayama) - :pepega:
|
||||
- [Protector](https://github.com/GlitchApotamus/Protector) - Just a simple bot to help enhance a private Minecraft server.
|
||||
- [SmokinWeed 💨](https://github.com/Peter-MJ-Parker/sern-bud) - A fun bot for a small, but growing server.
|
||||
- [Man Nomic](https://github.com/jacoobes/man-nomic) - A simple information bot to provide information to the nomic-ai Discord community.
|
||||
- [Linear-Discord](https://github.com/sern-handler/linear-discord) - Display and manage a linear dashboard.
|
||||
- [ZenithBot](https://github.com/CodeCraftersHaven/ZenithBot) - A versatile bot coded in TypeScript, designed to enhance server management and user interaction through its robust features.
|
||||
|
||||
## 💻 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 and Guide](https://sern.dev)
|
||||
|
||||
3014
package-lock.json
generated
Normal file
3014
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "@sern/handler",
|
||||
"packageManager": "yarn@3.5.0",
|
||||
"version": "4.2.0",
|
||||
"version": "4.2.2",
|
||||
"description": "A complete, customizable, typesafe, & reactive framework for discord bots.",
|
||||
"main": "./dist/index.js",
|
||||
"module": "./dist/index.js",
|
||||
@@ -20,6 +20,7 @@
|
||||
"prepare": "tsc",
|
||||
"pretty": "prettier --write .",
|
||||
"tdd": "vitest",
|
||||
"benchmark": "vitest bench",
|
||||
"test": "vitest --run",
|
||||
"analyze-imports": "npx depcruise src --include-only \"^src\" --output-type dot | dot -T svg > dependency-graph.svg"
|
||||
},
|
||||
@@ -35,7 +36,7 @@
|
||||
"author": "SernDevs",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@sern/ioc": "^1.1.0",
|
||||
"@sern/ioc": "^1.1.2",
|
||||
"callsites": "^3.1.0",
|
||||
"cron": "^3.1.7",
|
||||
"deepmerge": "^4.3.1"
|
||||
@@ -46,7 +47,7 @@
|
||||
"@types/node-cron": "^3.0.11",
|
||||
"@typescript-eslint/eslint-plugin": "5.58.0",
|
||||
"@typescript-eslint/parser": "5.59.1",
|
||||
"discord.js": "^14.15.3",
|
||||
"discord.js": "^14.14.1",
|
||||
"eslint": "8.39.0",
|
||||
"typescript": "5.0.2",
|
||||
"vitest": "^1.6.0"
|
||||
|
||||
@@ -6,12 +6,12 @@ import type {
|
||||
MessageContextMenuCommandInteraction,
|
||||
ModalSubmitInteraction,
|
||||
UserContextMenuCommandInteraction,
|
||||
AutocompleteInteraction
|
||||
AutocompleteInteraction,
|
||||
} from 'discord.js';
|
||||
import { ApplicationCommandOptionType, InteractionType } from 'discord.js';
|
||||
import { PluginType } from './structures/enums';
|
||||
import assert from 'assert';
|
||||
import type { Payload, UnpackedDependencies } from '../types/utility';
|
||||
import path from 'node:path'
|
||||
|
||||
export const createSDT = (module: Module, deps: UnpackedDependencies, params: string|undefined) => {
|
||||
return {
|
||||
@@ -57,51 +57,31 @@ export function partitionPlugins<T,V>
|
||||
return [controlPlugins, initPlugins] as [T[], V[]];
|
||||
}
|
||||
|
||||
/**
|
||||
* Uses an iterative DFS to check if an autocomplete node exists on the option tree
|
||||
* @param iAutocomplete
|
||||
* @param options
|
||||
*/
|
||||
export function treeSearch(
|
||||
iAutocomplete: AutocompleteInteraction,
|
||||
options: SernOptionsData[] | undefined,
|
||||
): SernAutocompleteData & { parent?: string } | undefined {
|
||||
if (options === undefined) return undefined;
|
||||
//clone to prevent mutation of original command module
|
||||
const _options = options.map(a => ({ ...a }));
|
||||
const subcommands = new Set();
|
||||
while (_options.length > 0) {
|
||||
const cur = _options.pop()!;
|
||||
switch (cur.type) {
|
||||
export const createLookupTable = (options: SernOptionsData[]): Map<string, SernAutocompleteData> => {
|
||||
const table = new Map<string, SernAutocompleteData>();
|
||||
_createLookupTable(table, options, "<parent>");
|
||||
return table;
|
||||
}
|
||||
|
||||
const _createLookupTable = (table: Map<string, SernAutocompleteData>, options: SernOptionsData[], parent: string) => {
|
||||
for (const opt of options) {
|
||||
const name = path.posix.join(parent, opt.name)
|
||||
switch(opt.type) {
|
||||
case ApplicationCommandOptionType.Subcommand: {
|
||||
subcommands.add(cur.name);
|
||||
for (const option of cur.options ?? []) _options.push(option);
|
||||
_createLookupTable(table, opt.options ?? [], name);
|
||||
} break;
|
||||
case ApplicationCommandOptionType.SubcommandGroup: {
|
||||
for (const command of cur.options ?? []) _options.push(command);
|
||||
_createLookupTable(table, opt.options ?? [], name);
|
||||
} break;
|
||||
default: {
|
||||
if ('autocomplete' in cur && cur.autocomplete) {
|
||||
const choice = iAutocomplete.options.getFocused(true);
|
||||
assert( 'command' in cur, 'No `command` property found for option ' + cur.name);
|
||||
if (subcommands.size > 0) {
|
||||
const parent = iAutocomplete.options.getSubcommand();
|
||||
const parentAndOptionMatches =
|
||||
subcommands.has(parent) && cur.name === choice.name;
|
||||
if (parentAndOptionMatches) {
|
||||
return { ...cur, parent };
|
||||
}
|
||||
} else {
|
||||
if (cur.name === choice.name) {
|
||||
return { ...cur, parent: undefined };
|
||||
}
|
||||
}
|
||||
if(Reflect.get(opt, 'autocomplete') === true) {
|
||||
table.set(name, opt as SernAutocompleteData)
|
||||
}
|
||||
} break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
interface InteractionTypable {
|
||||
type: InteractionType;
|
||||
@@ -119,6 +99,9 @@ export function isMessageComponent(i: InteractionTypable): i is AnyMessageCompon
|
||||
export function isCommand(i: InteractionTypable): i is AnyCommandInteraction {
|
||||
return i.type === InteractionType.ApplicationCommand;
|
||||
}
|
||||
export function isContextCommand(i: AnyCommandInteraction): i is MessageContextMenuCommandInteraction | UserContextMenuCommandInteraction {
|
||||
return i.isContextMenuCommand();
|
||||
}
|
||||
export function isAutocomplete(i: InteractionTypable): i is AutocompleteInteraction {
|
||||
return i.type === InteractionType.ApplicationCommandAutocomplete;
|
||||
}
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
import type { Module } from '../types/core-modules'
|
||||
import type { Module, SernAutocompleteData } from '../types/core-modules'
|
||||
import { callPlugins, executeModule } from './event-utils';
|
||||
import { SernError } from '../core/structures/enums'
|
||||
import { createSDT, isAutocomplete, isCommand, isMessageComponent, isModal, resultPayload, treeSearch } from '../core/functions'
|
||||
import { createSDT, isAutocomplete, isCommand, isContextCommand, isMessageComponent, isModal, resultPayload } from '../core/functions'
|
||||
import type { UnpackedDependencies } from '../types/utility';
|
||||
import * as Id from '../core/id'
|
||||
import { Context } from '../core/structures/context';
|
||||
import path from 'node:path';
|
||||
|
||||
|
||||
|
||||
@@ -29,13 +30,28 @@ export function interactionHandler(deps: UnpackedDependencies, defaultPrefix?: s
|
||||
}
|
||||
const { module, params } = modules.at(0)!;
|
||||
let payload;
|
||||
// handles autocomplete
|
||||
if(isAutocomplete(event)) {
|
||||
//@ts-ignore stfu
|
||||
const { command } = treeSearch(event, module.options);
|
||||
payload= { module: command as Module, //autocomplete is not a true "module" warning cast!
|
||||
args: [event, createSDT(command, deps, params)] };
|
||||
const lookupTable = module.locals['@sern/lookup-table'] as Map<string, SernAutocompleteData>
|
||||
const subCommandGroup = event.options.getSubcommandGroup() ?? "",
|
||||
subCommand = event.options.getSubcommand() ?? "",
|
||||
option = event.options.getFocused(true),
|
||||
fullPath = path.posix.join("<parent>", subCommandGroup, subCommand, option.name)
|
||||
|
||||
const resolvedModule = (lookupTable.get(fullPath)!.command) as Module
|
||||
payload= { module: resolvedModule , //autocomplete is not a true "module" warning cast!
|
||||
args: [event, createSDT(module, deps, params)] };
|
||||
// either CommandTypes Slash | ContextMessage | ContextUesr
|
||||
} else if(isCommand(event)) {
|
||||
payload= { module, args: [Context.wrap(event, defaultPrefix), createSDT(module, deps, params)] };
|
||||
const sdt = createSDT(module, deps, params)
|
||||
// handle CommandType.CtxUser || CommandType.CtxMsg
|
||||
if(isContextCommand(event)) {
|
||||
payload= { module, args: [event, sdt] };
|
||||
} else {
|
||||
// handle CommandType.Slash || CommandType.Both
|
||||
payload= { module, args: [Context.wrap(event, defaultPrefix), sdt] };
|
||||
}
|
||||
// handles modals or components
|
||||
} else if (isModal(event) || isMessageComponent(event)) {
|
||||
payload= { module, args: [event, createSDT(module, deps, params)] }
|
||||
} else {
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
import * as Files from '../core/module-loading'
|
||||
import { once } from 'node:events';
|
||||
import { resultPayload } from '../core/functions';
|
||||
import { createLookupTable, resultPayload } from '../core/functions';
|
||||
import { CommandType } from '../core/structures/enums';
|
||||
import { Module } from '../types/core-modules';
|
||||
import { Module, SernOptionsData } from '../types/core-modules';
|
||||
import type { UnpackedDependencies, Wrapper } from '../types/utility';
|
||||
import { callInitPlugins } from './event-utils';
|
||||
import { SernAutocompleteData } from '..';
|
||||
|
||||
export default async function(dirs: string | string[], deps : UnpackedDependencies) {
|
||||
const { '@sern/client': client,
|
||||
@@ -28,6 +29,12 @@ export default async function(dirs: string | string[], deps : UnpackedDependenci
|
||||
throw Error(`Found ${module.name} at ${module.meta.absPath}, which has incorrect \`type\``);
|
||||
}
|
||||
const resultModule = await callInitPlugins(module, deps, true);
|
||||
|
||||
if(module.type === CommandType.Both || module.type === CommandType.Slash) {
|
||||
const options = (Reflect.get(module, 'options') ?? []) as SernOptionsData[];
|
||||
const lookupTable = createLookupTable(options)
|
||||
module.locals['@sern/lookup-table'] = lookupTable;
|
||||
}
|
||||
// FREEZE! no more writing!!
|
||||
commands.set(resultModule.meta.id, Object.freeze(resultModule));
|
||||
sEmitter.emit('module.register', resultPayload('success', resultModule));
|
||||
|
||||
@@ -61,7 +61,7 @@ import { Awaitable, SernEventsMapping, UnpackedDependencies, Dictionary } from '
|
||||
*
|
||||
* @see {@link CommandControlPlugin} for plugin implementation
|
||||
* @see {@link CommandType} for available command types
|
||||
* @see {@link Dependencies} for dependency injection interface
|
||||
* @see {@link Dependencies} for [dependency injection](https://sern.dev/v4/reference/dependencies/) interface
|
||||
*/
|
||||
export type SDT = {
|
||||
/**
|
||||
@@ -114,6 +114,10 @@ export type SDT = {
|
||||
|
||||
export type Processed<T> = T & { name: string; description: string };
|
||||
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export interface Module {
|
||||
type: CommandType | EventType;
|
||||
name?: string;
|
||||
@@ -196,13 +200,18 @@ export interface Module {
|
||||
execute(...args: any[]): Awaitable<any>;
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export interface SernEventCommand<T extends keyof SernEventsMapping = keyof SernEventsMapping>
|
||||
extends Module {
|
||||
name?: T;
|
||||
type: EventType.Sern;
|
||||
execute(...args: SernEventsMapping[T]): Awaitable<unknown>;
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export interface ExternalEventCommand extends Module {
|
||||
name?: string;
|
||||
emitter: keyof Dependencies;
|
||||
@@ -210,83 +219,121 @@ export interface ExternalEventCommand extends Module {
|
||||
execute(...args: unknown[]): Awaitable<unknown>;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export interface ContextMenuUser extends Module {
|
||||
type: CommandType.CtxUser;
|
||||
execute: (ctx: UserContextMenuCommandInteraction, tbd: SDT) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export interface ContextMenuMsg extends Module {
|
||||
type: CommandType.CtxMsg;
|
||||
execute: (ctx: MessageContextMenuCommandInteraction, tbd: SDT) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export interface ButtonCommand extends Module {
|
||||
type: CommandType.Button;
|
||||
execute: (ctx: ButtonInteraction, tbd: SDT) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export interface StringSelectCommand extends Module {
|
||||
type: CommandType.StringSelect;
|
||||
execute: (ctx: StringSelectMenuInteraction, tbd: SDT) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export interface ChannelSelectCommand extends Module {
|
||||
type: CommandType.ChannelSelect;
|
||||
execute: (ctx: ChannelSelectMenuInteraction, tbd: SDT) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export interface RoleSelectCommand extends Module {
|
||||
type: CommandType.RoleSelect;
|
||||
execute: (ctx: RoleSelectMenuInteraction, tbd: SDT) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export interface MentionableSelectCommand extends Module {
|
||||
type: CommandType.MentionableSelect;
|
||||
execute: (ctx: MentionableSelectMenuInteraction, tbd: SDT) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export interface UserSelectCommand extends Module {
|
||||
type: CommandType.UserSelect;
|
||||
execute: (ctx: UserSelectMenuInteraction, tbd: SDT) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export interface ModalSubmitCommand extends Module {
|
||||
type: CommandType.Modal;
|
||||
execute: (ctx: ModalSubmitInteraction, tbd: SDT) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export interface AutocompleteCommand {
|
||||
onEvent?: ControlPlugin[];
|
||||
execute: (ctx: AutocompleteInteraction, tbd: SDT) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export interface DiscordEventCommand<T extends keyof ClientEvents = keyof ClientEvents>
|
||||
extends Module {
|
||||
name?: T;
|
||||
type: EventType.Discord;
|
||||
execute(...args: ClientEvents[T]): Awaitable<unknown>;
|
||||
}
|
||||
/**
|
||||
* @since 1.0.0
|
||||
* @see @link {commandModule} to create a text command
|
||||
*/
|
||||
export interface TextCommand extends Module {
|
||||
type: CommandType.Text;
|
||||
execute: (ctx: Context & { get options(): string[] }, tbd: SDT) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
* @see @link {commandModule} to create a slash command
|
||||
*/
|
||||
export interface SlashCommand extends Module {
|
||||
type: CommandType.Slash;
|
||||
description: string;
|
||||
options?: SernOptionsData[];
|
||||
execute: (ctx: Context & { get options(): ChatInputCommandInteraction['options']}, tbd: SDT) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
* @see @link {commandModule} to create a both command
|
||||
*/
|
||||
export interface BothCommand extends Module {
|
||||
type: CommandType.Both;
|
||||
description: string;
|
||||
options?: SernOptionsData[];
|
||||
execute: (ctx: Context, tbd: SDT) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export type EventModule = DiscordEventCommand | SernEventCommand | ExternalEventCommand;
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export type CommandModule =
|
||||
| TextCommand
|
||||
| SlashCommand
|
||||
@@ -355,6 +402,7 @@ export type InputCommand = {
|
||||
}[CommandType];
|
||||
|
||||
/**
|
||||
* @see @link {https://sern.dev/v4/reference/autocomplete/}
|
||||
* Type that replaces autocomplete with {@link SernAutocompleteData}
|
||||
*/
|
||||
export type SernOptionsData =
|
||||
@@ -374,7 +422,9 @@ export interface SernSubCommandGroupData extends BaseApplicationCommandOptionsDa
|
||||
options?: SernSubCommandData[];
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @since 4.0.0
|
||||
*/
|
||||
export interface ScheduledTaskContext {
|
||||
|
||||
/**
|
||||
@@ -398,7 +448,9 @@ interface TaskAttrs {
|
||||
*/
|
||||
deps: UnpackedDependencies
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 4.0.0
|
||||
*/
|
||||
export interface ScheduledTask {
|
||||
name?: string;
|
||||
trigger: string | Date;
|
||||
|
||||
84
test/autocomp.bench.ts
Normal file
84
test/autocomp.bench.ts
Normal file
@@ -0,0 +1,84 @@
|
||||
import { describe } from 'node:test'
|
||||
import { bench } from 'vitest'
|
||||
import { SernAutocompleteData, SernOptionsData } from '../src'
|
||||
import { createRandomChoice } from './setup/util'
|
||||
import { ApplicationCommandOptionType, AutocompleteFocusedOption, AutocompleteInteraction } from 'discord.js'
|
||||
import { createLookupTable } from '../src/core/functions'
|
||||
import assert from 'node:assert'
|
||||
|
||||
/**
|
||||
* Uses an iterative DFS to check if an autocomplete node exists on the option tree
|
||||
* This is the old internal method that sern used to resolve autocomplete
|
||||
* @param iAutocomplete
|
||||
* @param options
|
||||
*/
|
||||
function treeSearch(
|
||||
choice: AutocompleteFocusedOption,
|
||||
parent: string|undefined,
|
||||
options: SernOptionsData[] | undefined,
|
||||
): SernAutocompleteData & { parent?: string } | undefined {
|
||||
if (options === undefined) return undefined;
|
||||
//clone to prevent mutation of original command module
|
||||
const _options = options.map(a => ({ ...a }));
|
||||
const subcommands = new Set();
|
||||
while (_options.length > 0) {
|
||||
const cur = _options.pop()!;
|
||||
switch (cur.type) {
|
||||
case ApplicationCommandOptionType.Subcommand: {
|
||||
subcommands.add(cur.name);
|
||||
for (const option of cur.options ?? []) _options.push(option);
|
||||
} break;
|
||||
case ApplicationCommandOptionType.SubcommandGroup: {
|
||||
for (const command of cur.options ?? []) _options.push(command);
|
||||
} break;
|
||||
default: {
|
||||
if ('autocomplete' in cur && cur.autocomplete) {
|
||||
assert( 'command' in cur, 'No `command` property found for option ' + cur.name);
|
||||
if (subcommands.size > 0) {
|
||||
const parentAndOptionMatches =
|
||||
subcommands.has(parent) && cur.name === choice.name;
|
||||
if (parentAndOptionMatches) {
|
||||
return { ...cur, parent };
|
||||
}
|
||||
} else {
|
||||
if (cur.name === choice.name) {
|
||||
return { ...cur, parent: undefined };
|
||||
}
|
||||
}
|
||||
}
|
||||
} break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const options: SernOptionsData[] = [
|
||||
createRandomChoice(),
|
||||
createRandomChoice(),
|
||||
createRandomChoice(),
|
||||
{
|
||||
type: ApplicationCommandOptionType.String,
|
||||
name: 'autocomplete',
|
||||
description: 'here',
|
||||
autocomplete: true,
|
||||
command: { onEvent: [], execute: () => {} },
|
||||
},
|
||||
]
|
||||
|
||||
|
||||
const table = createLookupTable(options)
|
||||
|
||||
|
||||
describe('autocomplete lookup', () => {
|
||||
|
||||
bench('lookup table', () => {
|
||||
table.get('<parent>/autocomplete')
|
||||
}, { time: 500 })
|
||||
|
||||
|
||||
bench('naive treeSearch', () => {
|
||||
treeSearch({ focused: true,
|
||||
name: 'autocomplete',
|
||||
value: 'autocomplete',
|
||||
type: ApplicationCommandOptionType.String }, undefined, options)
|
||||
}, { time: 500 })
|
||||
})
|
||||
@@ -1,29 +1,17 @@
|
||||
//@ts-nocheck
|
||||
|
||||
import { afterEach, describe, expect, it, vi } from 'vitest';
|
||||
import { PluginType, SernOptionsData, controller } from '../../src/index';
|
||||
import { partitionPlugins, treeSearch } from '../../src/core/functions';
|
||||
import { createLookupTable, partitionPlugins, treeSearch } from '../../src/core/functions';
|
||||
import { faker } from '@faker-js/faker';
|
||||
import { ApplicationCommandOptionType, AutocompleteInteraction } from 'discord.js';
|
||||
import { createRandomChoice, createRandomPlugins } from '../setup/util';
|
||||
|
||||
describe('functions', () => {
|
||||
afterEach(() => {
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
function createRandomPlugins(len: number) {
|
||||
const random = () => Math.floor(Math.random() * 2) + 1; // 1 or 2, plugin enum
|
||||
return Array.from({ length: len }, () => ({
|
||||
type: random(),
|
||||
execute: () => (random() === 1 ? controller.next() : controller.stop()),
|
||||
}));
|
||||
}
|
||||
function createRandomChoice() {
|
||||
return {
|
||||
type: faker.number.int({ min: 1, max: 11 }),
|
||||
name: faker.word.noun(),
|
||||
description: faker.word.adjective(),
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
it('should partition plugins correctly', () => {
|
||||
const plugins = createRandomPlugins(100);
|
||||
const [onEvent, init] = partitionPlugins(plugins);
|
||||
@@ -32,12 +20,10 @@ describe('functions', () => {
|
||||
for (const el of init) expect(el.type).to.equal(PluginType.Init);
|
||||
});
|
||||
|
||||
describe('autocomplete', ( ) => {
|
||||
|
||||
it('should tree search options tree depth 1', () => {
|
||||
//@ts-expect-error mocking
|
||||
let autocmpInteraction = new AutocompleteInteraction('autocomplete');
|
||||
const options: SernOptionsData[] = [
|
||||
createRandomChoice(),
|
||||
createRandomChoice(),
|
||||
createRandomChoice(),
|
||||
{
|
||||
type: ApplicationCommandOptionType.String,
|
||||
@@ -47,19 +33,13 @@ describe('functions', () => {
|
||||
command: { onEvent: [], execute: vi.fn() },
|
||||
},
|
||||
];
|
||||
autocmpInteraction.options.getFocused.mockReturnValue({
|
||||
name: 'autocomplete',
|
||||
value: faker.string.alpha(),
|
||||
focused: true,
|
||||
});
|
||||
const result = treeSearch(autocmpInteraction, options);
|
||||
const table = createLookupTable(options)
|
||||
const result = table.get('<parent>/autocomplete')
|
||||
expect(result == undefined).to.be.false;
|
||||
expect(result.name).to.be.eq('autocomplete');
|
||||
expect(result.command).to.be.not.undefined;
|
||||
}),
|
||||
it('should tree search depth 2', () => {
|
||||
//@ts-expect-error mocking
|
||||
let autocmpInteraction = new AutocompleteInteraction('nested');
|
||||
const subcommandName = faker.string.alpha();
|
||||
const options: SernOptionsData[] = [
|
||||
{
|
||||
@@ -83,26 +63,20 @@ describe('functions', () => {
|
||||
],
|
||||
},
|
||||
];
|
||||
autocmpInteraction.options.getSubcommand.mockReturnValue(subcommandName);
|
||||
autocmpInteraction.options.getFocused.mockReturnValue({
|
||||
name: 'nested',
|
||||
value: faker.string.alpha(),
|
||||
focused: true,
|
||||
});
|
||||
const result = treeSearch(autocmpInteraction, options);
|
||||
const table = createLookupTable(options)
|
||||
const result = table.get(`<parent>/${subcommandName}/nested`)
|
||||
expect(result == undefined).to.be.false;
|
||||
expect(result.name).to.be.eq('nested');
|
||||
expect(result.command).to.be.not.undefined;
|
||||
});
|
||||
|
||||
it('should tree search depth n > 2', () => {
|
||||
//@ts-expect-error mocking
|
||||
let autocmpInteraction = new AutocompleteInteraction('nested');
|
||||
const subgroupName = faker.string.alpha()
|
||||
const subcommandName = faker.string.alpha();
|
||||
const options: SernOptionsData[] = [
|
||||
{
|
||||
type: ApplicationCommandOptionType.SubcommandGroup,
|
||||
name: faker.string.alpha(),
|
||||
name: subgroupName,
|
||||
description: faker.string.alpha(),
|
||||
options: [
|
||||
{
|
||||
@@ -128,24 +102,20 @@ describe('functions', () => {
|
||||
],
|
||||
},
|
||||
];
|
||||
autocmpInteraction.options.getSubcommand.mockReturnValue(subcommandName);
|
||||
autocmpInteraction.options.getFocused.mockReturnValue({
|
||||
name: 'nested',
|
||||
value: faker.string.alpha(),
|
||||
focused: true,
|
||||
});
|
||||
const result = treeSearch(autocmpInteraction, options);
|
||||
const table = createLookupTable(options)
|
||||
const result = table.get(`<parent>/${subgroupName}/${subcommandName}/nested`)
|
||||
expect(result == undefined).to.be.false;
|
||||
expect(result.name).to.be.eq('nested');
|
||||
expect(result.command).to.be.not.undefined;
|
||||
});
|
||||
|
||||
it('should correctly resolve suboption of the same name given two subcommands ', () => {
|
||||
let autocmpInteraction = new AutocompleteInteraction('nested');
|
||||
const subcommandName = faker.string.alpha();
|
||||
const groupname = faker.string.alpha()
|
||||
const options: SernOptionsData[] = [
|
||||
{
|
||||
type: ApplicationCommandOptionType.SubcommandGroup,
|
||||
name: faker.string.alpha(),
|
||||
name: groupname,
|
||||
description: faker.string.alpha(),
|
||||
options: [
|
||||
{
|
||||
@@ -188,24 +158,19 @@ describe('functions', () => {
|
||||
],
|
||||
},
|
||||
];
|
||||
autocmpInteraction.options.getSubcommand.mockReturnValue(subcommandName);
|
||||
autocmpInteraction.options.getFocused.mockReturnValue({
|
||||
name: 'nested',
|
||||
value: faker.string.alpha(),
|
||||
focused: true,
|
||||
});
|
||||
const result = treeSearch(autocmpInteraction, options);
|
||||
const table = createLookupTable(options)
|
||||
const result = table.get(`<parent>/${groupname}/${subcommandName}/nested`);
|
||||
expect(result).toBeTruthy();
|
||||
expect(result.name).to.be.eq('nested');
|
||||
expect(result.command).to.be.not.undefined;
|
||||
});
|
||||
it('two subcommands with an option of the same name', () => {
|
||||
let autocmpInteraction = new AutocompleteInteraction('nested');
|
||||
const groupName = faker.string.alpha()
|
||||
const subcommandName = faker.string.alpha();
|
||||
const options: SernOptionsData[] = [
|
||||
{
|
||||
type: ApplicationCommandOptionType.SubcommandGroup,
|
||||
name: faker.string.alpha(),
|
||||
name: groupName,
|
||||
description: faker.string.alpha(),
|
||||
options: [
|
||||
{
|
||||
@@ -229,7 +194,7 @@ describe('functions', () => {
|
||||
},
|
||||
{
|
||||
type: ApplicationCommandOptionType.Subcommand,
|
||||
name: subcommandName + 'a',
|
||||
name: subcommandName + 'anothera',
|
||||
description: faker.string.alpha(),
|
||||
options: [
|
||||
createRandomChoice(),
|
||||
@@ -248,36 +213,24 @@ describe('functions', () => {
|
||||
],
|
||||
},
|
||||
];
|
||||
autocmpInteraction.options.getSubcommand.mockReturnValue(subcommandName);
|
||||
autocmpInteraction.options.getFocused.mockReturnValue({
|
||||
name: 'nested',
|
||||
value: faker.string.alpha(),
|
||||
focused: true,
|
||||
});
|
||||
const result = treeSearch(autocmpInteraction, options);
|
||||
|
||||
const table = createLookupTable(options)
|
||||
const result = table.get(`<parent>/${groupName}/${subcommandName}/nested`);
|
||||
expect(result).toBeTruthy();
|
||||
expect(result.name).to.be.eq('nested');
|
||||
expect(result.command).to.be.not.undefined;
|
||||
|
||||
let autocmpInteraction2 = new AutocompleteInteraction('nested');
|
||||
autocmpInteraction2.options.getSubcommand.mockReturnValue(subcommandName + 'a');
|
||||
autocmpInteraction2.options.getFocused.mockReturnValue({
|
||||
name: 'nested',
|
||||
value: faker.string.alpha(),
|
||||
focused: true,
|
||||
});
|
||||
const result2 = treeSearch(autocmpInteraction2, options);
|
||||
expect(result2).toBeTruthy();
|
||||
expect(result2?.name).toEqual('nested');
|
||||
|
||||
});
|
||||
|
||||
it('simulates autocomplete typing and resolution', () => {
|
||||
const subcommandGroupName = faker.string.alpha()
|
||||
const subcommandName = faker.string.alpha();
|
||||
const optionName = faker.word.noun();
|
||||
const options: SernOptionsData[] = [
|
||||
{
|
||||
type: ApplicationCommandOptionType.SubcommandGroup,
|
||||
name: faker.string.alpha(),
|
||||
name: subcommandGroupName,
|
||||
description: faker.string.alpha(),
|
||||
options: [
|
||||
{
|
||||
@@ -322,18 +275,20 @@ describe('functions', () => {
|
||||
];
|
||||
let accumulator = '';
|
||||
let result: unknown;
|
||||
const table = createLookupTable(options)
|
||||
for (const char of optionName) {
|
||||
accumulator += char;
|
||||
|
||||
const autocomplete = new AutocompleteInteraction(accumulator);
|
||||
autocomplete.options.getSubcommand.mockReturnValue(subcommandName);
|
||||
autocomplete.options.getFocused.mockReturnValue({
|
||||
const focusedValue = {
|
||||
name: accumulator,
|
||||
value: faker.string.alpha(),
|
||||
focused: true,
|
||||
});
|
||||
result = treeSearch(autocomplete, options);
|
||||
};
|
||||
result = table.get(`<parent>/${subcommandGroupName}/${subcommandName}/${focusedValue.name}` );
|
||||
}
|
||||
expect(result).toBeTruthy();
|
||||
});
|
||||
})
|
||||
|
||||
|
||||
});
|
||||
|
||||
@@ -28,3 +28,21 @@ export function createRandomModule(plugins: any[]): Processed<Module> {
|
||||
execute: vi.fn(),
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
export function createRandomChoice() {
|
||||
return {
|
||||
type: faker.number.int({ min: 1, max: 11 }),
|
||||
name: faker.word.noun(),
|
||||
description: faker.word.adjective(),
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
export function createRandomPlugins(len: number) {
|
||||
const random = () => Math.floor(Math.random() * 2) + 1; // 1 or 2, plugin enum
|
||||
return Array.from({ length: len }, () => ({
|
||||
type: random(),
|
||||
execute: () => (random() === 1 ? controller.next() : controller.stop()),
|
||||
}));
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user