mirror of
https://github.com/sern-handler/handler
synced 2026-06-06 01:16:55 +00:00
Compare commits
251 Commits
v2.0.0
...
release-pl
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
45a9543795 | ||
|
|
0eecb08e87 | ||
|
|
c67748c7df | ||
|
|
efee0fdbe2 | ||
|
|
797442ece3 | ||
|
|
513ac8edf4 | ||
|
|
81a0180d05 | ||
|
|
89d7409536 | ||
|
|
aa802f761e | ||
|
|
2414992b73 | ||
|
|
70c6236802 | ||
|
|
1f25aa64b9 | ||
|
|
7cddee30aa | ||
|
|
e7286eee9f | ||
|
|
a67450328e | ||
|
|
47401f46a3 | ||
|
|
1059065980 | ||
|
|
974c30fa6c | ||
|
|
3a569726d8 | ||
|
|
1b7f2a49a8 | ||
|
|
97fa2a2d78 | ||
|
|
a52ad270d8 | ||
|
|
3f703c17b8 | ||
|
|
f9e7eaf92d | ||
|
|
52e145600d | ||
|
|
59d08ef207 | ||
|
|
7deb79e907 | ||
|
|
f2d4b5bda1 | ||
|
|
a575b3ed74 | ||
|
|
2042559b4d | ||
|
|
220a60ecf8 | ||
|
|
55715d5659 | ||
|
|
d0c3b7469e | ||
|
|
eabfb81819 | ||
|
|
1789ccb2f2 | ||
|
|
25c5891ade | ||
|
|
2106cdc1d0 | ||
|
|
61e82fdc7b | ||
|
|
3755b95b1a | ||
|
|
06807ea77f | ||
|
|
3fd3f1c236 | ||
|
|
92623d2914 | ||
|
|
a91f260a86 | ||
|
|
dda0e3395b | ||
|
|
9a8904f5ae | ||
|
|
04c4625bfa | ||
|
|
91b3768e37 | ||
|
|
d6f49d1d97 | ||
|
|
8ecd30cf18 | ||
|
|
a19edaf883 | ||
|
|
90e55dfa14 | ||
|
|
2106522812 | ||
|
|
ce8c4bf649 | ||
|
|
e89b918390 | ||
|
|
f8b69ae542 | ||
|
|
48f9f6ec16 | ||
|
|
86ebb221ed | ||
|
|
4efdbb21fb | ||
|
|
07b11b357b | ||
|
|
ac7f47c590 | ||
| 45cbda7b42 | |||
|
|
5cad432589 | ||
|
|
044a10dace | ||
|
|
9d5c6c714f | ||
|
|
4f2387119a | ||
|
|
a6fa4e3dcb | ||
|
|
c281832db2 | ||
|
|
a359f73fa2 | ||
| 655bb8d358 | |||
| e8d5029834 | |||
|
|
b0399f9507 | ||
|
|
b962dae36c | ||
|
|
c73cf96cb2 | ||
|
|
7458befe8a | ||
|
|
efe49391e8 | ||
|
|
3140f80c10 | ||
|
|
504cdee7b2 | ||
|
|
c7661f272c | ||
|
|
daac37c288 | ||
|
|
a579e272d0 | ||
|
|
2051aa1ac0 | ||
|
|
237c8537c6 | ||
|
|
77fb00d386 | ||
|
|
89f6bbb975 | ||
|
|
8ef4ee87e9 | ||
|
|
fd39858636 | ||
|
|
132b625070 | ||
|
|
03439fec43 | ||
|
|
fc87e99ed0 | ||
|
|
a08541a8e7 | ||
|
|
8bd5eb4949 | ||
|
|
e1059f93f7 | ||
|
|
800531453f | ||
|
|
c9f2d75665 | ||
|
|
e59e0b9d40 | ||
|
|
26ccd118ff | ||
|
|
4b97d86908 | ||
|
|
b1c82448bd | ||
|
|
d80081384a | ||
|
|
50253ca322 | ||
|
|
215aca2f46 | ||
|
|
a7f5ea269f | ||
|
|
52d6368440 | ||
|
|
1e723a4154 | ||
|
|
5fe13f43d2 | ||
|
|
ab9d39306a | ||
|
|
d429f3adbf | ||
|
|
5e011b471e | ||
|
|
41344608c6 | ||
|
|
7a72cc4fe3 | ||
|
|
70cca0dbb0 | ||
|
|
7798e36458 | ||
|
|
9144485c39 | ||
|
|
cf15b67ede | ||
|
|
57cc94ff81 | ||
|
|
6a2a5b4565 | ||
|
|
5fdc1eda7f | ||
|
|
e00d1df32e | ||
|
|
31c221bd5e | ||
|
|
0aba4a6606 | ||
|
|
e9c7661804 | ||
|
|
446417bfb9 | ||
|
|
6b58ef731b | ||
|
|
b62129bf04 | ||
|
|
3d121ff01c | ||
|
|
d201087d4f | ||
|
|
1af4a2bed4 | ||
|
|
edcaed083e | ||
|
|
a4fe2c50df | ||
|
|
9ea991626d | ||
|
|
64f20f1cf5 | ||
|
|
41cc72fe63 | ||
|
|
d983f95906 | ||
|
|
c1f690633c | ||
|
|
8544d301ef | ||
|
|
52bcba9cfc | ||
|
|
21febd2c90 | ||
|
|
11daebb30a | ||
|
|
b817f98c10 | ||
|
|
563f583318 | ||
|
|
e4c7bfe686 | ||
|
|
69fa4908c3 | ||
|
|
4fa28d605f | ||
|
|
079b554f8b | ||
|
|
dec56335b9 | ||
|
|
50be972d4f | ||
|
|
507d183970 | ||
|
|
90edd4f91e | ||
|
|
5f11142599 | ||
|
|
7a635f9978 | ||
|
|
a17aeac558 | ||
|
|
af6ebed348 | ||
|
|
2f96b7634d | ||
|
|
97741faa69 | ||
|
|
94070d99e8 | ||
|
|
473be775f0 | ||
|
|
36af102251 | ||
|
|
cee740ea3f | ||
|
|
2fd7697300 | ||
|
|
f9609ce6cd | ||
|
|
a3064aa915 | ||
|
|
0a53a48521 | ||
|
|
05037b5315 | ||
|
|
06a3e69210 | ||
|
|
74c4b77d4b | ||
|
|
d381ff568e | ||
|
|
6db5c71506 | ||
|
|
507c9e7939 | ||
|
|
09610d0501 | ||
|
|
0862bf92d0 | ||
|
|
62162f6b8c | ||
|
|
eb501db09a | ||
|
|
964848a4e2 | ||
|
|
78dead1b49 | ||
|
|
39e6d6d2f9 | ||
|
|
5aff57ed6d | ||
|
|
4095471346 | ||
|
|
f7b9c52df1 | ||
|
|
d20d01524b | ||
|
|
5684c060bc | ||
|
|
ca8b31f280 | ||
|
|
ce9a0831a6 | ||
|
|
3a32968a17 | ||
|
|
e549f8bc3e | ||
|
|
3ab73459ad | ||
|
|
16af2e996d | ||
|
|
4f9a842b0e | ||
|
|
5dfd1a1fc1 | ||
|
|
c45a10c950 | ||
|
|
b45ba34f3c | ||
|
|
facee79c90 | ||
|
|
306eee071d | ||
|
|
00d55208a0 | ||
|
|
49fad801a5 | ||
|
|
c9f44ce72b | ||
|
|
a9a2528faf | ||
|
|
529edb7da5 | ||
|
|
f236dc05e2 | ||
|
|
c78936a225 | ||
|
|
1860b898f3 | ||
|
|
fd10772a9b | ||
|
|
cd36bd8a47 | ||
|
|
dda7f41231 | ||
|
|
371a57194c | ||
|
|
bfcc160a39 | ||
|
|
86fa531eb6 | ||
|
|
58052e94cb | ||
|
|
96f4281121 | ||
|
|
f9ae7c003b | ||
|
|
ec211d5a8d | ||
|
|
3faf83bbf7 | ||
|
|
8eed099503 | ||
|
|
e2874be4e7 | ||
|
|
1d6751a9cd | ||
|
|
f6afafa352 | ||
|
|
b4b195dc95 | ||
|
|
33f14467ec | ||
|
|
cb95105c1c | ||
|
|
845b82feef | ||
|
|
833a323f3c | ||
|
|
42e5f20425 | ||
|
|
2b25e6bfbb | ||
|
|
1a27341092 | ||
|
|
4680e451bb | ||
|
|
917d8b0d1b | ||
|
|
b8492ee45d | ||
|
|
08aac1d67a | ||
|
|
a13df6fb42 | ||
|
|
7089f5c0dc | ||
|
|
559c1a7a7b | ||
|
|
ac27d168e2 | ||
|
|
d1e6ec4589 | ||
|
|
ff379d03be | ||
|
|
1e4e933db2 | ||
|
|
ce960f4c8d | ||
|
|
1130456045 | ||
|
|
1617d2dcc3 | ||
|
|
ddacbd6e38 | ||
|
|
d69819e9fc | ||
|
|
49e4ba623f | ||
|
|
1b6c413fc2 | ||
|
|
e986535935 | ||
|
|
c30aac476c | ||
|
|
f9622d3788 | ||
|
|
f286a24686 | ||
|
|
166934d749 | ||
|
|
01d79177e8 | ||
|
|
50dac7fb46 | ||
|
|
714d23d401 | ||
|
|
565c4fc35a | ||
|
|
8d18c4b182 |
13
.eslintrc
13
.eslintrc
@@ -1,13 +0,0 @@
|
||||
{
|
||||
"parser": "@typescript-eslint/parser",
|
||||
"extends": ["plugin:@typescript-eslint/recommended"],
|
||||
"parserOptions": { "ecmaVersion": "latest", "sourceType": "script" },
|
||||
"rules": {
|
||||
"@typescript-eslint/no-non-null-assertion": "off",
|
||||
"quotes": [2, "single", { "avoidEscape": true, "allowTemplateLiterals": true }],
|
||||
"semi": ["error", "always"],
|
||||
"@typescript-eslint/no-empty-interface": 0,
|
||||
"@typescript-eslint/ban-types" : 0,
|
||||
"@typescript-eslint/no-explicit-any": "off"
|
||||
}
|
||||
}
|
||||
1
.github/FUNDING.yml
vendored
Normal file
1
.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1 @@
|
||||
open_collective: sern
|
||||
36
.github/SECURITY.md
vendored
36
.github/SECURITY.md
vendored
@@ -6,13 +6,43 @@ Project is currently under heavy development but you can try out our [npm packag
|
||||
|
||||
| Version | Supported |
|
||||
| ------- | ------------------ |
|
||||
| 0.1.0 @ dev | :white_check_mark: |
|
||||
| 2.6.1 | YES |
|
||||
| 2.6.0 | YES |
|
||||
| 2.5.3 | YES |
|
||||
| 2.5.2 | YES |
|
||||
| 2.5.1 | YES |
|
||||
| 2.5.0 | YES |
|
||||
| 2.1.1 | NO |
|
||||
| 2.1.0 | NO |
|
||||
| 2.0.0 | NO |
|
||||
| 1.2.1 | NO |
|
||||
| 1.2.0 | NO |
|
||||
| 1.1.0 | NO |
|
||||
1.0.1 | NO
|
||||
1.0.0 | NO
|
||||
1.1.9 @ beta | NO
|
||||
1.1.8 @ beta | NO
|
||||
1.1.7 @ beta | NO
|
||||
1.1.6 @ beta | NO
|
||||
1.1.5 @ beta | NO
|
||||
1.1.4 @ beta | NO
|
||||
1.1.3 @ beta | NO
|
||||
1.1.2 @ beta | NO
|
||||
1.1.1 @ beta | NO
|
||||
1.1.0 @ beta | NO
|
||||
1.0.4 @ beta | NO
|
||||
1.0.3 @ beta | NO
|
||||
1.0.2 @ beta | NO
|
||||
1.0.1 @ beta | NO
|
||||
1.0.0 @ beta | NO
|
||||
0.0.1 @ dev | NO (TRY IT)
|
||||
|
||||
* Dev versions might include bugs, use it with your own risk.
|
||||
|
||||
* Dev versions might include bugs and not supported use stable versions.
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
You can report a vulnerability by opening an issue on the [project's GitHub](https://github.com/SernHandler/Sern/issues) repository.
|
||||
You can report a vulnerability by opening an issue on the [project's GitHub](https://github.com/sern-handler/handler/issues) repository.
|
||||
|
||||
Please provide as much information as possible when reporting a vulnerability. We are looking information for, the affected version, and the steps to reproduce the vulnerability.
|
||||
|
||||
|
||||
37
.github/workflows/codeql-analysis.yml
vendored
37
.github/workflows/codeql-analysis.yml
vendored
@@ -1,37 +0,0 @@
|
||||
name: "CodeQL"
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main ]
|
||||
pull_request:
|
||||
branches: [ main ]
|
||||
schedule:
|
||||
- cron: '37 20 * * 4'
|
||||
|
||||
jobs:
|
||||
analyze:
|
||||
name: Analyze
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
actions: read
|
||||
contents: read
|
||||
security-events: write
|
||||
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
language: [ 'javascript' ]
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Initialize CodeQL
|
||||
uses: github/codeql-action/init@v2
|
||||
with:
|
||||
languages: ${{ matrix.language }}
|
||||
- name: Autobuild
|
||||
uses: github/codeql-action/autobuild@v2
|
||||
|
||||
- name: Perform CodeQL Analysis
|
||||
uses: github/codeql-action/analyze@v2
|
||||
44
.github/workflows/continuous-integration.yml
vendored
44
.github/workflows/continuous-integration.yml
vendored
@@ -1,44 +0,0 @@
|
||||
name: Continuous Integration
|
||||
|
||||
on:
|
||||
# Trigger the workflow on push or pull request or custom
|
||||
push:
|
||||
branches:
|
||||
main
|
||||
pull_request_target:
|
||||
branches:
|
||||
main
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
Prettier:
|
||||
name: Run Prettier
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Check out Git repository
|
||||
uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # tag=v3
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@8c91899e586c5b171469028077307d293428b516 # tag=v3
|
||||
with:
|
||||
node-version: 17
|
||||
|
||||
# Prettier must be in `package.json`
|
||||
- name: Install Node.js dependencies
|
||||
run: npm i -g prettier && npm i
|
||||
|
||||
- name: Run Prettier
|
||||
run: prettier --write .
|
||||
|
||||
- name: Create Pull Request
|
||||
id: cpr
|
||||
uses: peter-evans/create-pull-request@v4
|
||||
with:
|
||||
commit-message: "style: pretty please"
|
||||
branch: prettier
|
||||
delete-branch: true
|
||||
branch-suffix: short-commit-hash
|
||||
title: "style: pretty please"
|
||||
body: "pretty pretty prettier"
|
||||
reviewers: EvolutionX-10
|
||||
4
.github/workflows/dependency-review.yml
vendored
4
.github/workflows/dependency-review.yml
vendored
@@ -15,6 +15,6 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: 'Checkout Repository'
|
||||
uses: actions/checkout@v3
|
||||
uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3
|
||||
- name: 'Dependency Review'
|
||||
uses: actions/dependency-review-action@v2
|
||||
uses: actions/dependency-review-action@0efb1d1d84fc9633afcdaad14c485cbbc90ef46c # v2
|
||||
|
||||
34
.github/workflows/npm-publish-dev.yml
vendored
Normal file
34
.github/workflows/npm-publish-dev.yml
vendored
Normal file
@@ -0,0 +1,34 @@
|
||||
name: Continuous Delivery
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- 'src/**'
|
||||
- 'package.json'
|
||||
|
||||
jobs:
|
||||
Publish:
|
||||
name: Publishing Dev
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Check out Git repository
|
||||
uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@1a4442cacd436585916779262731d5b162bc6ec7 # v3
|
||||
with:
|
||||
node-version: 18
|
||||
registry-url: 'https://registry.npmjs.org'
|
||||
|
||||
- name: Install Node.js dependencies
|
||||
run: npm i && npm run build:dev
|
||||
|
||||
- name: Publish to npm
|
||||
run: |
|
||||
npm version premajor --preid "dev.$(git rev-parse --verify --short HEAD)" --git-tag-version=false
|
||||
npm publish --tag dev
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
36
.github/workflows/npm-publish.yml
vendored
36
.github/workflows/npm-publish.yml
vendored
@@ -1,30 +1,22 @@
|
||||
name: NPM / Publish
|
||||
|
||||
on:
|
||||
release:
|
||||
types: [created]
|
||||
|
||||
workflow_dispatch:
|
||||
# We only publish if the version of sern handler is different. workflow automatically cancels if verson is the same
|
||||
push:
|
||||
branches:
|
||||
- 'main'
|
||||
jobs:
|
||||
build:
|
||||
test-and-publish:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/setup-node@v3
|
||||
- uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3
|
||||
- uses: actions/setup-node@1a4442cacd436585916779262731d5b162bc6ec7 # v3
|
||||
with:
|
||||
node-version: 16
|
||||
- run: npm ci
|
||||
- run: npm test
|
||||
|
||||
publish-npm:
|
||||
needs: build
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/setup-node@v3
|
||||
node-version: 18
|
||||
- run: npm i
|
||||
- run: npm run build:prod
|
||||
- uses: JS-DevTools/npm-publish@0f451a94170d1699fd50710966d48fb26194d939 # v1
|
||||
with:
|
||||
node-version: 16
|
||||
registry-url: https://registry.npmjs.org/
|
||||
- run: npm ci
|
||||
- run: npm publish
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{secrets.npm_token}}
|
||||
token: ${{ secrets.NPM_TOKEN }}
|
||||
access: "public"
|
||||
|
||||
2
.github/workflows/release-please.yml
vendored
2
.github/workflows/release-please.yml
vendored
@@ -6,7 +6,7 @@ jobs:
|
||||
release-please:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: google-github-actions/release-please-action@v3
|
||||
- uses: google-github-actions/release-please-action@db8f2c60ee802b3748b512940dde88eabd7b7e01 # v3
|
||||
with:
|
||||
release-type: node
|
||||
package-name: release-please-action
|
||||
|
||||
28
.github/workflows/test.yml
vendored
Normal file
28
.github/workflows/test.yml
vendored
Normal file
@@ -0,0 +1,28 @@
|
||||
# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
|
||||
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
|
||||
|
||||
name: Node.js CI
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches: [ "main" ]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
node-version: [18.x, 19.x, 20.x]
|
||||
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@1a4442cacd436585916779262731d5b162bc6ec7 # v3
|
||||
with:
|
||||
node-version: ${{ matrix.node-version }}
|
||||
cache: 'npm'
|
||||
- run: npm install
|
||||
- run: npm run test
|
||||
10
.gitignore
vendored
10
.gitignore
vendored
@@ -87,3 +87,13 @@ dist
|
||||
|
||||
# IntelliJ IDEA Config file
|
||||
.idea/
|
||||
|
||||
# Yarn files
|
||||
.yarn/install-state.gz
|
||||
.yarn/build-state.yml
|
||||
|
||||
.yalc
|
||||
|
||||
yalc.lock
|
||||
|
||||
*.svg
|
||||
|
||||
13
.npmignore
13
.npmignore
@@ -8,6 +8,7 @@ logs
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
.yarn
|
||||
# Runtime data
|
||||
pids
|
||||
*.pid
|
||||
@@ -52,6 +53,7 @@ typings/
|
||||
.node_repl_history
|
||||
|
||||
# Output of 'npm pack'
|
||||
|
||||
*.tgz
|
||||
|
||||
# Yarn Integrity file
|
||||
@@ -79,9 +81,7 @@ typings/
|
||||
# FuseBox cache
|
||||
.fusebox/
|
||||
|
||||
# TypeScript build output
|
||||
dist
|
||||
|
||||
test
|
||||
# VisualStudio Config file
|
||||
.vs
|
||||
|
||||
@@ -108,6 +108,9 @@ tsup.config.js
|
||||
|
||||
tsconfig-base.json
|
||||
|
||||
tsconfig.cjs.json
|
||||
tsconfig-cjs.json
|
||||
|
||||
tsconfig.esm.json
|
||||
tsconfig-esm.json
|
||||
|
||||
renovate.json
|
||||
fortnite
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
{
|
||||
"semi": true,
|
||||
"trailingComma": "all",
|
||||
"singleQuote": true,
|
||||
"printWidth": 100,
|
||||
"tabWidth": 4,
|
||||
"arrowParens": "avoid"
|
||||
}
|
||||
300
CHANGELOG.md
300
CHANGELOG.md
@@ -1,5 +1,305 @@
|
||||
# Changelog
|
||||
|
||||
## [4.2.6](https://github.com/sern-handler/handler/compare/v4.2.5...v4.2.6) (2025-09-22)
|
||||
|
||||
|
||||
### Miscellaneous Chores
|
||||
|
||||
* release 4.2.6 ([#402](https://github.com/sern-handler/handler/issues/402)) ([0eecb08](https://github.com/sern-handler/handler/commit/0eecb08e87e26102030ccf6ef38ddd81051ec373))
|
||||
|
||||
## [4.2.5](https://github.com/sern-handler/handler/compare/v4.2.4...v4.2.5) (2025-08-31)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* make message module warn rather than throwing ([#399](https://github.com/sern-handler/handler/issues/399)) ([797442e](https://github.com/sern-handler/handler/commit/797442ece3999bf2cb6b5ba0688ce0177e72a22f))
|
||||
|
||||
## [4.2.4](https://github.com/sern-handler/handler/compare/v4.2.3...v4.2.4) (2025-03-06)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* flat autocomplete ([#395](https://github.com/sern-handler/handler/issues/395)) ([89d7409](https://github.com/sern-handler/handler/commit/89d74095363befddc3222b9e5c89c35e7c6457b9))
|
||||
|
||||
## [4.2.3](https://github.com/sern-handler/handler/compare/v4.2.2...v4.2.3) (2025-03-04)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* autocomplete sdt.module not present ([#393](https://github.com/sern-handler/handler/issues/393)) ([2414992](https://github.com/sern-handler/handler/commit/2414992b73a40065464b20f2d53826c78fcd3a5f))
|
||||
|
||||
## [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)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* 4.2.0 load multiple directories & `handleModuleErrors` ([#378](https://github.com/sern-handler/handler/issues/378)) ([f9e7eaf](https://github.com/sern-handler/handler/commit/f9e7eaf92d22b76d3d02a1bbe8324ca6813f48f8))
|
||||
|
||||
## [4.1.1](https://github.com/sern-handler/handler/compare/v4.1.0...v4.1.1) (2025-01-13)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove rxjs ([#376](https://github.com/sern-handler/handler/issues/376)) ([59d08ef](https://github.com/sern-handler/handler/commit/59d08ef207c486ce1cf0aba267e6f862838e0dfb))
|
||||
* This puts the light back into lightweight (\- 4.1 MB)
|
||||
|
||||
## [4.1.0](https://github.com/sern-handler/handler/compare/v4.0.3...v4.1.0) (2025-01-06)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* moduleinfo-in-eventplugins ([#373](https://github.com/sern-handler/handler/issues/373)) ([220a60e](https://github.com/sern-handler/handler/commit/220a60ecf853df8d288de2533c669562a430c3f9))
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* update github username ([#371](https://github.com/sern-handler/handler/issues/371)) ([55715d5](https://github.com/sern-handler/handler/commit/55715d565990fe686159f3c1eda3754d1262c72c))
|
||||
|
||||
## [4.0.3](https://github.com/sern-handler/handler/compare/v4.0.2...v4.0.3) (2024-10-06)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* async presence ([#369](https://github.com/sern-handler/handler/issues/369)) ([eabfb81](https://github.com/sern-handler/handler/commit/eabfb81819b53a4656d8eac6e21cfb488b724a42))
|
||||
* fix eventModule typing for Discord events ([#368](https://github.com/sern-handler/handler/issues/368)) ([1789ccb](https://github.com/sern-handler/handler/commit/1789ccb2f22f502f87538fecdb07106ff7110434))
|
||||
|
||||
## [4.0.2](https://github.com/sern-handler/handler/compare/v4.0.1...v4.0.2) (2024-08-13)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* type issue ([2106cdc](https://github.com/sern-handler/handler/commit/2106cdc1d033f88b6ee4ccca6754fe7a595a9328))
|
||||
|
||||
## [4.0.1](https://github.com/sern-handler/handler/compare/v4.0.0...v4.0.1) (2024-07-19)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add SDT typings to autocomplete commands ([#363](https://github.com/sern-handler/handler/issues/363)) ([92623d2](https://github.com/sern-handler/handler/commit/92623d2914fb80e31365f06cf896bb37f36fc814))
|
||||
|
||||
## [4.0.0](https://github.com/sern-handler/handler/compare/v3.3.4...v4.0.0) (2024-07-18)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* v4 ([#361](https://github.com/sern-handler/handler/issues/361)) ([9a8904f](https://github.com/sern-handler/handler/commit/9a8904f5aed4fa36b018ad73bbe58049bae33274))
|
||||
|
||||
|
||||
### Miscellaneous Chores
|
||||
|
||||
* release 4.0.0 ([dda0e33](https://github.com/sern-handler/handler/commit/dda0e3395b6704862bfd3fda2a201e2cb9b45d2f))
|
||||
|
||||
## [3.3.4](https://github.com/sern-handler/handler/compare/v3.3.3...v3.3.4) (2024-03-18)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* sern emitter err ([#358](https://github.com/sern-handler/handler/issues/358)) ([90e55df](https://github.com/sern-handler/handler/commit/90e55dfa1466c91e5da48922251309331921b1ef))
|
||||
|
||||
## [3.3.3](https://github.com/sern-handler/handler/compare/v3.3.2...v3.3.3) (2024-02-25)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* rm deprecated class modules, clean up, rm indirection ([#355](https://github.com/sern-handler/handler/issues/355)) ([48f9f6e](https://github.com/sern-handler/handler/commit/48f9f6ec16e650d574bd24dcbb0ed176933bfe17))
|
||||
* singleton init not being fired when inserting function ([07b11b3](https://github.com/sern-handler/handler/commit/07b11b357baac0c3c7055c022bc353995c80f766))
|
||||
* typings and cleanup ([#356](https://github.com/sern-handler/handler/issues/356)) ([ce8c4bf](https://github.com/sern-handler/handler/commit/ce8c4bf6492b9680fb1c1a530d3e0028f214ad2f))
|
||||
|
||||
## [3.3.2](https://github.com/sern-handler/handler/compare/v3.3.1...v3.3.2) (2024-01-08)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* presence feature not working on cjs applications ([#351](https://github.com/sern-handler/handler/issues/351)) ([4f23871](https://github.com/sern-handler/handler/commit/4f2387119acfde036d0d1626553e9050f55627d1))
|
||||
|
||||
## [3.3.1](https://github.com/sern-handler/handler/compare/v3.3.0...v3.3.1) (2024-01-07)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* crashing when slash command is used as text command ([#349](https://github.com/sern-handler/handler/issues/349)) ([a359f73](https://github.com/sern-handler/handler/commit/a359f73fa24127a4964d411c8c1c0dfea5edc0f1))
|
||||
|
||||
|
||||
### Reverts
|
||||
|
||||
* the last commit ([655bb8d](https://github.com/sern-handler/handler/commit/655bb8d35815fe0ce9797d8b169310a07b284ae0))
|
||||
|
||||
## [3.3.0](https://github.com/sern-handler/handler/compare/v3.2.1...v3.3.0) (2023-12-27)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* presence ([#345](https://github.com/sern-handler/handler/issues/345)) ([7458bef](https://github.com/sern-handler/handler/commit/7458befe8a5900480cd71900df02a8364837dc00))
|
||||
|
||||
## [3.2.1](https://github.com/sern-handler/handler/compare/v3.2.0...v3.2.1) (2023-12-21)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* logger swap failing ([daac37c](https://github.com/sern-handler/handler/commit/daac37c28858c42b21042bdcb8141239db634e7d))
|
||||
|
||||
## [3.2.0](https://github.com/sern-handler/handler/compare/v3.1.1...v3.2.0) (2023-12-15)
|
||||
|
||||
|
||||
### Miscellaneous Chores
|
||||
|
||||
* release 3.2.0 ([237c853](https://github.com/sern-handler/handler/commit/237c8537c66052309d7e13a7e6e0a4f7995c2558))
|
||||
|
||||
## [3.1.1](https://github.com/sern-handler/handler/compare/v3.1.0...v3.1.1) (2023-11-06)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* queuing events ([fd39858](https://github.com/sern-handler/handler/commit/fd39858636d3038abb6d91021b65c99c488a3d6e))
|
||||
* queuing events ([#332](https://github.com/sern-handler/handler/issues/332)) @Benzo-Fury ([#333](https://github.com/sern-handler/handler/issues/333)) ([fd39858](https://github.com/sern-handler/handler/commit/fd39858636d3038abb6d91021b65c99c488a3d6e))
|
||||
|
||||
## [3.1.0](https://github.com/sern-handler/handler/compare/v3.0.2...v3.1.0) (2023-09-04)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add guaranteed `channelId` and `userId` getters to `Context` ([#320](https://github.com/sern-handler/handler/issues/320)) ([50253ca](https://github.com/sern-handler/handler/commit/50253ca322e7d6dbd2313139c0187a1028f71109))
|
||||
* dispose hooks (deprecate useContainerRaw) ([#323](https://github.com/sern-handler/handler/issues/323)) ([26ccd11](https://github.com/sern-handler/handler/commit/26ccd118ff8cbcde94158a4d09fc0df18da9f254))
|
||||
|
||||
## [3.0.2](https://github.com/sern-handler/handler/compare/v3.0.1...v3.0.2) (2023-08-06)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* invalid id for cts, mts, cjs, mjs files, node paths ([#318](https://github.com/sern-handler/handler/issues/318)) ([a7f5ea2](https://github.com/sern-handler/handler/commit/a7f5ea269fb344e221d10dbdc26a1611ffc8138f))
|
||||
|
||||
## [3.0.1](https://github.com/sern-handler/handler/compare/v3.0.0...v3.0.1) (2023-08-05)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* collectors ([4134460](https://github.com/sern-handler/handler/commit/41344608c677b6069c46412f5f16e4337182ca7d))
|
||||
|
||||
## [3.0.0](https://github.com/sern-handler/handler/compare/v2.6.3...v3.0.0) (2023-07-29)
|
||||
|
||||
|
||||
### ⚠ BREAKING CHANGES
|
||||
|
||||
* v3 ([#294](https://github.com/sern-handler/handler/issues/294))
|
||||
|
||||
### Features
|
||||
|
||||
* v3 ([#294](https://github.com/sern-handler/handler/issues/294)) ([7798e36](https://github.com/sern-handler/handler/commit/7798e36458c7f555d2bcb8a5857a6db47b7211da))
|
||||
|
||||
|
||||
### Miscellaneous Chores
|
||||
|
||||
* release 3.0.0 ([70cca0d](https://github.com/sern-handler/handler/commit/70cca0dbb01e70b47a8c899b1fc4f43dee5ed8ed))
|
||||
|
||||
## [2.6.3](https://github.com/sern-handler/handler/compare/v2.6.2...v2.6.3) (2023-06-17)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* autocomplete nested option and merge main ([5fdc1ed](https://github.com/sern-handler/handler/commit/5fdc1eda7f4fcc1f94af7eca661660c0edeb3251))
|
||||
|
||||
## [2.6.2](https://github.com/sern-handler/handler/compare/v2.6.1...v2.6.2) (2023-04-15)
|
||||
|
||||
|
||||
### Miscellaneous Chores
|
||||
|
||||
* release 2.6.2 ([c1f6906](https://github.com/sern-handler/handler/commit/c1f690633c55ba41db1e035b7c16f9e19c70b385))
|
||||
|
||||
## [2.6.1](https://github.com/sern-handler/handler/compare/v2.6.0...v2.6.1) (2023-03-17)
|
||||
|
||||
|
||||
### Miscellaneous Chores
|
||||
|
||||
* release 2.6.1 ([f9609ce](https://github.com/sern-handler/handler/commit/f9609ce6cd777fa0eb595d8c48d57905bbce5966))
|
||||
|
||||
## [2.6.0](https://github.com/sern-handler/handler/compare/v2.5.3...v2.6.0) (2023-03-09)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* adding pure annotation for better tree shaking ([d20d015](https://github.com/sern-handler/handler/commit/d20d01524b872549da501e21feec147ab204f397))
|
||||
|
||||
## [2.5.3](https://github.com/sern-handler/handler/compare/v2.5.2...v2.5.3) (2023-02-16)
|
||||
|
||||
|
||||
### Miscellaneous Chores
|
||||
|
||||
* release 2.5.3 ([ce9a083](https://github.com/sern-handler/handler/commit/ce9a0831a6e47dd38648f34653f0bd89b1d2e48e))
|
||||
|
||||
## [2.5.2](https://github.com/sern-handler/handler/compare/v2.5.1...v2.5.2) (2023-02-16)
|
||||
|
||||
|
||||
### Reverts
|
||||
|
||||
* version ([facee79](https://github.com/sern-handler/handler/commit/facee79c904ad663d3c57ce56fb825419fcc12f9))
|
||||
|
||||
## [2.5.1](https://github.com/sern-handler/handler/compare/v2.5.0...v2.5.1) (2023-02-12)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Adding my bot to readme ([#210](https://github.com/sern-handler/handler/issues/210)) ([96f4281](https://github.com/sern-handler/handler/commit/96f42811218e4898a47e75a8138ccd452ae2c5c2))
|
||||
* Adding the WIP to my bot ([86fa531](https://github.com/sern-handler/handler/commit/86fa531eb620d2ac649bad6decb29d5c55a25445))
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* autocomplete ([1860b89](https://github.com/sern-handler/handler/commit/1860b898f3a231840e2a8b781e007ef9d6f587a4))
|
||||
|
||||
|
||||
### Miscellaneous Chores
|
||||
|
||||
* release 2.5.1 ([c78936a](https://github.com/sern-handler/handler/commit/c78936a22574da4af71826f5b5f72f354a4eb06a))
|
||||
|
||||
## [2.5.0](https://github.com/sern-handler/handler/compare/v2.1.1...v2.5.0) (2023-01-30)
|
||||
|
||||
|
||||
### ⚠ BREAKING CHANGES
|
||||
|
||||
* simpler plugins ([#193](https://github.com/sern-handler/handler/issues/193))
|
||||
|
||||
### Features
|
||||
|
||||
* simpler plugins ([#193](https://github.com/sern-handler/handler/issues/193)) ([33f1446](https://github.com/sern-handler/handler/commit/33f14467ec413e003a82503c8a77cb42a6194281))
|
||||
|
||||
|
||||
### Miscellaneous Chores
|
||||
|
||||
* release 2.5.0 ([b4b195d](https://github.com/sern-handler/handler/commit/b4b195dc9586736760d0b78caa8589f3d6131f8a))
|
||||
|
||||
## [2.1.1](https://github.com/sern-handler/handler/compare/v2.1.0...v2.1.1) (2022-12-31)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* modals remapping ([a13df6f](https://github.com/sern-handler/handler/commit/a13df6fb424d256476284da49024dbe56e82baab))
|
||||
|
||||
## [2.1.0](https://github.com/sern-handler/handler/compare/v2.0.0...v2.1.0) (2022-12-30)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* grammar ([c30aac4](https://github.com/sern-handler/handler/commit/c30aac476cdc2094de34f9f67b5805204cc5e4dd))
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* multi parameter events ([e986535](https://github.com/sern-handler/handler/commit/e98653593566ef4635493e0c997bd107a7a3a2a2))
|
||||
|
||||
## [2.0.0](https://github.com/sern-handler/handler/compare/v1.2.1...v2.0.0) (2022-12-28)
|
||||
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
|
||||
**Copyright (c) 2022 Sern**
|
||||
Copyright (c) 2025 sern
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
@@ -19,5 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
End license text.
|
||||
113
README.md
113
README.md
@@ -3,10 +3,11 @@
|
||||
</div>
|
||||
|
||||
<h1 align="center">Handlers. Redefined.</h1>
|
||||
<h4 align="center">A customizable, batteries-included, powerful discord.js framework to streamline bot development.</h4>
|
||||
<h4 align="center">A complete, customizable, typesafe, & reactive framework for discord bots</h4>
|
||||
|
||||
<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>
|
||||
@@ -14,101 +15,65 @@
|
||||
<img alt="Lines of code" src="https://img.shields.io/badge/total%20lines-2k-blue" />
|
||||
</div>
|
||||
|
||||
## Why?
|
||||
- For you. A framework that's tailored to your exact needs.
|
||||
- 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!
|
||||
- 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.
|
||||
|
||||
## 📜 Installation
|
||||
|
||||
```sh
|
||||
npm install @sern/handler
|
||||
```
|
||||
|
||||
```sh
|
||||
yarn add @sern/handler
|
||||
```
|
||||
|
||||
```sh
|
||||
pnpm add @sern/handler
|
||||
```
|
||||
|
||||
## 👀 Quick Look
|
||||
|
||||
* Support for discord.js v14 and all interactions
|
||||
* Hybrid commands
|
||||
* Lightweight and customizable
|
||||
* ESM, CommonJS and TypeScript support
|
||||
* A powerful CLI and awesome community-made plugins
|
||||
[Start here!!](https://sern.dev/v4/reference/getting-started)
|
||||
|
||||
## 👶 Basic Usage
|
||||
<details><summary>ping.ts</summary>
|
||||
|
||||
#### ` index.js (CommonJS)`
|
||||
|
||||
```js
|
||||
// Import the discord.js Client and GatewayIntentBits
|
||||
const { Client, GatewayIntentBits } = require('discord.js');
|
||||
|
||||
// Import Sern namespace
|
||||
const { Sern } = require('@sern/handler');
|
||||
|
||||
// Our configuration file
|
||||
const { defaultPrefix, token } = require('./config.json');
|
||||
|
||||
const client = new Client({
|
||||
intents: [
|
||||
GatewayIntentBits.Guilds,
|
||||
GatewayIntentBits.GuildMembers,
|
||||
GatewayIntentBits.GuildMessages
|
||||
]
|
||||
});
|
||||
export const useContainer = Sern.makeDependencies({
|
||||
build: root => root
|
||||
.add({ '@sern/client': single(client) })
|
||||
.add({ '@sern/logger': single(new DefaultLogging()) })
|
||||
});
|
||||
|
||||
//View docs for all options
|
||||
Sern.init({
|
||||
defaultPrefix: '!', // removing defaultPrefix will shut down text commands
|
||||
commands: 'src/commands',
|
||||
// events: 'src/events' (optional),
|
||||
containerConfig : {
|
||||
get: useContainer
|
||||
}
|
||||
});
|
||||
|
||||
client.login(token);
|
||||
```
|
||||
|
||||
#### ` ping.js (CommonJS)`
|
||||
|
||||
```js
|
||||
const { CommandType, commandModule } = require('@sern/handler');
|
||||
|
||||
exports.default = commandModule({
|
||||
name: 'ping',
|
||||
description: 'A ping pong command',
|
||||
```ts
|
||||
export default commandModule({
|
||||
type: CommandType.Slash,
|
||||
//Installed plugin to publish to discord api and allow access to owners only.
|
||||
plugins: [publish(), ownerOnly()],
|
||||
description: 'A ping pong command',
|
||||
execute(ctx) {
|
||||
ctx.reply('pong!');
|
||||
ctx.reply('Hello owner of the bot');
|
||||
}
|
||||
});
|
||||
```
|
||||
</details>
|
||||
|
||||
See our [templates](https://github.com/sern-handler/templates) for TypeScript examples and more.
|
||||
# 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 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)
|
||||
- [Support Server](https://sern.dev/discord)
|
||||
|
||||
## 👋 Contribute
|
||||
|
||||
- Read our contribution [guidelines](./.github/CONTRIBUTING.md) carefully
|
||||
- Read our contribution [guidelines](https://github.com/sern-handler/handler/blob/main/.github/CONTRIBUTING.md) 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.
|
||||
|
||||
3897
package-lock.json
generated
Normal file
3897
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
92
package.json
92
package.json
@@ -1,25 +1,28 @@
|
||||
{
|
||||
"name": "@sern/handler",
|
||||
"packageManager": "pnpm@7.18.2",
|
||||
"version": "2.0.0",
|
||||
"description": "A customizable, batteries-included, powerful discord.js framework to automate and streamline bot development.",
|
||||
"main": "dist/cjs/index.cjs",
|
||||
"module": "dist/esm/index.mjs",
|
||||
"types": "dist/index.d.ts",
|
||||
"packageManager": "yarn@3.5.0",
|
||||
"version": "4.2.6",
|
||||
"description": "A complete, customizable, typesafe, & reactive framework for discord bots.",
|
||||
"main": "./dist/index.js",
|
||||
"module": "./dist/index.js",
|
||||
"exports": {
|
||||
".": {
|
||||
"import": "./dist/esm/index.mjs",
|
||||
"require": "./dist/cjs/index.cjs"
|
||||
"import": "./dist/index.js",
|
||||
"require": "./dist/index.js"
|
||||
}
|
||||
},
|
||||
"scripts": {
|
||||
"watch": "tsup --watch --dts",
|
||||
"clean-modules": "rimraf node_modules/ && npm install",
|
||||
"watch": "tsc --watch",
|
||||
"lint": "eslint src/**/*.ts",
|
||||
"format": "eslint src/**/*.ts --fix",
|
||||
"build": "tsup && node scripts/mkjson.mjs dist/cjs dist/esm && tsup --dts-only --outDir dist",
|
||||
"publish": "npm run build && npm publish",
|
||||
"pretty": "prettier --write ."
|
||||
"build:dev": "tsc",
|
||||
"build:prod": "tsc",
|
||||
"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"
|
||||
},
|
||||
"keywords": [
|
||||
"sern-handler",
|
||||
@@ -33,25 +36,62 @@
|
||||
"author": "SernDevs",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"iti": "^0.5.0",
|
||||
"rxjs": "^7.5.6",
|
||||
"ts-pattern": "^4.0.2",
|
||||
"ts-results-es": "^3.5.0"
|
||||
"@sern/ioc": "^1.1.2",
|
||||
"callsites": "^3.1.0",
|
||||
"cron": "^3.1.7",
|
||||
"deepmerge": "^4.3.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@typescript-eslint/eslint-plugin": "5.44.0",
|
||||
"@typescript-eslint/parser": "5.44.0",
|
||||
"eslint": "8.25.0",
|
||||
"prettier": "2.7.1",
|
||||
"tsup": "^6.1.3",
|
||||
"typescript": "4.9.4"
|
||||
"@faker-js/faker": "^8.0.1",
|
||||
"@types/node": "^20.0.0",
|
||||
"@types/node-cron": "^3.0.11",
|
||||
"@typescript-eslint/eslint-plugin": "5.58.0",
|
||||
"@typescript-eslint/parser": "5.59.1",
|
||||
"discord.js": "^14.22.1",
|
||||
"eslint": "8.39.0",
|
||||
"typescript": "5.0.2",
|
||||
"vitest": "^1.6.0"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"discord.js": ">= ^14.7.x"
|
||||
"eslintConfig": {
|
||||
"parser": "@typescript-eslint/parser",
|
||||
"extends": [
|
||||
"plugin:@typescript-eslint/recommended"
|
||||
],
|
||||
"parserOptions": {
|
||||
"ecmaVersion": "latest",
|
||||
"sourceType": "script"
|
||||
},
|
||||
"rules": {
|
||||
"@typescript-eslint/no-non-null-assertion": "off",
|
||||
"quotes": [
|
||||
2,
|
||||
"single",
|
||||
{
|
||||
"avoidEscape": true,
|
||||
"allowTemplateLiterals": true
|
||||
}
|
||||
],
|
||||
"semi": [
|
||||
"error",
|
||||
"always"
|
||||
],
|
||||
"@typescript-eslint/no-empty-interface": 0,
|
||||
"@typescript-eslint/ban-types": 0,
|
||||
"@typescript-eslint/no-explicit-any": "off"
|
||||
}
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/sern-handler/handler.git"
|
||||
},
|
||||
"homepage": "https://sern.dev"
|
||||
"engines": {
|
||||
"node": ">= 20.0.x"
|
||||
},
|
||||
"homepage": "https://sern.dev",
|
||||
"overrides": {
|
||||
"ws": "8.17.1"
|
||||
},
|
||||
"resolutions": {
|
||||
"ws": "8.17.1"
|
||||
}
|
||||
}
|
||||
|
||||
1738
pnpm-lock.yaml
generated
1738
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -1,4 +1,9 @@
|
||||
{
|
||||
"extends": [
|
||||
"config:base",
|
||||
"helpers:pinGitHubActionDigests",
|
||||
"group:allNonMajor"
|
||||
],
|
||||
"major": {
|
||||
"dependencyDashboardApproval": true,
|
||||
"reviewers": ["EvolutionX-10", "jacoobes", "Murtatrxx"]
|
||||
@@ -9,6 +14,6 @@
|
||||
"schedule": ["every weekend"],
|
||||
"lockFileMaintenance": {
|
||||
"enabled": true,
|
||||
"automerge": false
|
||||
"automerge": true
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
import { writeFile } from 'fs/promises';
|
||||
import { join } from 'path';
|
||||
// A quick script to regenerate package.jsons for each cjs and esm after tsup cleans distributions
|
||||
const locations = process.argv;
|
||||
locations.shift();
|
||||
locations.shift();
|
||||
for (const loc of locations) {
|
||||
if (loc.endsWith('cjs')) {
|
||||
await writeFile(join(loc, 'package.json'), JSON.stringify({ type: 'commonjs' }));
|
||||
} else {
|
||||
await writeFile(join(loc, 'package.json'), JSON.stringify({ type: 'module' }));
|
||||
}
|
||||
}
|
||||
124
src/core/functions.ts
Normal file
124
src/core/functions.ts
Normal file
@@ -0,0 +1,124 @@
|
||||
import type { Module, SernAutocompleteData, SernOptionsData } from '../types/core-modules';
|
||||
import type {
|
||||
AnySelectMenuInteraction,
|
||||
ButtonInteraction,
|
||||
ChatInputCommandInteraction,
|
||||
MessageContextMenuCommandInteraction,
|
||||
ModalSubmitInteraction,
|
||||
UserContextMenuCommandInteraction,
|
||||
AutocompleteInteraction,
|
||||
} from 'discord.js';
|
||||
import { ApplicationCommandOptionType, InteractionType } from 'discord.js';
|
||||
import { PluginType } from './structures/enums';
|
||||
import type { Payload, UnpackedDependencies } from '../types/utility';
|
||||
import path from 'node:path'
|
||||
|
||||
export const createSDT = (module: Module, deps: UnpackedDependencies, params: string|undefined) => {
|
||||
return {
|
||||
state: {},
|
||||
deps,
|
||||
params,
|
||||
type: module.type,
|
||||
module: {
|
||||
name: module.name,
|
||||
description: module.description,
|
||||
locals: module.locals,
|
||||
meta: module.meta
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes the first character(s) _[depending on prefix length]_ of the message
|
||||
* @param msg
|
||||
* @param prefix The prefix to remove
|
||||
* @returns The message without the prefix
|
||||
* @example
|
||||
* message.content = '!ping';
|
||||
* console.log(fmt(message.content, '!'));
|
||||
* // [ 'ping' ]
|
||||
*/
|
||||
export function fmt(msg: string, prefix?: string): string[] {
|
||||
if(!prefix) throw Error("Unable to parse message without prefix");
|
||||
return msg.slice(prefix.length).trim().split(/\s+/g);
|
||||
}
|
||||
|
||||
|
||||
export function partitionPlugins<T,V>
|
||||
(arr: Array<{ type: PluginType }> = []): [T[], V[]] {
|
||||
const controlPlugins = [];
|
||||
const initPlugins = [];
|
||||
for (const el of arr) {
|
||||
switch (el.type) {
|
||||
case PluginType.Control: controlPlugins.push(el); break;
|
||||
case PluginType.Init: initPlugins.push(el); break;
|
||||
}
|
||||
}
|
||||
return [controlPlugins, initPlugins] as [T[], V[]];
|
||||
}
|
||||
|
||||
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: {
|
||||
_createLookupTable(table, opt.options ?? [], name);
|
||||
} break;
|
||||
case ApplicationCommandOptionType.SubcommandGroup: {
|
||||
_createLookupTable(table, opt.options ?? [], name);
|
||||
} break;
|
||||
default: {
|
||||
if(Reflect.get(opt, 'autocomplete') === true) {
|
||||
table.set(name, opt as SernAutocompleteData)
|
||||
}
|
||||
} break;
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
interface InteractionTypable {
|
||||
type: InteractionType;
|
||||
}
|
||||
//discord.js pls fix ur typings or i will >:(
|
||||
type AnyMessageComponentInteraction = AnySelectMenuInteraction | ButtonInteraction;
|
||||
type AnyCommandInteraction =
|
||||
| ChatInputCommandInteraction
|
||||
| MessageContextMenuCommandInteraction
|
||||
| UserContextMenuCommandInteraction;
|
||||
|
||||
export function isMessageComponent(i: InteractionTypable): i is AnyMessageComponentInteraction {
|
||||
return i.type === InteractionType.MessageComponent;
|
||||
}
|
||||
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;
|
||||
}
|
||||
|
||||
export function isModal(i: InteractionTypable): i is ModalSubmitInteraction {
|
||||
return i.type === InteractionType.ModalSubmit;
|
||||
}
|
||||
|
||||
export function resultPayload<T extends 'success'|'warning'|'failure'>
|
||||
(type: T, module?: Module, reason?: unknown) {
|
||||
return { type, module, reason } as Payload & { type : T };
|
||||
}
|
||||
|
||||
export function pipe<T>(arg: unknown, firstFn: Function, ...fns: Function[]): T {
|
||||
let result = firstFn(arg);
|
||||
for (let fn of fns) {
|
||||
result = fn(result);
|
||||
}
|
||||
return result;
|
||||
}
|
||||
74
src/core/id.ts
Normal file
74
src/core/id.ts
Normal file
@@ -0,0 +1,74 @@
|
||||
import { ApplicationCommandType, ComponentType, type Interaction, InteractionType } from 'discord.js';
|
||||
import { CommandType, EventType } from './structures/enums';
|
||||
|
||||
const parseParams = (event: { customId: string }, append: string) => {
|
||||
const hasSlash = event.customId.indexOf('/')
|
||||
if(hasSlash === -1) {
|
||||
return { id:event.customId+append };
|
||||
}
|
||||
const baseid = event.customId.substring(0, hasSlash);
|
||||
const params = event.customId.substring(hasSlash+1);
|
||||
return { id: baseid+append, params }
|
||||
}
|
||||
/**
|
||||
* Construct unique ID for a given interaction object.
|
||||
* @param event The interaction object for which to create an ID.
|
||||
* @returns An array of unique string IDs based on the type and properties of the interaction object.
|
||||
*/
|
||||
export function reconstruct<T extends Interaction>(event: T) {
|
||||
switch (event.type) {
|
||||
case InteractionType.MessageComponent: {
|
||||
const data = parseParams(event, `_C${event.componentType}`)
|
||||
return [data];
|
||||
}
|
||||
case InteractionType.ApplicationCommand:
|
||||
case InteractionType.ApplicationCommandAutocomplete:
|
||||
return [{ id: `${event.commandName}_A${event.commandType}` }, { id: `${event.commandName}_B` }];
|
||||
//Modal interactions are classified as components for sern
|
||||
case InteractionType.ModalSubmit: {
|
||||
const data = parseParams(event, '_M');
|
||||
return [data];
|
||||
}
|
||||
}
|
||||
}
|
||||
/**
|
||||
*
|
||||
* A magic number to represent any commandtype that is an ApplicationCommand.
|
||||
*/
|
||||
const PUBLISHABLE = 0b000000001111;
|
||||
|
||||
|
||||
const TypeMap = new Map<number, number>([[CommandType.Text, 0],
|
||||
[CommandType.Both, 0],
|
||||
[CommandType.Slash, ApplicationCommandType.ChatInput],
|
||||
[CommandType.CtxUser, ApplicationCommandType.User],
|
||||
[CommandType.CtxMsg, ApplicationCommandType.Message],
|
||||
[CommandType.Button, ComponentType.Button],
|
||||
[CommandType.StringSelect, ComponentType.StringSelect],
|
||||
[CommandType.Modal, InteractionType.ModalSubmit],
|
||||
[CommandType.UserSelect, ComponentType.UserSelect],
|
||||
[CommandType.MentionableSelect, ComponentType.MentionableSelect],
|
||||
[CommandType.RoleSelect, ComponentType.RoleSelect],
|
||||
[CommandType.ChannelSelect, ComponentType.ChannelSelect]]);
|
||||
|
||||
/*
|
||||
* Generates an id based on name and CommandType.
|
||||
* A is for any ApplicationCommand. C is for any ComponentCommand
|
||||
* Then, another number fetched from TypeMap
|
||||
*/
|
||||
export function create(name: string, type: CommandType | EventType) {
|
||||
if(type == CommandType.Text) {
|
||||
return `${name}_T`;
|
||||
}
|
||||
if(type == CommandType.Both) {
|
||||
return `${name}_B`;
|
||||
}
|
||||
if(type == CommandType.Modal) {
|
||||
return `${name}_M`;
|
||||
}
|
||||
const am = (PUBLISHABLE & type) !== 0 ? 'A' : 'C';
|
||||
return `${name}_${am}${TypeMap.get(type)!}`
|
||||
}
|
||||
|
||||
|
||||
|
||||
55
src/core/interfaces.ts
Normal file
55
src/core/interfaces.ts
Normal file
@@ -0,0 +1,55 @@
|
||||
import type { AnyFunction } from '../types/utility';
|
||||
|
||||
|
||||
/**
|
||||
* Represents an initialization contract.
|
||||
* Let dependencies implement this to initiate some logic.
|
||||
*/
|
||||
export interface Init {
|
||||
init(): unknown;
|
||||
}
|
||||
|
||||
/**
|
||||
* Represents a Disposable contract.
|
||||
* Let dependencies implement this to dispose and cleanup.
|
||||
*/
|
||||
export interface Disposable {
|
||||
dispose(): unknown;
|
||||
}
|
||||
|
||||
|
||||
export interface Emitter {
|
||||
addListener(eventName: string | symbol, listener: AnyFunction): this;
|
||||
removeListener(eventName: string | symbol, listener: AnyFunction): this;
|
||||
emit(eventName: string | symbol, ...payload: any[]): boolean;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @since 2.0.0
|
||||
*/
|
||||
export interface ErrorHandling {
|
||||
/**
|
||||
* @deprecated
|
||||
* Version 4 will remove this method
|
||||
*/
|
||||
crash(err: Error): never;
|
||||
/**
|
||||
* A function that is called on every throw.
|
||||
* @param error
|
||||
*/
|
||||
updateAlive(error: Error): void;
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 2.0.0
|
||||
*/
|
||||
export interface Logging<T = unknown> {
|
||||
error(payload: LogPayload<T>): void;
|
||||
warning(payload: LogPayload<T>): void;
|
||||
info(payload: LogPayload<T>): void;
|
||||
debug(payload: LogPayload<T>): void;
|
||||
}
|
||||
|
||||
export type LogPayload<T = unknown> = { message: T };
|
||||
163
src/core/ioc.ts
Normal file
163
src/core/ioc.ts
Normal file
@@ -0,0 +1,163 @@
|
||||
import { Service as $Service, Services as $Services } from '@sern/ioc/global'
|
||||
import { Container } from '@sern/ioc';
|
||||
import * as Contracts from './interfaces';
|
||||
import * as __Services from './structures/default-services';
|
||||
import type { Logging } from './interfaces';
|
||||
import { __init_container, useContainerRaw } from '@sern/ioc/global';
|
||||
import { EventEmitter } from 'node:events';
|
||||
import { Client } from 'discord.js';
|
||||
import { Module } from '../types/core-modules';
|
||||
import { UnpackFunction } from '../types/utility';
|
||||
|
||||
export function disposeAll(logger: Logging|undefined) {
|
||||
useContainerRaw()
|
||||
?.disposeAll()
|
||||
.then(() => logger?.info({ message: 'Cleaning container and crashing' }));
|
||||
}
|
||||
|
||||
type Insertable = | ((container: Dependencies) => object)
|
||||
| object
|
||||
|
||||
const dependencyBuilder = (container: Container) => {
|
||||
return {
|
||||
/**
|
||||
* Insert a dependency into your container.
|
||||
* Supply the correct key and dependency
|
||||
*/
|
||||
add(key: keyof Dependencies, v: Insertable) {
|
||||
if(typeof v !== 'function') {
|
||||
container.addSingleton(key, v)
|
||||
} else {
|
||||
//@ts-ignore
|
||||
container.addWiredSingleton(key, (cntr) => v(cntr))
|
||||
}
|
||||
},
|
||||
/**
|
||||
* @param key the key of the dependency
|
||||
* @param v The dependency to swap out.
|
||||
* Swap out a preexisting dependency.
|
||||
*/
|
||||
swap(key: keyof Dependencies, v: Insertable) {
|
||||
if(typeof v !== 'function') {
|
||||
container.swap(key, v);
|
||||
} else {
|
||||
container.swap(key, v(container.deps()));
|
||||
}
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
type ValidDependencyConfig =
|
||||
(c: ReturnType<typeof dependencyBuilder>) => any
|
||||
|
||||
/**
|
||||
* makeDependencies constructs a dependency injection container for sern handler to use.
|
||||
* This is required to start the handler, and is to be called before Sern.init.
|
||||
* @example
|
||||
* ```ts
|
||||
* await makeDependencies(({ add }) => {
|
||||
* add('@sern/client', new Client({ intents, partials })
|
||||
* })
|
||||
* ```
|
||||
*/
|
||||
export async function makeDependencies (conf: ValidDependencyConfig) {
|
||||
const container = await __init_container({ autowire: false });
|
||||
//We only include logger if it does not exist
|
||||
const includeLogger = !container.hasKey('@sern/logger');
|
||||
|
||||
if(includeLogger) {
|
||||
container.addSingleton('@sern/logger', new __Services.DefaultLogging);
|
||||
}
|
||||
container.addSingleton('@sern/errors', new __Services.DefaultErrorHandling);
|
||||
container.addSingleton('@sern/modules', new Map);
|
||||
container.addSingleton('@sern/emitter', new EventEmitter({ captureRejections: true }))
|
||||
container.addSingleton('@sern/scheduler', new __Services.TaskScheduler)
|
||||
conf(dependencyBuilder(container));
|
||||
await container.ready();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* The Service api, which allows users to access dependencies in places IOC cannot reach.
|
||||
* To obtain intellisense, ensure a .d.ts file exists in the root of compilation.
|
||||
* Our scaffolding tool takes care of this.
|
||||
* Note: this method only works AFTER your container has been initiated
|
||||
* @since 3.0.0
|
||||
* @example
|
||||
* ```ts
|
||||
* const client = Service('@sern/client');
|
||||
* ```
|
||||
* @param key a key that corresponds to a dependency registered.
|
||||
* @throws if container is absent or not present
|
||||
*/
|
||||
export function Service<const T extends keyof Dependencies>(key: T) {
|
||||
return $Service(key) as Dependencies[T]
|
||||
}
|
||||
/**
|
||||
* @since 3.0.0
|
||||
* The plural version of {@link Service}
|
||||
* @throws if container is absent or not present
|
||||
* @returns array of dependencies, in the same order of keys provided
|
||||
*
|
||||
*/
|
||||
export function Services<const T extends (keyof Dependencies)[]>(...keys: [...T]) {
|
||||
return $Services<T, IntoDependencies<T>>(...keys)
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated
|
||||
* Creates a singleton object.
|
||||
* @param cb
|
||||
*/
|
||||
export function single<T>(cb: () => T) {
|
||||
console.log('The `single` function is deprecated and has no effect')
|
||||
return cb();
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated
|
||||
* @since 2.0.0
|
||||
* Creates a transient object
|
||||
* @param cb
|
||||
*/
|
||||
export function transient<T>(cb: () => () => T) {
|
||||
console.log('The `transient` function is deprecated and has no effect')
|
||||
return cb()();
|
||||
}
|
||||
|
||||
export type DependencyFromKey<T extends keyof Dependencies> = Dependencies[T];
|
||||
|
||||
|
||||
|
||||
export type IntoDependencies<Tuple extends [...any[]]> = {
|
||||
[Index in keyof Tuple]: UnpackFunction<NonNullable<DependencyFromKey<Tuple[Index]>>>; //Unpack and make NonNullable
|
||||
} & { length: Tuple['length'] };
|
||||
|
||||
export interface CoreDependencies {
|
||||
/**
|
||||
* discord.js client.
|
||||
*/
|
||||
'@sern/client': Client;
|
||||
/**
|
||||
* sern emitter listens to events that happen throughout
|
||||
* the handler. some include module.register, module.activate.
|
||||
*/
|
||||
'@sern/emitter': Contracts.Emitter;
|
||||
/**
|
||||
* An error handler which is the final step before
|
||||
* the sern process actually crashes.
|
||||
*/
|
||||
'@sern/errors': Contracts.ErrorHandling;
|
||||
/**
|
||||
* Optional logger. Performs ... logging
|
||||
*/
|
||||
'@sern/logger'?: Contracts.Logging;
|
||||
/**
|
||||
* Readonly module store. sern stores these
|
||||
* by module.meta.id -> Module
|
||||
*/
|
||||
'@sern/modules': Map<string, Module>;
|
||||
|
||||
'@sern/scheduler': __Services.TaskScheduler
|
||||
}
|
||||
|
||||
70
src/core/module-loading.ts
Normal file
70
src/core/module-loading.ts
Normal file
@@ -0,0 +1,70 @@
|
||||
import path from 'node:path';
|
||||
import { existsSync } from 'node:fs';
|
||||
import { readdir } from 'fs/promises';
|
||||
import assert from 'node:assert';
|
||||
import * as Id from './id'
|
||||
import { Module } from '../types/core-modules';
|
||||
|
||||
export const parseCallsite = (site: string) => {
|
||||
const pathobj = path.posix.parse(site.replace(/file:\\?/, "")
|
||||
.split(path.sep)
|
||||
.join(path.posix.sep))
|
||||
return { name: pathobj.name,
|
||||
absPath : path.posix.format(pathobj) }
|
||||
}
|
||||
|
||||
export const shouldHandle = (pth: string, filenam: string) => {
|
||||
const file_name = filenam+path.extname(pth);
|
||||
let newPath = path.join(path.dirname(pth), file_name)
|
||||
.replace(/file:\\?/, "");
|
||||
return { exists: existsSync(newPath),
|
||||
path: 'file://'+newPath };
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Import any module based on the absolute path.
|
||||
* This can accept four types of exported modules
|
||||
* commonjs, javascript :
|
||||
* ```js
|
||||
* exports = commandModule({ })
|
||||
* //or
|
||||
* exports.default = commandModule({ })
|
||||
* ```
|
||||
* esm javascript, typescript, and commonjs typescript
|
||||
* export default commandModule({})
|
||||
*/
|
||||
export async function importModule<T>(absPath: string) {
|
||||
let fileModule = await import(absPath);
|
||||
|
||||
let commandModule: Module = fileModule.default;
|
||||
|
||||
assert(commandModule , `No default export @ ${absPath}`);
|
||||
if ('default' in commandModule) {
|
||||
commandModule = commandModule.default as Module;
|
||||
}
|
||||
const p = path.parse(absPath)
|
||||
commandModule.name ??= p.name; commandModule.description ??= "...";
|
||||
commandModule.meta = {
|
||||
id: Id.create(commandModule.name, commandModule.type),
|
||||
absPath,
|
||||
};
|
||||
return { module: commandModule as T };
|
||||
}
|
||||
|
||||
|
||||
export async function* readRecursive(dir: string): AsyncGenerator<string> {
|
||||
const files = await readdir(dir, { withFileTypes: true });
|
||||
for (const file of files) {
|
||||
const fullPath = path.posix.join(dir, file.name);
|
||||
if (file.isDirectory()) {
|
||||
if (!file.name.startsWith('!')) {
|
||||
yield* readRecursive(fullPath);
|
||||
}
|
||||
} else if (!file.name.startsWith('!')) {
|
||||
yield "file:///"+path.resolve(fullPath);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
135
src/core/modules.ts
Normal file
135
src/core/modules.ts
Normal file
@@ -0,0 +1,135 @@
|
||||
import type { ClientEvents } from 'discord.js';
|
||||
import { EventType } from '../core/structures/enums';
|
||||
import type {
|
||||
InputCommand,
|
||||
InputEvent,
|
||||
Module,
|
||||
ScheduledTask,
|
||||
} from '../types/core-modules';
|
||||
import { partitionPlugins } from './functions'
|
||||
import type { Awaitable } from '../types/utility';
|
||||
|
||||
/**
|
||||
* Creates a command module with standardized structure and plugin support.
|
||||
*
|
||||
* @since 1.0.0
|
||||
* @param {InputCommand} mod - Command module configuration
|
||||
* @returns {Module} Processed command module ready for registration
|
||||
*
|
||||
* @example
|
||||
* // Basic slash command
|
||||
* export default commandModule({
|
||||
* type: CommandType.Slash,
|
||||
* description: "Ping command",
|
||||
* execute: async (ctx) => {
|
||||
* await ctx.reply("Pong! 🏓");
|
||||
* }
|
||||
* });
|
||||
*
|
||||
* @example
|
||||
* // Command with component interaction
|
||||
* export default commandModule({
|
||||
* type: CommandType.Slash,
|
||||
* description: "Interactive command",
|
||||
* execute: async (ctx) => {
|
||||
* const button = new ButtonBuilder({
|
||||
* customId: "btn/someData",
|
||||
* label: "Click me",
|
||||
* style: ButtonStyle.Primary
|
||||
* });
|
||||
* await ctx.reply({
|
||||
* content: "Interactive message",
|
||||
* components: [new ActionRowBuilder().addComponents(button)]
|
||||
* });
|
||||
* }
|
||||
* });
|
||||
*/
|
||||
export function commandModule(mod: InputCommand): Module {
|
||||
const [onEvent, plugins] = partitionPlugins(mod.plugins);
|
||||
return { ...mod,
|
||||
onEvent,
|
||||
plugins,
|
||||
locals: {} } as Module;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Creates an event module for handling Discord.js or custom events.
|
||||
*
|
||||
* @since 1.0.0
|
||||
* @template T - Event name from ClientEvents
|
||||
* @param {InputEvent<T>} mod - Event module configuration
|
||||
* @returns {Module} Processed event module ready for registration
|
||||
* @throws {Error} If ControlPlugins are used in event modules
|
||||
*
|
||||
* @example
|
||||
* // Discord event listener
|
||||
* export default eventModule({
|
||||
* type: EventType.Discord,
|
||||
* execute: async (message) => {
|
||||
* console.log(`${message.author.tag}: ${message.content}`);
|
||||
* }
|
||||
* });
|
||||
*
|
||||
* @example
|
||||
* // Custom sern event
|
||||
* export default eventModule({
|
||||
* type: EventType.Sern,
|
||||
* execute: async (eventData) => {
|
||||
* // Handle sern-specific event
|
||||
* }
|
||||
* });
|
||||
*/
|
||||
export function eventModule<T extends keyof ClientEvents = keyof ClientEvents>(mod: InputEvent<T>): Module {
|
||||
const [onEvent, plugins] = partitionPlugins(mod.plugins);
|
||||
if(onEvent.length !== 0) throw Error("Event modules cannot have ControlPlugins");
|
||||
return { ...mod,
|
||||
plugins,
|
||||
locals: {} } as Module;
|
||||
}
|
||||
|
||||
/** Create event modules from discord.js client events,
|
||||
* This was an {@link eventModule} for discord events,
|
||||
* where typings were bad.
|
||||
* @deprecated Use {@link eventModule} instead
|
||||
* @param mod
|
||||
*/
|
||||
export function discordEvent<T extends keyof ClientEvents>(mod: {
|
||||
name: T;
|
||||
once?: boolean;
|
||||
execute: (...args: ClientEvents[T]) => Awaitable<unknown>;
|
||||
}) {
|
||||
return eventModule({ type: EventType.Discord, ...mod, });
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a scheduled task that can be executed at specified intervals using cron patterns
|
||||
*
|
||||
* @param {ScheduledTask} ism - The scheduled task configuration object
|
||||
* @param {string} ism.trigger - A cron pattern that determines when the task should execute
|
||||
* Format: "* * * * *" (minute hour day month day-of-week)
|
||||
* @param {Function} ism.execute - The function to execute when the task is triggered
|
||||
* @param {Object} ism.execute.context - The execution context passed to the task
|
||||
*
|
||||
* @returns {ScheduledTask} The configured scheduled task
|
||||
*
|
||||
* @example
|
||||
* // Create a task that runs every minute
|
||||
* export default scheduledTask({
|
||||
* trigger: "* * * * *",
|
||||
* execute: (context) => {
|
||||
* console.log("Task executed!");
|
||||
* }
|
||||
* });
|
||||
*
|
||||
* @remarks
|
||||
* - Tasks must be placed in the 'tasks' directory specified in your config
|
||||
* - The file name serves as a unique identifier for the task
|
||||
* - Tasks can be cancelled using deps['@sern/scheduler'].kill(uuid)
|
||||
*
|
||||
* @see {@link https://crontab.guru/} for testing and creating cron patterns
|
||||
*/
|
||||
export function scheduledTask(ism: ScheduledTask): ScheduledTask {
|
||||
return ism
|
||||
}
|
||||
|
||||
137
src/core/plugin.ts
Normal file
137
src/core/plugin.ts
Normal file
@@ -0,0 +1,137 @@
|
||||
import { CommandType, PluginType } from './structures/enums';
|
||||
import type { Plugin, PluginResult, CommandArgs, InitArgs } from '../types/core-plugin';
|
||||
import { Err, Ok } from './structures/result';
|
||||
import type { Dictionary } from '../types/utility';
|
||||
|
||||
export function makePlugin<V extends unknown[]>(
|
||||
type: PluginType,
|
||||
execute: (...args: any[]) => any,
|
||||
): Plugin<V> {
|
||||
return { type, execute } as Plugin<V>;
|
||||
}
|
||||
/**
|
||||
* @since 2.5.0
|
||||
*/
|
||||
export function EventInitPlugin(execute: (args: InitArgs) => PluginResult) {
|
||||
return makePlugin(PluginType.Init, execute);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an initialization plugin for command preprocessing and modification
|
||||
*
|
||||
* @since 2.5.0
|
||||
* @template I - Extends CommandType to enforce type safety for command modules
|
||||
*
|
||||
* @param {function} execute - Function to execute during command initialization
|
||||
* @param {InitArgs<T>} execute.args - The initialization arguments
|
||||
* @param {T} execute.args.module - The command module being initialized
|
||||
* @param {string} execute.args.absPath - The absolute path to the module file
|
||||
* @param {Dependencies} execute.args.deps - Dependency injection container
|
||||
*
|
||||
* @returns {Plugin} A plugin that runs during command initialization
|
||||
*
|
||||
* @example
|
||||
* // Plugin to update command description
|
||||
* export const updateDescription = (description: string) => {
|
||||
* return CommandInitPlugin(({ deps }) => {
|
||||
* if(description.length > 100) {
|
||||
* deps.logger?.info({ message: "Invalid description" })
|
||||
* return controller.stop("From updateDescription: description is invalid");
|
||||
* }
|
||||
* module.description = description;
|
||||
* return controller.next();
|
||||
* });
|
||||
* };
|
||||
*
|
||||
* @example
|
||||
* // Plugin to store registration date in module locals
|
||||
* export const dateRegistered = () => {
|
||||
* return CommandInitPlugin(({ module }) => {
|
||||
* module.locals.registered = Date.now()
|
||||
* return controller.next();
|
||||
* });
|
||||
* };
|
||||
*
|
||||
* @remarks
|
||||
* - Init plugins can modify how commands are loaded and perform preprocessing
|
||||
* - The module.locals object can be used to store custom plugin-specific data
|
||||
* - Be careful when modifying module fields as multiple plugins may interact with them
|
||||
* - Use controller.next() to continue to the next plugin
|
||||
* - Use controller.stop(reason) to halt plugin execution
|
||||
*/
|
||||
export function CommandInitPlugin<I extends CommandType>(
|
||||
execute: (args: InitArgs) => PluginResult
|
||||
): Plugin {
|
||||
return makePlugin(PluginType.Init, execute);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a control plugin for command preprocessing, filtering, and state management
|
||||
*
|
||||
* @since 2.5.0
|
||||
* @template I - Extends CommandType to enforce type safety for command modules
|
||||
*
|
||||
* @param {function} execute - Function to execute during command control flow
|
||||
* @param {CommandArgs<I>} execute.args - The command arguments array
|
||||
* @param {Context} execute.args[0] - The discord context (e.g., guild, channel, user info, interaction)
|
||||
* @param {SDT} execute.args[1] - The State, Dependencies, Params, Module, and Type object
|
||||
*
|
||||
* @returns {Plugin} A plugin that runs during command execution flow
|
||||
*
|
||||
* @example
|
||||
* // Plugin to restrict command to specific guild
|
||||
* export const inGuild = (guildId: string) => {
|
||||
* return CommandControlPlugin((ctx, sdt) => {
|
||||
* if(ctx.guild.id !== guildId) {
|
||||
* return controller.stop();
|
||||
* }
|
||||
* return controller.next();
|
||||
* });
|
||||
* };
|
||||
*
|
||||
* @example
|
||||
* // Plugins passing state through the chain
|
||||
* const plugin1 = CommandControlPlugin((ctx, sdt) => {
|
||||
* return controller.next({ 'plugin1/data': 'from plugin1' });
|
||||
* });
|
||||
*
|
||||
* const plugin2 = CommandControlPlugin((ctx, sdt) => {
|
||||
* return controller.next({ 'plugin2/data': ctx.user.id });
|
||||
* });
|
||||
*
|
||||
* export default commandModule({
|
||||
* type: CommandType.Slash,
|
||||
* plugins: [plugin1, plugin2],
|
||||
* execute: (ctx, sdt) => {
|
||||
* console.log(sdt.state); // Access accumulated state
|
||||
* }
|
||||
* });
|
||||
*
|
||||
* @remarks
|
||||
* - Control plugins are executed in order when a discord.js event is emitted
|
||||
* - Use controller.next() to continue to next plugin or controller.stop() to halt execution
|
||||
* - State can be passed between plugins using controller.next({ key: value })
|
||||
* - State keys should be namespaced to avoid collisions (e.g., 'plugin-name/key')
|
||||
* - Final accumulated state is passed to the command's execute function
|
||||
* - All plugins must succeed for the command to execute
|
||||
* - Plugins have access to dependencies through the sdt.deps object
|
||||
* - Useful for implementing preconditions, filters, and command preprocessing
|
||||
*/
|
||||
export function CommandControlPlugin<I extends CommandType>(
|
||||
execute: (...args: CommandArgs<I>) => PluginResult,
|
||||
) {
|
||||
return makePlugin(PluginType.Control, execute);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
* The object passed into every plugin to control a command's behavior
|
||||
*/
|
||||
export const controller = {
|
||||
next: (val?: Dictionary) => Ok(val),
|
||||
stop: (val?: string) => Err(val),
|
||||
};
|
||||
|
||||
|
||||
export type Controller = typeof controller;
|
||||
65
src/core/presences.ts
Normal file
65
src/core/presences.ts
Normal file
@@ -0,0 +1,65 @@
|
||||
import type { ActivitiesOptions } from "discord.js";
|
||||
import type { IntoDependencies } from "./ioc";
|
||||
import type { Emitter } from "./interfaces";
|
||||
import { Awaitable } from "../types/utility";
|
||||
|
||||
type Status = 'online' | 'idle' | 'invisible' | 'dnd'
|
||||
type PresenceReduce = (previous: Presence.Result) => Awaitable<Presence.Result>;
|
||||
|
||||
export const Presence = {
|
||||
/**
|
||||
* A small wrapper to provide type inference.
|
||||
* Create a Presence module which **MUST** be put in a file called presence.(language-extension)
|
||||
* adjacent to the file where **Sern.init** is CALLED.
|
||||
*/
|
||||
module : <T extends (keyof Dependencies)[]>(conf: Presence.Config<T>) => conf,
|
||||
/**
|
||||
* Create a Presence body which can be either:
|
||||
* - once, the presence is activated only once.
|
||||
* - repeated, per cycle or event, the presence can be changed.
|
||||
*/
|
||||
of : (root: Omit<Presence.Result, 'repeat' | 'onRepeat'>) => {
|
||||
return {
|
||||
/**
|
||||
* @example
|
||||
* Presence
|
||||
* .of({ activities: [{ name: "deez nuts" }] }) //starts presence with "deez nuts".
|
||||
* .repeated(prev => {
|
||||
* return {
|
||||
* afk: true,
|
||||
* activities: prev.activities?.map(s => ({ ...s, name: s.name+"s" }))
|
||||
* };
|
||||
* }, 10000)) //every 10 s, the callback sets the presence to the value returned.
|
||||
*/
|
||||
repeated: (onRepeat: PresenceReduce, repeat: number | [Emitter, string]) => {
|
||||
return { repeat, onRepeat, ...root }
|
||||
},
|
||||
/**
|
||||
* @example
|
||||
* ```ts
|
||||
* Presence.of({
|
||||
* activities: [{ name: "Chilling out" }]
|
||||
* }).once() // Sets the presence once, with what's provided in '.of()'
|
||||
* ```
|
||||
*/
|
||||
once: () => root
|
||||
};
|
||||
}
|
||||
}
|
||||
export declare namespace Presence {
|
||||
export type Config<T extends (keyof Dependencies)[]> = {
|
||||
inject?: [...T]
|
||||
execute: (...v: IntoDependencies<T>) => Awaitable<Presence.Result>;
|
||||
|
||||
}
|
||||
|
||||
export interface Result {
|
||||
status?: Status;
|
||||
afk?: boolean;
|
||||
activities?: ActivitiesOptions[];
|
||||
shardId?: number[];
|
||||
repeat?: number | [Emitter, string];
|
||||
onRepeat?: PresenceReduce
|
||||
}
|
||||
}
|
||||
|
||||
131
src/core/structures/context.ts
Normal file
131
src/core/structures/context.ts
Normal file
@@ -0,0 +1,131 @@
|
||||
import type {
|
||||
BaseInteraction,
|
||||
ChatInputCommandInteraction,
|
||||
Client,
|
||||
InteractionReplyOptions,
|
||||
Message,
|
||||
MessageReplyOptions,
|
||||
Snowflake,
|
||||
User,
|
||||
} from 'discord.js';
|
||||
import { Result, Ok, Err, val } from './result';
|
||||
import * as assert from 'assert';
|
||||
import type { ReplyOptions } from '../../types/utility';
|
||||
import { fmt } from '../functions'
|
||||
import { SernError } from './enums';
|
||||
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
* Provides values shared between
|
||||
* Message and ChatInputCommandInteraction
|
||||
*/
|
||||
export class Context {
|
||||
|
||||
get options() {
|
||||
if(this.isMessage()) {
|
||||
const [, ...rest] = fmt(this.message.content, this.prefix);
|
||||
return rest;
|
||||
}
|
||||
return this.interaction.options;
|
||||
}
|
||||
|
||||
|
||||
protected constructor(protected ctx: Result<Message, ChatInputCommandInteraction>,
|
||||
private __prefix?: string) { }
|
||||
public get prefix() {
|
||||
return this.__prefix;
|
||||
}
|
||||
public get id(): Snowflake {
|
||||
return val(this.ctx).id
|
||||
}
|
||||
|
||||
public get channel() {
|
||||
return val(this.ctx).channel;
|
||||
}
|
||||
|
||||
public get channelId(): Snowflake {
|
||||
return val(this.ctx).channelId;
|
||||
}
|
||||
|
||||
/**
|
||||
* If context is holding a message, message.author
|
||||
* else, interaction.user
|
||||
*/
|
||||
public get user(): User {
|
||||
if(this.ctx.ok) {
|
||||
return this.ctx.value.author;
|
||||
}
|
||||
return this.ctx.error.user;
|
||||
|
||||
}
|
||||
|
||||
public get userId(): Snowflake {
|
||||
return this.user.id;
|
||||
}
|
||||
|
||||
public get createdTimestamp(): number {
|
||||
return val(this.ctx).createdTimestamp;
|
||||
}
|
||||
|
||||
public get guild() {
|
||||
return val(this.ctx).guild;
|
||||
}
|
||||
|
||||
public get guildId() {
|
||||
return val(this.ctx).guildId;
|
||||
}
|
||||
/*
|
||||
* interactions can return APIGuildMember if the guild it is emitted from is not cached
|
||||
*/
|
||||
public get member() {
|
||||
return val(this.ctx).member;
|
||||
}
|
||||
|
||||
get message(): Message {
|
||||
if(this.ctx.ok) {
|
||||
return this.ctx.value;
|
||||
}
|
||||
throw Error(SernError.MismatchEvent);
|
||||
}
|
||||
public isMessage(): this is Context & { ctx: Result<Message, never> } {
|
||||
return this.ctx.ok;
|
||||
}
|
||||
|
||||
public isSlash(): this is Context & { ctx: Result<never, ChatInputCommandInteraction> } {
|
||||
return !this.isMessage();
|
||||
}
|
||||
|
||||
get interaction(): ChatInputCommandInteraction {
|
||||
if(!this.ctx.ok) {
|
||||
return this.ctx.error;
|
||||
}
|
||||
throw Error(SernError.MismatchEvent);
|
||||
}
|
||||
|
||||
|
||||
public get client(): Client {
|
||||
return val(this.ctx).client;
|
||||
}
|
||||
|
||||
public get inGuild(): boolean {
|
||||
return val(this.ctx).inGuild()
|
||||
}
|
||||
|
||||
public async reply(content: ReplyOptions) {
|
||||
if(this.ctx.ok) {
|
||||
return this.ctx.value.reply(content as MessageReplyOptions)
|
||||
}
|
||||
interface FetchReply { fetchReply: true };
|
||||
return this.ctx.error.reply(content as InteractionReplyOptions & FetchReply)
|
||||
|
||||
}
|
||||
|
||||
static wrap(wrappable: BaseInteraction | Message, prefix?: string): Context {
|
||||
if ('interaction' in wrappable) {
|
||||
return new Context(Ok(wrappable), prefix);
|
||||
}
|
||||
assert.ok(wrappable.isChatInputCommand(), "Context created with bad interaction.");
|
||||
return new Context(Err(wrappable), prefix);
|
||||
}
|
||||
}
|
||||
89
src/core/structures/default-services.ts
Normal file
89
src/core/structures/default-services.ts
Normal file
@@ -0,0 +1,89 @@
|
||||
import { ScheduledTask } from '../../types/core-modules';
|
||||
import type { LogPayload, Logging, ErrorHandling, Disposable } from '../interfaces';
|
||||
import { CronJob } from 'cron';
|
||||
|
||||
/**
|
||||
* @internal
|
||||
* @since 2.0.0
|
||||
* Version 4.0.0 will internalize this api. Please refrain from using the defaults!
|
||||
*/
|
||||
export class DefaultErrorHandling implements ErrorHandling {
|
||||
crash(err: Error): never {
|
||||
throw err;
|
||||
}
|
||||
updateAlive(err: Error) {
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @internal
|
||||
* @since 2.0.0
|
||||
* Version 4.0.0 will internalize this api. Please refrain from using ModuleStore!
|
||||
*/
|
||||
export class DefaultLogging implements Logging {
|
||||
private date() { return new Date() }
|
||||
debug(payload: LogPayload): void {
|
||||
console.debug(`DEBUG: ${this.date().toISOString()} -> ${payload.message}`);
|
||||
}
|
||||
|
||||
error(payload: LogPayload): void {
|
||||
console.error(`ERROR: ${this.date().toISOString()} -> ${payload.message}`);
|
||||
}
|
||||
|
||||
info(payload: LogPayload): void {
|
||||
console.info(`INFO: ${this.date().toISOString()} -> ${payload.message}`);
|
||||
}
|
||||
|
||||
warning(payload: LogPayload): void {
|
||||
console.warn(`WARN: ${this.date().toISOString()} -> ${payload.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
export class TaskScheduler implements Disposable {
|
||||
private __tasks: Map<string, CronJob<any, any>> = new Map();
|
||||
|
||||
schedule(uuid: string, task: ScheduledTask, deps: Dependencies) {
|
||||
if (this.__tasks.has(uuid)) {
|
||||
throw Error("while scheduling a task \
|
||||
found another task of same name. Not scheduling " +
|
||||
uuid + "again." );
|
||||
}
|
||||
try {
|
||||
const onTick = async function(this: CronJob) {
|
||||
task.execute({ id: uuid,
|
||||
lastTimeExecution: this.lastExecution,
|
||||
nextTimeExecution: this.nextDate().toJSDate() }, { deps })
|
||||
}
|
||||
const job = CronJob.from({ cronTime: task.trigger, onTick, timeZone: task.timezone });
|
||||
job.start();
|
||||
this.__tasks.set(uuid, job);
|
||||
} catch (error) {
|
||||
throw Error(`while scheduling a task ${uuid} ` + error);
|
||||
}
|
||||
}
|
||||
|
||||
kill(taskName: string): boolean {
|
||||
const job = this.__tasks.get(taskName);
|
||||
if (job) {
|
||||
job.stop();
|
||||
this.__tasks.delete(taskName);
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
get tasks(): string[] {
|
||||
return Array.from(this.__tasks.keys());
|
||||
}
|
||||
|
||||
dispose() {
|
||||
this.__tasks.forEach((_, id) => {
|
||||
this.kill(id);
|
||||
this.__tasks.delete(id);
|
||||
})
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,4 +1,5 @@
|
||||
/**
|
||||
* @since 1.0.0
|
||||
* A bitfield that discriminates command modules
|
||||
* @enum { number }
|
||||
* @example
|
||||
@@ -14,45 +15,18 @@
|
||||
* ```
|
||||
*/
|
||||
export enum CommandType {
|
||||
/**
|
||||
* The CommandType for text commands
|
||||
*/
|
||||
Text = 1,
|
||||
/**
|
||||
* The CommandType for slash commands
|
||||
*/
|
||||
Slash = 2,
|
||||
/**
|
||||
* The CommandType for hybrid commands, text and slash
|
||||
*/
|
||||
Text = 1 << 0,
|
||||
Slash = 1 << 1,
|
||||
Both = 3,
|
||||
/**
|
||||
* The CommandType for UserContextMenuInteraction commands
|
||||
*/
|
||||
CtxUser = 4,
|
||||
/**
|
||||
* The CommandType for MessageContextMenuInteraction commands
|
||||
*/
|
||||
CtxMsg = 8,
|
||||
/**
|
||||
* The CommandType for ButtonInteraction commands
|
||||
*/
|
||||
Button = 16,
|
||||
/**
|
||||
* The CommandType for StringSelectMenuInteraction commands
|
||||
*/
|
||||
StringSelect = 32,
|
||||
/**
|
||||
* The CommandType for ModalSubmitInteraction commands
|
||||
*/
|
||||
Modal = 64,
|
||||
/**
|
||||
* The CommandType for the other SelectMenuInteractions
|
||||
*/
|
||||
ChannelSelect = 256,
|
||||
MentionableSelect = 512,
|
||||
RoleSelect= 1024,
|
||||
UserSelect= 2048
|
||||
CtxUser = 1 << 2,
|
||||
CtxMsg = 1 << 3,
|
||||
Button = 1 << 4,
|
||||
StringSelect = 1 << 5,
|
||||
Modal = 1 << 6,
|
||||
UserSelect = 1 << 7,
|
||||
RoleSelect = 1 << 8,
|
||||
MentionableSelect = 1 << 9,
|
||||
ChannelSelect = 1 << 10,
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -74,16 +48,16 @@ export enum EventType {
|
||||
/**
|
||||
* The EventType for handling discord events
|
||||
*/
|
||||
Discord = 1,
|
||||
Discord,
|
||||
/**
|
||||
* The EventType for handling sern events
|
||||
*/
|
||||
Sern = 2,
|
||||
Sern,
|
||||
/**
|
||||
* The EventType for handling external events.
|
||||
* Could be for example, `process` events, database events
|
||||
*/
|
||||
External = 3,
|
||||
External,
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -102,28 +76,59 @@ export enum EventType {
|
||||
*/
|
||||
export enum PluginType {
|
||||
/**
|
||||
* The PluginType for CommandPlugins
|
||||
* The PluginType for InitPlugins
|
||||
*/
|
||||
Command = 1,
|
||||
Init = 1,
|
||||
/**
|
||||
* The PluginType for EventPlugins
|
||||
*/
|
||||
Event = 2,
|
||||
Control = 2,
|
||||
}
|
||||
/**
|
||||
* @deprecated - Use strings 'success' | 'failure' | 'warning'
|
||||
* @enum { string }
|
||||
*/
|
||||
export enum PayloadType {
|
||||
/**
|
||||
* The PayloadType for a SernEmitter success event
|
||||
*/
|
||||
Success = 'success',
|
||||
/**
|
||||
* The PayloadType for a SernEmitter failure event
|
||||
*/
|
||||
Failure = 'failure',
|
||||
/**
|
||||
* The PayloadType for a SernEmitter warning event
|
||||
*/
|
||||
Warning = 'warning',
|
||||
}
|
||||
|
||||
/**
|
||||
* @enum { string }
|
||||
*/
|
||||
export const enum SernError {
|
||||
/**
|
||||
* Throws when registering an invalid module.
|
||||
* This means it is undefined or an invalid command type was provided
|
||||
*/
|
||||
InvalidModuleType = 'Detected an unknown module type',
|
||||
/**
|
||||
* Attempted to lookup module in command module store. Nothing was found!
|
||||
*/
|
||||
UndefinedModule = `A module could not be detected`,
|
||||
/**
|
||||
* Attempted to lookup module in command module store. Nothing was found!
|
||||
*/
|
||||
MismatchModule = `A module type mismatched with event emitted!`,
|
||||
/**
|
||||
* Unsupported interaction at this moment.
|
||||
*/
|
||||
NotSupportedInteraction = `This interaction is not supported.`,
|
||||
/**
|
||||
* One plugin called `controller.stop()` (end command execution / loading)
|
||||
*/
|
||||
PluginFailure = `A plugin failed to call controller.next()`,
|
||||
/**
|
||||
* A crash that occurs when accessing an invalid property of Context
|
||||
*/
|
||||
MismatchEvent = `You cannot use message when an interaction fired or vice versa`,
|
||||
/**
|
||||
* Unsupported feature attempted to access at this time
|
||||
*/
|
||||
NotSupportedYet = `This feature is not supported yet`,
|
||||
/**
|
||||
* Required Dependency not found
|
||||
*/
|
||||
MissingRequired = `@sern/client is required but was not found`,
|
||||
}
|
||||
20
src/core/structures/result.ts
Normal file
20
src/core/structures/result.ts
Normal file
@@ -0,0 +1,20 @@
|
||||
export type Result<Ok, Err> =
|
||||
| { ok: true; value: Ok }
|
||||
| { ok: false; error: Err };
|
||||
|
||||
export const Ok = <Ok>(value: Ok) => ({ ok: true, value } as const);
|
||||
export const Err = <Err>(error: Err) => ({ ok: false, error } as const);
|
||||
|
||||
export const val = <O, E>(r: Result<O, E>) => r.ok ? r.value : r.error;
|
||||
export const EMPTY_ERR = Err(undefined);
|
||||
|
||||
/**
|
||||
* Wrap an async operation that may throw an Error (`try-catch` style) into checked exception style
|
||||
* @param op The operation function
|
||||
*/
|
||||
export async function wrapAsync<T, E = unknown>(op: () => Promise<T>): Promise<Result<T, E>> {
|
||||
try { return op()
|
||||
.then(Ok)
|
||||
.catch(Err); }
|
||||
catch (e) { return Promise.resolve(Err(e as E)); }
|
||||
}
|
||||
@@ -1,49 +0,0 @@
|
||||
import type { Observable } from 'rxjs';
|
||||
import type { Logging } from './logging';
|
||||
import { useContainerRaw } from '../dependencies/provider';
|
||||
import util from 'util';
|
||||
export interface ErrorHandling {
|
||||
/**
|
||||
* Number of times the process should throw an error until crashing and exiting
|
||||
*/
|
||||
keepAlive : number
|
||||
|
||||
/**
|
||||
* Utility function to crash
|
||||
* @param error
|
||||
*/
|
||||
crash(error : Error) : never
|
||||
|
||||
/**
|
||||
* A function that is called on every crash. Updates keepAlive
|
||||
* @param error
|
||||
*/
|
||||
updateAlive(error: Error): void
|
||||
}
|
||||
|
||||
export class DefaultErrorHandling implements ErrorHandling {
|
||||
keepAlive = 5;
|
||||
crash(error: Error): never {
|
||||
throw error;
|
||||
}
|
||||
updateAlive(e: Error) {
|
||||
this.keepAlive--;
|
||||
}
|
||||
}
|
||||
|
||||
export function handleError<C>(crashHandler: ErrorHandling, logging?: Logging) {
|
||||
return (pload: unknown, caught: Observable<C>) => {
|
||||
// This is done to fit the ErrorHandling contract
|
||||
const err = pload instanceof Error ? pload : Error(util.format(pload));
|
||||
if(crashHandler.keepAlive == 0) {
|
||||
useContainerRaw()?.disposeAll().then(() => {
|
||||
logging?.info({ message: 'Cleaning container and crashing' });
|
||||
});
|
||||
crashHandler.crash(err);
|
||||
}
|
||||
//formatted payload
|
||||
logging?.error({ message: util.format(pload) });
|
||||
crashHandler.updateAlive(err);
|
||||
return caught;
|
||||
};
|
||||
}
|
||||
@@ -1,3 +0,0 @@
|
||||
export { ErrorHandling, DefaultErrorHandling } from './errorHandling';
|
||||
export { Logging, DefaultLogging } from './logging';
|
||||
export { ModuleManager, DefaultModuleManager } from './moduleManager';
|
||||
@@ -1,28 +0,0 @@
|
||||
import type { LogPayload } from '../../types/handler';
|
||||
|
||||
export interface Logging<T = unknown> {
|
||||
error(payload : LogPayload<T>) : void;
|
||||
warning(payload : LogPayload<T>) : void;
|
||||
info(payload : LogPayload<T>) : void
|
||||
debug(payload : LogPayload<T>) : void
|
||||
}
|
||||
|
||||
export class DefaultLogging implements Logging {
|
||||
private date = () => new Date();
|
||||
debug(payload: LogPayload): void {
|
||||
console.debug(`DEBUG: ${this.date().toISOString()} -> ${payload.message}`);
|
||||
}
|
||||
|
||||
error(payload: LogPayload): void {
|
||||
console.error(`ERROR: ${this.date().toISOString()} -> ${payload.message}`);
|
||||
}
|
||||
|
||||
info(payload: LogPayload): void {
|
||||
console.info(`INFO: ${this.date().toISOString()} -> ${payload.message}`);
|
||||
}
|
||||
|
||||
warning(payload: LogPayload): void {
|
||||
console.warn(`WARN: ${this.date().toISOString()} -> ${payload.message}`);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,20 +0,0 @@
|
||||
import type { CommandModuleDefs } from '../../types/module';
|
||||
import type { CommandType } from '../structures/enums';
|
||||
import type { ModuleStore } from '../structures/moduleStore';
|
||||
|
||||
|
||||
export interface ModuleManager {
|
||||
get<T extends CommandType>(strat : (ms: ModuleStore) => CommandModuleDefs[T] | undefined) : CommandModuleDefs[T] | undefined
|
||||
set(strat: (ms: ModuleStore) => void) : void
|
||||
}
|
||||
|
||||
export class DefaultModuleManager implements ModuleManager {
|
||||
constructor(private moduleStore: ModuleStore) {}
|
||||
get<T extends CommandType>(strat: (ms: ModuleStore) => CommandModuleDefs[T] | undefined) {
|
||||
return strat(this.moduleStore);
|
||||
}
|
||||
|
||||
set(strat: (ms: ModuleStore) => void): void {
|
||||
strat(this.moduleStore);
|
||||
}
|
||||
}
|
||||
@@ -1,3 +0,0 @@
|
||||
export {
|
||||
useContainer
|
||||
} from './provider';
|
||||
@@ -1,83 +0,0 @@
|
||||
import type { Container } from 'iti';
|
||||
import { SernError } from '../structures/errors';
|
||||
import { BehaviorSubject } from 'rxjs';
|
||||
import * as assert from 'assert';
|
||||
import type { Dependencies, MapDeps } from '../../types/handler';
|
||||
import SernEmitter from '../sernEmitter';
|
||||
import { _const, ok } from '../utilities/functions';
|
||||
import { DefaultErrorHandling, DefaultModuleManager, Logging } from '../contracts';
|
||||
import { ModuleStore } from '../structures/moduleStore';
|
||||
import { Ok, Result } from 'ts-results-es';
|
||||
import { DefaultLogging } from '../contracts';
|
||||
|
||||
export const containerSubject = new BehaviorSubject<Container<Dependencies, Partial<Dependencies>> | null>(null);
|
||||
export function composeRoot<T extends Dependencies>(root: Container<Partial<T>, Partial<Dependencies>>, exclusion: Set<keyof Dependencies>) {
|
||||
const client = root.get('@sern/client');
|
||||
assert.ok(client !== undefined, SernError.MissingRequired);
|
||||
//A utility function checking if a dependency has been declared excluded
|
||||
const excluded = (key: keyof Dependencies) => exclusion.has(key);
|
||||
//Wraps a fetch to the container in a Result, deferring the action
|
||||
const get = <T>(key : keyof Dependencies) => Result.wrap(() => root.get(key) as T);
|
||||
const getOr = (key: keyof Dependencies, elseAction: () => unknown) => {
|
||||
//Gets dependency but if an Err, map to a function that upserts.
|
||||
const dep = get(key).mapErr(() => elseAction);
|
||||
if(dep.err) {
|
||||
//Defers upsert until final check here
|
||||
return dep.val();
|
||||
}
|
||||
};
|
||||
const xGetOr = (key: keyof Dependencies, action: () => unknown) => {
|
||||
if(excluded(key)) {
|
||||
get(key) //if dev created a dependency but excluded, deletes on root composition
|
||||
.andThen(() => Ok(root.delete(key)))
|
||||
.unwrapOr(ok());
|
||||
} else {
|
||||
getOr(key, action);
|
||||
}
|
||||
|
||||
};
|
||||
xGetOr('@sern/emitter', () => root.upsert({
|
||||
'@sern/emitter' : _const(new SernEmitter())
|
||||
})
|
||||
);
|
||||
//An "optional" dependency
|
||||
xGetOr('@sern/logger', () => {
|
||||
root.upsert({
|
||||
'@sern/logger' : _const(new DefaultLogging())
|
||||
});
|
||||
}
|
||||
);
|
||||
xGetOr('@sern/store', () => root.upsert({
|
||||
'@sern/store' : _const(new ModuleStore())
|
||||
})
|
||||
);
|
||||
xGetOr('@sern/modules', () => root.upsert((ctx) => ({
|
||||
'@sern/modules' : _const(new DefaultModuleManager(ctx['@sern/store'] as ModuleStore))
|
||||
}))
|
||||
);
|
||||
xGetOr('@sern/errors', () => root.upsert({
|
||||
'@sern/errors': _const(new DefaultErrorHandling())
|
||||
})
|
||||
);
|
||||
//If logger exists, log info, else do nothing.
|
||||
get<Logging>('@sern/logger')
|
||||
.map((logger => logger.info({ message: 'All dependencies loaded successfully' })))
|
||||
.unwrapOr(ok());
|
||||
}
|
||||
|
||||
|
||||
export function useContainer<T extends Dependencies>() {
|
||||
const container = containerSubject.getValue()! as unknown as Container<T, {}>;
|
||||
assert.ok(container !== null, 'useContainer was called before Sern#init');
|
||||
//weird edge case, why can i not use _const here?
|
||||
return <V extends (keyof T)[]>(...keys: [...V]) =>
|
||||
keys.map(key => Result.wrap(() => container.get(key)).unwrapOr(undefined)) as MapDeps<T, V>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the underlying data structure holding all dependencies.
|
||||
* Exposes some methods from iti
|
||||
*/
|
||||
export function useContainerRaw() {
|
||||
return containerSubject.getValue();
|
||||
}
|
||||
@@ -1,170 +0,0 @@
|
||||
import Context from '../structures/context';
|
||||
import type { Payload, SlashOptions } from '../../types/handler';
|
||||
import { arrAsync } from '../utilities/arrAsync';
|
||||
import { controller } from '../sern';
|
||||
import type {
|
||||
ButtonInteraction,
|
||||
ModalSubmitInteraction,
|
||||
AutocompleteInteraction,
|
||||
ChatInputCommandInteraction,
|
||||
Interaction,
|
||||
UserContextMenuCommandInteraction,
|
||||
MessageContextMenuCommandInteraction,
|
||||
} from 'discord.js';
|
||||
import { SernError } from '../structures/errors';
|
||||
import treeSearch from '../utilities/treeSearch';
|
||||
import type {
|
||||
BothCommand,
|
||||
ButtonCommand, ContextMenuMsg,
|
||||
ContextMenuUser,
|
||||
ModalSubmitCommand,
|
||||
StringSelectCommand,
|
||||
SlashCommand, UserSelectCommand, ChannelSelectCommand, MentionableSelectCommand, RoleSelectCommand,
|
||||
} from '../../types/module';
|
||||
import type SernEmitter from '../sernEmitter';
|
||||
import { EventEmitter } from 'events';
|
||||
import type { DiscordEventCommand, ExternalEventCommand, SernEventCommand } from '../structures/events';
|
||||
import * as assert from 'assert';
|
||||
import { reducePlugins } from '../utilities/functions';
|
||||
import { concatMap, from, fromEvent, map, of } from 'rxjs';
|
||||
import type { MessageComponentInteraction } from 'discord.js';
|
||||
|
||||
export function applicationCommandDispatcher(interaction: Interaction) {
|
||||
if (interaction.isAutocomplete()) {
|
||||
return dispatchAutocomplete(interaction);
|
||||
} else {
|
||||
const ctx = Context.wrap(interaction as ChatInputCommandInteraction);
|
||||
const args: ['slash', SlashOptions] = ['slash', ctx.interaction.options];
|
||||
return (mod: BothCommand | SlashCommand) => ({
|
||||
mod,
|
||||
execute: () => mod.execute(ctx, args),
|
||||
eventPluginRes: arrAsync(
|
||||
mod.onEvent.map(plugs => plugs.execute([ctx, args], controller)),
|
||||
),
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
export function dispatchAutocomplete(interaction: AutocompleteInteraction) {
|
||||
return (mod: BothCommand | SlashCommand) => {
|
||||
const selectedOption = treeSearch(interaction, mod.options);
|
||||
if (selectedOption !== undefined) {
|
||||
return {
|
||||
mod,
|
||||
execute: () => selectedOption.command.execute(interaction),
|
||||
eventPluginRes: arrAsync(
|
||||
selectedOption.command.onEvent.map(e => e.execute(interaction, controller)),
|
||||
),
|
||||
};
|
||||
}
|
||||
throw Error(
|
||||
SernError.NotSupportedInteraction + ` There is no autocomplete tag for this option`,
|
||||
);
|
||||
};
|
||||
}
|
||||
|
||||
export function modalCommandDispatcher(interaction: ModalSubmitInteraction) {
|
||||
return (mod: ModalSubmitCommand) => ({
|
||||
mod,
|
||||
execute: () => mod.execute(interaction),
|
||||
eventPluginRes: arrAsync(
|
||||
mod.onEvent.map(plugs => plugs.execute([interaction], controller)),
|
||||
),
|
||||
});
|
||||
}
|
||||
|
||||
export function buttonCommandDispatcher(interaction: ButtonInteraction) {
|
||||
return (mod: ButtonCommand) => ({
|
||||
mod,
|
||||
execute: () => mod.execute(interaction),
|
||||
eventPluginRes: arrAsync(
|
||||
mod.onEvent.map(plugs => plugs.execute([interaction], controller)),
|
||||
),
|
||||
});
|
||||
}
|
||||
|
||||
export function selectMenuCommandDispatcher(interaction: MessageComponentInteraction) {
|
||||
//safe casts because command type runtime check
|
||||
return (mod: StringSelectCommand | UserSelectCommand | ChannelSelectCommand | MentionableSelectCommand | RoleSelectCommand) => ({
|
||||
mod,
|
||||
execute: () => mod.execute(interaction as never),
|
||||
eventPluginRes: arrAsync(
|
||||
mod.onEvent.map(plugs => plugs.execute([interaction as never], controller)),
|
||||
),
|
||||
});
|
||||
}
|
||||
|
||||
export function ctxMenuUserDispatcher(interaction: UserContextMenuCommandInteraction) {
|
||||
return (mod: ContextMenuUser) => ({
|
||||
mod,
|
||||
execute: () => mod.execute(interaction),
|
||||
eventPluginRes: arrAsync(
|
||||
mod.onEvent.map(plugs => plugs.execute([interaction], controller)),
|
||||
),
|
||||
});
|
||||
}
|
||||
|
||||
export function ctxMenuMsgDispatcher(interaction: MessageContextMenuCommandInteraction) {
|
||||
return (mod: ContextMenuMsg) => ({
|
||||
mod,
|
||||
execute: () => mod.execute(interaction),
|
||||
eventPluginRes: arrAsync(
|
||||
mod.onEvent.map(plugs => plugs.execute([interaction], controller)),
|
||||
),
|
||||
});
|
||||
}
|
||||
|
||||
export function sernEmitterDispatcher(e: SernEmitter) {
|
||||
return(cmd: SernEventCommand & { name: string }) => ({
|
||||
source: e,
|
||||
cmd,
|
||||
execute: fromEvent(e, cmd.name)
|
||||
.pipe( map( event => ({
|
||||
event,
|
||||
executeEvent: of(event).pipe(concatMap(event =>
|
||||
reducePlugins(from(
|
||||
arrAsync(
|
||||
cmd.onEvent.map(plug => plug.execute([event as Payload], controller))
|
||||
))
|
||||
)))
|
||||
})))
|
||||
});
|
||||
}
|
||||
|
||||
export function discordEventDispatcher(e: EventEmitter) {
|
||||
return (cmd: DiscordEventCommand & { name: string }) => ({
|
||||
source: e,
|
||||
cmd,
|
||||
execute: fromEvent(e, cmd.name)
|
||||
.pipe( map( event => ({
|
||||
event,
|
||||
executeEvent: of(event).pipe(concatMap( event =>
|
||||
reducePlugins(from(
|
||||
arrAsync(
|
||||
// god forbid I use any!!!
|
||||
cmd.onEvent.map(plug => plug.execute([event as any], controller))
|
||||
))
|
||||
)))
|
||||
})))
|
||||
});
|
||||
}
|
||||
|
||||
export function externalEventDispatcher(e: (e:ExternalEventCommand) => unknown) {
|
||||
return (cmd: ExternalEventCommand & { name: string}) => {
|
||||
const external = e(cmd);
|
||||
assert.ok(external instanceof EventEmitter, `${e} is not an EventEmitter`);
|
||||
return {
|
||||
source: external,
|
||||
cmd,
|
||||
execute: fromEvent(external, cmd.name)
|
||||
.pipe(map(event => ({
|
||||
event,
|
||||
executeEvent : of(event).pipe(concatMap(event =>
|
||||
reducePlugins(from(arrAsync(
|
||||
cmd.onEvent.map(plug => plug.execute([event], controller))
|
||||
)))
|
||||
)),
|
||||
})))
|
||||
};
|
||||
};
|
||||
}
|
||||
@@ -1,31 +0,0 @@
|
||||
import type Wrapper from '../structures/wrapper';
|
||||
import { Subject, type Observable } from 'rxjs';
|
||||
import type { EventEmitter } from 'events';
|
||||
import type SernEmitter from '../sernEmitter';
|
||||
import type { ErrorHandling, Logging, ModuleManager } from '../contracts';
|
||||
|
||||
export abstract class EventsHandler<T> {
|
||||
protected payloadSubject = new Subject<T>();
|
||||
protected abstract discordEvent: Observable<unknown>;
|
||||
protected client: EventEmitter;
|
||||
protected emitter: SernEmitter;
|
||||
protected crashHandler: ErrorHandling;
|
||||
protected logger?: Logging;
|
||||
protected modules: ModuleManager;
|
||||
protected constructor({ containerConfig }: Wrapper) {
|
||||
const [
|
||||
client,
|
||||
emitter,
|
||||
crash,
|
||||
modules,
|
||||
logger,
|
||||
] = containerConfig.get('@sern/client', '@sern/emitter', '@sern/errors', '@sern/modules', '@sern/logger');
|
||||
this.logger = logger as Logging|undefined;
|
||||
this.modules = modules as ModuleManager;
|
||||
this.client = client as EventEmitter;
|
||||
this.emitter = emitter as SernEmitter;
|
||||
this.crashHandler = crash as ErrorHandling;
|
||||
}
|
||||
protected abstract init(): void;
|
||||
protected abstract setState(state: T): void;
|
||||
}
|
||||
@@ -1,119 +0,0 @@
|
||||
import type { Interaction } from 'discord.js';
|
||||
import { catchError, concatMap, from, fromEvent, map, Observable } from 'rxjs';
|
||||
import type Wrapper from '../structures/wrapper';
|
||||
import { EventsHandler } from './eventsHandler';
|
||||
import { SernError } from '../structures/errors';
|
||||
import { CommandType, PayloadType } from '../structures/enums';
|
||||
import { match, P } from 'ts-pattern';
|
||||
import {
|
||||
applicationCommandDispatcher,
|
||||
buttonCommandDispatcher,
|
||||
ctxMenuMsgDispatcher,
|
||||
ctxMenuUserDispatcher,
|
||||
modalCommandDispatcher,
|
||||
selectMenuCommandDispatcher,
|
||||
} from './dispatchers';
|
||||
import type {
|
||||
ButtonInteraction,
|
||||
ModalSubmitInteraction,
|
||||
UserContextMenuCommandInteraction,
|
||||
MessageContextMenuCommandInteraction,
|
||||
} from 'discord.js';
|
||||
import { executeModule } from './observableHandling';
|
||||
import type { CommandModule } from '../../types/module';
|
||||
import { handleError } from '../contracts/errorHandling';
|
||||
import type { ModuleStore } from '../structures/moduleStore';
|
||||
import type { MessageComponentInteraction } from 'discord.js';
|
||||
|
||||
export default class InteractionHandler extends EventsHandler<{
|
||||
event: Interaction;
|
||||
mod: CommandModule;
|
||||
}> {
|
||||
protected override discordEvent: Observable<Interaction>;
|
||||
constructor(wrapper: Wrapper) {
|
||||
super(wrapper);
|
||||
this.discordEvent = <Observable<Interaction>>fromEvent(this.client, 'interactionCreate');
|
||||
this.init();
|
||||
|
||||
this.payloadSubject
|
||||
.pipe(
|
||||
map(this.processModules),
|
||||
concatMap(({ mod, execute, eventPluginRes }) =>
|
||||
from(eventPluginRes).pipe(map(res => ({ mod, res, execute }))) //resolve all the Results from event plugins
|
||||
),
|
||||
concatMap(payload => executeModule(wrapper, payload)),
|
||||
catchError(handleError(this.crashHandler, this.logger)),
|
||||
)
|
||||
.subscribe();
|
||||
}
|
||||
|
||||
override init() {
|
||||
const get = (cb: (ms: ModuleStore) => CommandModule|undefined) => {
|
||||
return this.modules.get(cb);
|
||||
};
|
||||
this.discordEvent.subscribe({
|
||||
next: event => {
|
||||
if (event.isMessageComponent()) {
|
||||
const mod = get(ms =>
|
||||
ms.InteractionHandlers[event.componentType].get(event.customId));
|
||||
this.setState({ event, mod });
|
||||
} else if (event.isCommand() || event.isAutocomplete()) {
|
||||
const mod = get(ms =>
|
||||
ms.ApplicationCommands[event.commandType].get(event.commandName) ??
|
||||
ms.BothCommands.get(event.commandName)
|
||||
);
|
||||
this.setState({ event, mod });
|
||||
} else if (event.isModalSubmit()) {
|
||||
const mod = get((ms) => ms.InteractionHandlers[5].get(event.customId));
|
||||
this.setState({ event, mod });
|
||||
} else {
|
||||
throw Error('This interaction is not supported yet');
|
||||
}
|
||||
},
|
||||
error: reason => {
|
||||
this.emitter.emit('error', { type: PayloadType.Failure, reason });
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
protected setState(state: { event: Interaction; mod: CommandModule | undefined }): void {
|
||||
if (state.mod === undefined) {
|
||||
this.emitter.emit('warning',{ type: PayloadType.Warning, reason: 'Found no module for this interaction' });
|
||||
} else {
|
||||
//if statement above checks already, safe cast
|
||||
this.payloadSubject.next(state as { event: Interaction; mod: CommandModule });
|
||||
}
|
||||
}
|
||||
|
||||
protected processModules({ mod, event }: { event: Interaction; mod: CommandModule }) {
|
||||
return match(mod)
|
||||
.with(
|
||||
{ type: P.union(CommandType.Slash, CommandType.Both) },
|
||||
applicationCommandDispatcher(event),
|
||||
)
|
||||
.with(
|
||||
{ type: CommandType.Modal },
|
||||
modalCommandDispatcher(event as ModalSubmitInteraction),
|
||||
)
|
||||
.with({ type: CommandType.Button }, buttonCommandDispatcher(event as ButtonInteraction))
|
||||
.with(
|
||||
{ type: P.union(
|
||||
CommandType.RoleSelect,
|
||||
CommandType.StringSelect,
|
||||
CommandType.UserSelect,
|
||||
CommandType.MentionableSelect,
|
||||
CommandType.ChannelSelect
|
||||
) },
|
||||
selectMenuCommandDispatcher(event as MessageComponentInteraction),
|
||||
)
|
||||
.with(
|
||||
{ type: CommandType.CtxUser },
|
||||
ctxMenuUserDispatcher(event as UserContextMenuCommandInteraction),
|
||||
)
|
||||
.with(
|
||||
{ type: CommandType.CtxMsg },
|
||||
ctxMenuMsgDispatcher(event as MessageContextMenuCommandInteraction),
|
||||
)
|
||||
.otherwise(() => this.crashHandler.crash(Error(SernError.MismatchModule)));
|
||||
}
|
||||
}
|
||||
@@ -1,78 +0,0 @@
|
||||
import { EventsHandler } from './eventsHandler';
|
||||
import { catchError, concatMap, from, fromEvent, map, Observable, of, switchMap } from 'rxjs';
|
||||
import type Wrapper from '../structures/wrapper';
|
||||
import type { Message } from 'discord.js';
|
||||
import { executeModule, ignoreNonBot, isOneOfCorrectModules } from './observableHandling';
|
||||
import { fmt } from '../utilities/messageHelpers';
|
||||
import Context from '../structures/context';
|
||||
import { CommandType, PayloadType } from '../structures/enums';
|
||||
import { arrAsync } from '../utilities/arrAsync';
|
||||
import { controller } from '../sern';
|
||||
import type { CommandModule, TextCommand } from '../../types/module';
|
||||
import { handleError } from '../contracts/errorHandling';
|
||||
import type { ModuleStore } from '../structures/moduleStore';
|
||||
|
||||
export default class MessageHandler extends EventsHandler<{
|
||||
ctx: Context;
|
||||
args: ['text', string[]];
|
||||
mod: TextCommand;
|
||||
}> {
|
||||
protected discordEvent: Observable<Message>;
|
||||
public constructor(protected wrapper: Wrapper) {
|
||||
super(wrapper);
|
||||
this.discordEvent = <Observable<Message>>fromEvent(this.client, 'messageCreate');
|
||||
this.init();
|
||||
this.payloadSubject
|
||||
.pipe(
|
||||
switchMap(({ mod, ctx, args }) => {
|
||||
const res = arrAsync(
|
||||
mod.onEvent.map(ep => ep.execute([ctx, args], controller)),
|
||||
);
|
||||
const execute = () => mod.execute(ctx, args);
|
||||
//resolves the promise and re-emits it back into source
|
||||
return from(res).pipe(map(res => ({ mod, execute, res })));
|
||||
}),
|
||||
concatMap(payload => executeModule(wrapper, payload)),
|
||||
catchError(handleError(this.crashHandler, this.logger)),
|
||||
)
|
||||
.subscribe();
|
||||
}
|
||||
|
||||
protected init(): void {
|
||||
if (this.wrapper.defaultPrefix === undefined) return; //for now, just ignore if prefix doesn't exist
|
||||
const { defaultPrefix } = this.wrapper;
|
||||
const get = (cb: (ms: ModuleStore) => CommandModule | undefined) => {
|
||||
return this.modules.get(cb);
|
||||
};
|
||||
this.discordEvent
|
||||
.pipe(
|
||||
ignoreNonBot(this.wrapper.defaultPrefix),
|
||||
map(message => {
|
||||
const [prefix, ...rest] = fmt(message, defaultPrefix);
|
||||
return {
|
||||
ctx: Context.wrap(message),
|
||||
args: <['text', string[]]>['text', rest],
|
||||
mod: get(ms =>
|
||||
ms.TextCommands.get(prefix) ??
|
||||
ms.BothCommands.get(prefix)
|
||||
),
|
||||
};
|
||||
}),
|
||||
concatMap(element =>
|
||||
of(element.mod).pipe(
|
||||
isOneOfCorrectModules(CommandType.Text),
|
||||
map(mod => ({ ...element, mod })),
|
||||
),
|
||||
),
|
||||
)
|
||||
.subscribe({
|
||||
next: value => this.setState(value),
|
||||
error: reason =>
|
||||
this.emitter.emit('error', { type: PayloadType.Failure, reason }),
|
||||
});
|
||||
}
|
||||
|
||||
protected setState(state: { ctx: Context; args: ['text', string[]]; mod: TextCommand }) {
|
||||
this.payloadSubject.next(state);
|
||||
}
|
||||
}
|
||||
@@ -1,143 +0,0 @@
|
||||
import type { Message } from 'discord.js';
|
||||
import { concatMap, from, map, Observable, of, switchMap, tap, throwError, toArray } from 'rxjs';
|
||||
import { SernError } from '../structures/errors';
|
||||
import { Result } from 'ts-results-es';
|
||||
import type { CommandType } from '../structures/enums';
|
||||
import type Wrapper from '../structures/wrapper';
|
||||
import { PayloadType, PluginType } from '../structures/enums';
|
||||
import type { CommandModule, CommandModuleDefs, AnyModule } from '../../types/module';
|
||||
import { _const } from '../utilities/functions';
|
||||
import type SernEmitter from '../sernEmitter';
|
||||
import type { DefinedCommandModule, DefinedEventModule } from '../../types/handler';
|
||||
import type { Awaitable } from 'discord.js';
|
||||
import { processCommandPlugins } from './userDefinedEventsHandling';
|
||||
|
||||
export function ignoreNonBot(prefix: string) {
|
||||
return (src: Observable<Message>) =>
|
||||
new Observable<Message>(subscriber => {
|
||||
return src.subscribe({
|
||||
next(m) {
|
||||
const messageFromHumanAndHasPrefix =
|
||||
!m.author.bot &&
|
||||
m.content
|
||||
.slice(0, prefix.length)
|
||||
.localeCompare(prefix, undefined, { sensitivity: 'accent' }) === 0;
|
||||
if (messageFromHumanAndHasPrefix) {
|
||||
subscriber.next(m);
|
||||
}
|
||||
},
|
||||
error: e => subscriber.error(e),
|
||||
complete: () => subscriber.complete(),
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* If the current value in Result stream is an error, calls callback.
|
||||
* @param cb
|
||||
*/
|
||||
export function errTap<T extends AnyModule>(cb: (err: SernError) => void) {
|
||||
return (src: Observable<Result<{ mod: T; absPath: string }, SernError>>) =>
|
||||
new Observable<{ mod: T; absPath: string }>(subscriber => {
|
||||
return src.subscribe({
|
||||
next(value) {
|
||||
if (value.err) {
|
||||
cb(value.val);
|
||||
} else {
|
||||
subscriber.next(value.val);
|
||||
}
|
||||
},
|
||||
error: e => subscriber.error(e),
|
||||
complete: () => subscriber.complete(),
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
//POG
|
||||
export function isOneOfCorrectModules<T extends readonly CommandType[]>(...inputs: [...T]) {
|
||||
return (src: Observable<CommandModule | undefined>) => {
|
||||
return new Observable<CommandModuleDefs[T[number]]>(subscriber => {
|
||||
return src.subscribe({
|
||||
next(mod) {
|
||||
if (mod === undefined) {
|
||||
return throwError(_const(SernError.UndefinedModule));
|
||||
}
|
||||
if (inputs.some(type => (mod.type & type) !== 0)) {
|
||||
subscriber.next(mod as CommandModuleDefs[T[number]]);
|
||||
} else {
|
||||
return throwError(_const(SernError.MismatchModule));
|
||||
}
|
||||
},
|
||||
error: e => subscriber.error(e),
|
||||
complete: () => subscriber.complete(),
|
||||
});
|
||||
});
|
||||
};
|
||||
}
|
||||
|
||||
export function executeModule(
|
||||
wrapper: Wrapper,
|
||||
payload: {
|
||||
mod: CommandModule;
|
||||
execute: () => unknown;
|
||||
res: Result<void, void>[];
|
||||
},
|
||||
) {
|
||||
const emitter = wrapper.containerConfig.get('@sern/emitter')[0] as SernEmitter;
|
||||
if (payload.res.every(el => el.ok)) {
|
||||
const executeFn = Result.wrapAsync<unknown, Error | string>(() => Promise.resolve(payload.execute()));
|
||||
return from(executeFn).pipe(
|
||||
concatMap(res => {
|
||||
if (res.err) {
|
||||
return throwError(() => ({
|
||||
type: PayloadType.Failure,
|
||||
reason: res.val,
|
||||
module: payload.mod,
|
||||
}));
|
||||
}
|
||||
return of(res.val).pipe(
|
||||
tap(() =>
|
||||
emitter.emit('module.activate', {
|
||||
type: PayloadType.Success,
|
||||
module: payload.mod,
|
||||
}),
|
||||
),
|
||||
);
|
||||
}),
|
||||
);
|
||||
} else {
|
||||
emitter.emit('module.activate', {
|
||||
type: PayloadType.Failure,
|
||||
module: payload.mod,
|
||||
reason: SernError.PluginFailure,
|
||||
});
|
||||
return of(undefined);
|
||||
}
|
||||
}
|
||||
|
||||
export function resolvePlugins({ mod, cmdPluginRes }: {
|
||||
mod: DefinedCommandModule | DefinedEventModule;
|
||||
cmdPluginRes: {
|
||||
execute: Awaitable<Result<void, void>>;
|
||||
type: PluginType.Command;
|
||||
}[];
|
||||
}) {
|
||||
if (mod.plugins.length === 0) {
|
||||
return of({ mod, pluginRes: [] });
|
||||
}
|
||||
// modules with no event plugins are ignored in the previous
|
||||
return from(cmdPluginRes).pipe(
|
||||
switchMap(pl =>
|
||||
from(pl.execute).pipe(
|
||||
map(execute => ({ ...pl, execute })),
|
||||
toArray(),
|
||||
),
|
||||
),
|
||||
map(pluginRes => ({ mod, pluginRes })),
|
||||
);
|
||||
}
|
||||
|
||||
export function processPlugins(payload: { mod: DefinedCommandModule | DefinedEventModule; absPath: string }) {
|
||||
const cmdPluginRes = processCommandPlugins(payload);
|
||||
return of({ mod: payload.mod, cmdPluginRes });
|
||||
}
|
||||
@@ -1,134 +0,0 @@
|
||||
import { EventsHandler } from './eventsHandler';
|
||||
import type Wrapper from '../structures/wrapper';
|
||||
import { concatMap, fromEvent, Observable, map, take } from 'rxjs';
|
||||
import * as Files from '../utilities/readFile';
|
||||
import { errTap, processPlugins, resolvePlugins } from './observableHandling';
|
||||
import { CommandType, PayloadType } from '../structures/enums';
|
||||
import { SernError } from '../structures/errors';
|
||||
import { match } from 'ts-pattern';
|
||||
import { Result } from 'ts-results-es';
|
||||
import { ApplicationCommandType, ComponentType } from 'discord.js';
|
||||
import type { CommandModule } from '../../types/module';
|
||||
import type { DefinedCommandModule, DefinedEventModule } from '../../types/handler';
|
||||
import type { ModuleManager } from '../contracts';
|
||||
import type { ModuleStore } from '../structures/moduleStore';
|
||||
import { _const, err, nameOrFilename, ok } from '../utilities/functions';
|
||||
|
||||
export default class ReadyHandler extends EventsHandler<{
|
||||
mod: DefinedCommandModule;
|
||||
absPath: string;
|
||||
}> {
|
||||
protected discordEvent!: Observable<{ mod: CommandModule; absPath: string }>;
|
||||
constructor(wrapper: Wrapper) {
|
||||
super(wrapper);
|
||||
const ready$ = fromEvent(this.client, 'ready').pipe(take(1));
|
||||
this.discordEvent = ready$.pipe(
|
||||
concatMap(() =>
|
||||
Files.buildData<CommandModule>(wrapper.commands).pipe(
|
||||
errTap(reason =>
|
||||
this.emitter.emit('module.register', {
|
||||
type: PayloadType.Failure,
|
||||
module: undefined,
|
||||
reason,
|
||||
}),
|
||||
),
|
||||
),
|
||||
),
|
||||
);
|
||||
this.init();
|
||||
this.payloadSubject
|
||||
.pipe(
|
||||
concatMap(processPlugins),
|
||||
concatMap(resolvePlugins),
|
||||
).subscribe(payload => {
|
||||
const allPluginsSuccessful = payload.pluginRes.every(({ execute }) => execute.ok);
|
||||
if (allPluginsSuccessful) {
|
||||
const res = registerModule(this.modules, payload.mod);
|
||||
if (res.err) {
|
||||
this.crashHandler.crash(Error(SernError.InvalidModuleType));
|
||||
}
|
||||
this.emitter.emit('module.register', {
|
||||
type: PayloadType.Success,
|
||||
module: payload.mod,
|
||||
});
|
||||
} else {
|
||||
this.emitter.emit('module.register', {
|
||||
type: PayloadType.Failure,
|
||||
module: payload.mod,
|
||||
reason: SernError.PluginFailure,
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
private static intoDefinedModule({ absPath, mod }: { absPath: string; mod: CommandModule }): {
|
||||
absPath: string;
|
||||
mod: DefinedCommandModule;
|
||||
} {
|
||||
return {
|
||||
absPath,
|
||||
mod: {
|
||||
name: nameOrFilename(mod.name, absPath),
|
||||
description: mod?.description ?? '...',
|
||||
...mod,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
protected init() {
|
||||
this.discordEvent.pipe(map(ReadyHandler.intoDefinedModule)).subscribe({
|
||||
next: value => this.setState(value),
|
||||
complete: () => this.payloadSubject.unsubscribe(),
|
||||
});
|
||||
}
|
||||
protected setState(state: { absPath: string; mod: DefinedCommandModule }): void {
|
||||
this.payloadSubject.next(state);
|
||||
}
|
||||
}
|
||||
|
||||
function registerModule(manager: ModuleManager, mod: DefinedCommandModule | DefinedEventModule): Result<void, void> {
|
||||
const name = mod.name;
|
||||
const insert = (cb: (ms: ModuleStore) => void) => {
|
||||
const set = Result.wrap(_const(manager.set(cb)));
|
||||
return set.ok ? ok() : err();
|
||||
};
|
||||
return match<DefinedCommandModule | DefinedEventModule>(mod)
|
||||
.with({ type: CommandType.Text }, mod => {
|
||||
mod.alias?.forEach(a => insert(ms => ms.TextCommands.set(a, mod)));
|
||||
return insert(ms => ms.TextCommands.set(name, mod));
|
||||
})
|
||||
.with({ type: CommandType.Slash }, mod =>
|
||||
insert(ms => ms.ApplicationCommands[ApplicationCommandType.ChatInput].set(name, mod))
|
||||
)
|
||||
.with({ type: CommandType.Both }, mod => {
|
||||
mod.alias?.forEach(a => insert(ms => ms.TextCommands.set(a, mod)));
|
||||
return insert( ms => ms.BothCommands.set(name, mod));
|
||||
})
|
||||
.with({ type: CommandType.CtxUser }, mod =>
|
||||
insert(ms => ms.ApplicationCommands[ApplicationCommandType.User].set(name, mod))
|
||||
)
|
||||
.with({ type: CommandType.CtxMsg }, mod =>
|
||||
insert(ms => ms.ApplicationCommands[ApplicationCommandType.Message].set(name, mod))
|
||||
)
|
||||
.with({ type: CommandType.Button }, mod =>
|
||||
insert(ms => ms.InteractionHandlers[ComponentType.Button].set(name, mod))
|
||||
)
|
||||
.with({ type: CommandType.StringSelect }, mod =>
|
||||
insert(ms => ms.InteractionHandlers[ComponentType.StringSelect].set(name, mod))
|
||||
)
|
||||
.with( { type: CommandType.MentionableSelect }, mod =>
|
||||
insert (ms => ms.InteractionHandlers[ComponentType.MentionableSelect].set(name, mod))
|
||||
)
|
||||
.with( { type: CommandType.ChannelSelect }, mod =>
|
||||
insert ( ms => ms.InteractionHandlers[ComponentType.ChannelSelect].set(name, mod))
|
||||
)
|
||||
.with( { type: CommandType.UserSelect }, mod =>
|
||||
insert ( ms => ms.InteractionHandlers[ComponentType.UserSelect].set(name, mod))
|
||||
)
|
||||
.with( { type: CommandType.RoleSelect}, mod =>
|
||||
insert ( ms => ms.InteractionHandlers[ComponentType.RoleSelect].set(name, mod))
|
||||
)
|
||||
.with({ type: CommandType.Modal }, mod =>
|
||||
insert(ms => ms.ModalSubmit.set(name, mod))
|
||||
)
|
||||
.otherwise(err);
|
||||
}
|
||||
@@ -1,108 +0,0 @@
|
||||
import { catchError, concatMap, filter, from, iif, map, of, tap, toArray } from 'rxjs';
|
||||
import { buildData } from '../utilities/readFile';
|
||||
import { controller } from '../sern';
|
||||
import type { DefinedCommandModule, DefinedEventModule, Dependencies } from '../../types/handler';
|
||||
import { PayloadType, PluginType } from '../structures/enums';
|
||||
import type Wrapper from '../structures/wrapper';
|
||||
import { isDiscordEvent, isExternalEvent, isSernEvent } from '../utilities/predicates';
|
||||
import { errTap, processPlugins, resolvePlugins } from './observableHandling';
|
||||
import type { AnyModule, EventModule } from '../../types/module';
|
||||
import type { EventEmitter } from 'events';
|
||||
import type SernEmitter from '../sernEmitter';
|
||||
import { nameOrFilename, reducePlugins } from '../utilities/functions';
|
||||
import { match } from 'ts-pattern';
|
||||
import { discordEventDispatcher, externalEventDispatcher, sernEmitterDispatcher } from './dispatchers';
|
||||
import type { ErrorHandling, Logging } from '../contracts';
|
||||
import { SernError } from '../structures/errors';
|
||||
import { handleError } from '../contracts/errorHandling';
|
||||
import type { Awaitable } from 'discord.js';
|
||||
import type { Result } from 'ts-results-es';
|
||||
|
||||
/**
|
||||
* Utility function to process command plugins for all Modules
|
||||
* @param payload
|
||||
*/
|
||||
export function processCommandPlugins<T extends DefinedCommandModule | DefinedEventModule>(
|
||||
payload: { mod: T; absPath: string },
|
||||
): {type: PluginType.Command, execute: Awaitable<Result<void,void>>}[] {
|
||||
return payload.mod.plugins.map(plug => ({
|
||||
type: plug.type,
|
||||
execute: plug.execute(payload as any, controller),
|
||||
}));
|
||||
}
|
||||
|
||||
export function processEvents({ containerConfig, events }: Wrapper) {
|
||||
const [
|
||||
client,
|
||||
error,
|
||||
sernEmitter,
|
||||
logging
|
||||
] = containerConfig.get('@sern/client', '@sern/errors', '@sern/emitter', '@sern/logger') as [EventEmitter, ErrorHandling, SernEmitter, Logging?];
|
||||
const lazy = (k: string) => containerConfig.get(k as keyof Dependencies)[0];
|
||||
const eventStream$ = eventObservable$(events!, sernEmitter);
|
||||
const emitSuccess$ = (mod: AnyModule) =>
|
||||
of({ type: PayloadType.Failure, module: mod, reason: SernError.PluginFailure })
|
||||
.pipe(tap( it => sernEmitter.emit('module.register', it)));
|
||||
const emitFailure$ = (mod: AnyModule) =>
|
||||
of({ type: PayloadType.Success, module: mod, } as const)
|
||||
.pipe(tap(it => sernEmitter.emit('module.register', it)));
|
||||
const eventCreation$ = eventStream$.pipe(
|
||||
map(({ mod, absPath }) => ({
|
||||
mod : {
|
||||
name: nameOrFilename(mod.name, absPath),
|
||||
...mod,
|
||||
} as DefinedEventModule,
|
||||
absPath
|
||||
})),
|
||||
concatMap(processPlugins),
|
||||
concatMap(resolvePlugins),
|
||||
//Reduces pluginRes (generated from above) into a single boolean
|
||||
concatMap(({pluginRes, mod}) => from(pluginRes)
|
||||
.pipe(
|
||||
map(pl => pl.execute),
|
||||
toArray(),
|
||||
reducePlugins,
|
||||
map(success => ({ success, mod }))
|
||||
)),
|
||||
concatMap(({ success, mod }) =>
|
||||
iif(() => success,
|
||||
emitFailure$(mod),
|
||||
emitSuccess$(mod)
|
||||
).pipe(
|
||||
filter(res => res.type === PayloadType.Success),
|
||||
map(() => mod)
|
||||
)
|
||||
),
|
||||
);
|
||||
eventCreation$.subscribe(e => {
|
||||
const payload = match(e)
|
||||
.when(isSernEvent, sernEmitterDispatcher(sernEmitter))
|
||||
.when(isDiscordEvent, discordEventDispatcher(client))
|
||||
.when(isExternalEvent, externalEventDispatcher(e => lazy(e.emitter)))
|
||||
.otherwise(() => error.crash(Error(SernError.InvalidModuleType)));
|
||||
payload
|
||||
.execute
|
||||
.pipe(
|
||||
concatMap(({event, executeEvent}) =>
|
||||
executeEvent
|
||||
.pipe( tap(success => {
|
||||
if(success)
|
||||
payload.cmd.execute(event as never);
|
||||
}), catchError(handleError(error, logging)))
|
||||
),
|
||||
).subscribe();
|
||||
});
|
||||
}
|
||||
|
||||
function eventObservable$(events: string, emitter: SernEmitter) {
|
||||
return buildData<EventModule>(events)
|
||||
.pipe(
|
||||
errTap(reason =>
|
||||
emitter.emit('module.register', {
|
||||
type: PayloadType.Failure,
|
||||
module: undefined,
|
||||
reason,
|
||||
}),
|
||||
),
|
||||
);
|
||||
}
|
||||
@@ -1,147 +0,0 @@
|
||||
/*
|
||||
* Plugins can be inserted on all commands and are emitted
|
||||
*
|
||||
* 1. On ready event, where all commands are loaded.
|
||||
* 2. On corresponding observable (when command triggers)
|
||||
*
|
||||
* The goal of plugins is to organize commands and
|
||||
* provide extensions to repetitive patterns
|
||||
* examples include refreshing modules,
|
||||
* categorizing commands, cool-downs, permissions, etc.
|
||||
* Plugins are reminiscent of middleware in express.
|
||||
*/
|
||||
|
||||
import type { AutocompleteInteraction, Awaitable, ClientEvents } from 'discord.js';
|
||||
import type { Result, Ok, Err } from 'ts-results-es';
|
||||
import type { CommandType, SernEventsMapping } from '../../index';
|
||||
import { EventType, PluginType } from '../../index';
|
||||
import type { CommandModuleDefs, EventModuleDefs } from '../../types/module';
|
||||
import type {
|
||||
DiscordEventCommand,
|
||||
ExternalEventCommand,
|
||||
SernEventCommand,
|
||||
} from '../structures/events';
|
||||
|
||||
export interface Controller {
|
||||
next: () => Ok<void>;
|
||||
stop: () => Err<void>;
|
||||
}
|
||||
export interface Plugin {
|
||||
/** @deprecated will be removed in the next update */
|
||||
name?: string;
|
||||
/** @deprecated will be removed in the next update */
|
||||
description?: string;
|
||||
type: PluginType
|
||||
}
|
||||
|
||||
export interface CommandPlugin<T extends keyof CommandModuleDefs = keyof CommandModuleDefs> extends Plugin {
|
||||
type: PluginType.Command;
|
||||
execute: (
|
||||
payload: {
|
||||
mod: CommandModuleDefs[T] & { name : string; description : string };
|
||||
absPath: string;
|
||||
},
|
||||
controller: Controller,
|
||||
) => Awaitable<Result<void, void>>;
|
||||
}
|
||||
export interface DiscordEmitterPlugin extends Plugin {
|
||||
type: PluginType.Command;
|
||||
execute: (
|
||||
payload: { mod: DiscordEventCommand & { name: string }; absPath: string },
|
||||
controller: Controller,
|
||||
) => Awaitable<Result<void, void>>;
|
||||
}
|
||||
|
||||
export interface ExternalEmitterPlugin extends Plugin {
|
||||
type: PluginType.Command;
|
||||
execute: (
|
||||
payload: { mod: ExternalEventCommand & { name : string }; absPath: string } ,
|
||||
controller: Controller,
|
||||
) => Awaitable<Result<void, void>>;
|
||||
}
|
||||
|
||||
export interface SernEmitterPlugin extends Plugin {
|
||||
type: PluginType.Command;
|
||||
execute: (
|
||||
payload: { mod : SernEventCommand & { name : string }; absPath: string },
|
||||
controller: Controller,
|
||||
) => Awaitable<Result<void, void>>;
|
||||
}
|
||||
|
||||
export interface AutocompletePlugin extends Plugin {
|
||||
type: PluginType.Event;
|
||||
execute: (
|
||||
autocmp: AutocompleteInteraction,
|
||||
controlller: Controller,
|
||||
) => Awaitable<Result<void, void>>;
|
||||
}
|
||||
|
||||
|
||||
export interface EventPlugin<K extends keyof CommandModuleDefs = keyof CommandModuleDefs> extends Plugin {
|
||||
type: PluginType.Event;
|
||||
execute: (
|
||||
event: Parameters<CommandModuleDefs[K]['execute']>,
|
||||
controller: Controller,
|
||||
) => Awaitable<Result<void, void>>;
|
||||
}
|
||||
|
||||
export interface SernEventPlugin<T extends keyof SernEventsMapping = keyof SernEventsMapping> extends Plugin {
|
||||
name?: T;
|
||||
type: PluginType.Event;
|
||||
execute: (
|
||||
args: SernEventsMapping[T],
|
||||
controller: Controller,
|
||||
) => Awaitable<Result<void, void>>;
|
||||
}
|
||||
|
||||
export interface ExternalEventPlugin extends Plugin {
|
||||
type: PluginType.Event;
|
||||
execute: (args: unknown[], controller: Controller) => Awaitable<Result<void, void>>;
|
||||
}
|
||||
|
||||
export interface DiscordEventPlugin<T extends keyof ClientEvents = keyof ClientEvents> extends Plugin {
|
||||
name?: T;
|
||||
type: PluginType.Event;
|
||||
execute: (args: ClientEvents[T], controller: Controller) => Awaitable<Result<void, void>>;
|
||||
}
|
||||
|
||||
export type CommandModuleNoPlugins = {
|
||||
[T in CommandType]: Omit<CommandModuleDefs[T], 'plugins' | 'onEvent'>;
|
||||
};
|
||||
export type EventModulesNoPlugins = {
|
||||
[T in EventType]: Omit<EventModuleDefs[T], 'plugins' | 'onEvent'>;
|
||||
};
|
||||
/**
|
||||
* Event Module Event Plugins
|
||||
*/
|
||||
export type EventModuleEventPluginDefs = {
|
||||
[EventType.Discord]: DiscordEventPlugin;
|
||||
[EventType.Sern]: SernEventPlugin;
|
||||
[EventType.External]: ExternalEventPlugin;
|
||||
};
|
||||
|
||||
/**
|
||||
* Event Module Command Plugins
|
||||
*/
|
||||
export type EventModuleCommandPluginDefs = {
|
||||
[EventType.Discord]: DiscordEmitterPlugin;
|
||||
[EventType.Sern]: SernEmitterPlugin;
|
||||
[EventType.External]: ExternalEmitterPlugin;
|
||||
};
|
||||
|
||||
export type EventModulePlugin<T extends EventType> =
|
||||
| EventModuleEventPluginDefs[T]
|
||||
| EventModuleCommandPluginDefs[T];
|
||||
|
||||
export type CommandModulePlugin<T extends CommandType> = EventPlugin<T> | CommandPlugin<T>;
|
||||
|
||||
/**
|
||||
* User inputs this type. Sern processes behind the scenes for better usage
|
||||
*/
|
||||
export type InputCommandModule = {
|
||||
[T in CommandType]: CommandModuleNoPlugins[T] & { plugins?: CommandModulePlugin<T>[] };
|
||||
}[CommandType];
|
||||
|
||||
export type InputEventModule = {
|
||||
[T in EventType]: EventModulesNoPlugins[T] & { plugins?: EventModulePlugin<T>[] };
|
||||
}[EventType];
|
||||
@@ -1,109 +0,0 @@
|
||||
import type Wrapper from './structures/wrapper';
|
||||
import { processEvents } from './events/userDefinedEventsHandling';
|
||||
import { CommandType, EventType, PluginType } from './structures/enums';
|
||||
import type {
|
||||
Plugin,
|
||||
CommandPlugin,
|
||||
EventModuleCommandPluginDefs,
|
||||
EventModuleEventPluginDefs,
|
||||
EventPlugin,
|
||||
InputCommandModule,
|
||||
InputEventModule,
|
||||
} from './plugins/plugin';
|
||||
import InteractionHandler from './events/interactionHandler';
|
||||
import ReadyHandler from './events/readyHandler';
|
||||
import MessageHandler from './events/messageHandler';
|
||||
import type { CommandModule, CommandModuleDefs, EventModule, EventModuleDefs } from '../types/module';
|
||||
import { Container, createContainer } from 'iti';
|
||||
import type { Dependencies, OptionalDependencies } from '../types/handler';
|
||||
import { composeRoot, containerSubject, useContainer } from './dependencies/provider';
|
||||
import type { Logging } from './contracts';
|
||||
import { err, ok, partition } from './utilities/functions';
|
||||
/**
|
||||
*
|
||||
* @param wrapper Options to pass into sern.
|
||||
* Function to start the handler up
|
||||
* @example
|
||||
* ```ts title="src/index.ts"
|
||||
* Sern.init({
|
||||
* defaultPrefix: '!',
|
||||
* commands: 'dist/commands',
|
||||
* events: 'dist/events',
|
||||
* containerConfig : {
|
||||
* get: useContainer
|
||||
* }
|
||||
* })
|
||||
* ```
|
||||
*/
|
||||
export function init(wrapper: Wrapper) {
|
||||
const logger = wrapper.containerConfig.get('@sern/logger')[0] as Logging | undefined;
|
||||
const startTime = performance.now();
|
||||
const { events } = wrapper;
|
||||
if (events !== undefined) {
|
||||
processEvents(wrapper);
|
||||
}
|
||||
new ReadyHandler(wrapper);
|
||||
new MessageHandler(wrapper);
|
||||
new InteractionHandler(wrapper);
|
||||
const endTime = performance.now();
|
||||
logger?.info({ message: `sern : ${(endTime-startTime).toFixed(2)} ms` });
|
||||
}
|
||||
|
||||
/**
|
||||
* The object passed into every plugin to control a command's behavior
|
||||
*/
|
||||
export const controller = {
|
||||
next: ok,
|
||||
stop: err,
|
||||
};
|
||||
|
||||
/**
|
||||
* The wrapper function to define command modules for sern
|
||||
* @param mod
|
||||
*/
|
||||
export function commandModule(mod: InputCommandModule): CommandModule {
|
||||
const [onEvent, plugins] = partition(mod.plugins ?? [], el => (el as Plugin).type === PluginType.Event);
|
||||
return {
|
||||
...mod,
|
||||
onEvent,
|
||||
plugins,
|
||||
} as CommandModule;
|
||||
}
|
||||
/**
|
||||
* The wrapper function to define event modules for sern
|
||||
* @param mod
|
||||
*/
|
||||
export function eventModule(mod: InputEventModule): EventModule {
|
||||
const [onEvent, plugins] = partition(mod.plugins ?? [], el => (el as Plugin).type === PluginType.Event);
|
||||
return {
|
||||
...mod,
|
||||
onEvent,
|
||||
plugins,
|
||||
} as EventModule;
|
||||
}
|
||||
/**
|
||||
* @param conf a configuration for creating your project dependencies
|
||||
*/
|
||||
export function makeDependencies<T extends Dependencies>(conf: {
|
||||
exclude?: Set<OptionalDependencies>,
|
||||
build: (root: Container<Record<string,any>, {}>) => Container<Partial<T>, T>,
|
||||
}) {
|
||||
const container = conf.build(createContainer());
|
||||
composeRoot(container, conf.exclude ?? new Set());
|
||||
containerSubject.next(container as unknown as Container<Dependencies, {}>);
|
||||
return useContainer<T>();
|
||||
}
|
||||
|
||||
export abstract class CommandExecutable<Type extends CommandType> {
|
||||
abstract type: Type;
|
||||
plugins: CommandPlugin<Type>[] = [];
|
||||
onEvent: EventPlugin<Type>[] = [];
|
||||
abstract execute: CommandModuleDefs[Type]['execute'];
|
||||
}
|
||||
|
||||
export abstract class EventExecutable<Type extends EventType> {
|
||||
abstract type: Type;
|
||||
plugins: EventModuleCommandPluginDefs[Type][] = [];
|
||||
onEvent: EventModuleEventPluginDefs[Type][] = [];
|
||||
abstract execute: EventModuleDefs[Type]['execute'];
|
||||
}
|
||||
@@ -1,40 +0,0 @@
|
||||
import { EventEmitter } from 'events';
|
||||
import type { SernEventsMapping } from '../types/handler';
|
||||
|
||||
class SernEmitter extends EventEmitter {
|
||||
/**
|
||||
* Listening to sern events with on. This event stays on until a crash or a normal exit
|
||||
* @param eventName
|
||||
* @param listener what to do with the data
|
||||
*/
|
||||
public override on<T extends keyof SernEventsMapping>(
|
||||
eventName: T,
|
||||
listener: (...args: SernEventsMapping[T][]) => void,
|
||||
): this {
|
||||
return super.on(eventName, listener);
|
||||
}
|
||||
/**
|
||||
* Listening to sern events with on. This event stays on until a crash or a normal exit
|
||||
* @param eventName
|
||||
* @param listener what to do with the data
|
||||
*/
|
||||
public override once<T extends keyof SernEventsMapping>(
|
||||
eventName: T,
|
||||
listener: (...args: SernEventsMapping[T][]) => void,
|
||||
): this {
|
||||
return super.once(eventName, listener);
|
||||
}
|
||||
/**
|
||||
* Listening to sern events with on. This event stays on until a crash or a normal exit
|
||||
* @param eventName
|
||||
* @param args the arguments for emitting the eventName
|
||||
*/
|
||||
public override emit<T extends keyof SernEventsMapping>(
|
||||
eventName: T,
|
||||
...args: SernEventsMapping[T]
|
||||
): boolean {
|
||||
return super.emit(eventName, ...args);
|
||||
}
|
||||
}
|
||||
|
||||
export default SernEmitter;
|
||||
@@ -1,132 +0,0 @@
|
||||
import type {
|
||||
ChatInputCommandInteraction,
|
||||
Client,
|
||||
InteractionReplyOptions,
|
||||
Message,
|
||||
Snowflake,
|
||||
MessageReplyOptions,
|
||||
User,
|
||||
} from 'discord.js';
|
||||
import { Result as Either, Ok as Left, Err as Right } from 'ts-results-es';
|
||||
import type { ReplyOptions } from '../../types/handler';
|
||||
import { SernError } from './errors';
|
||||
|
||||
|
||||
function safeUnwrap<T>(res: Either<T, T>) {
|
||||
return res.val;
|
||||
}
|
||||
/**
|
||||
* Provides values shared between
|
||||
* Message and ChatInputCommandInteraction
|
||||
*/
|
||||
export default class Context {
|
||||
private constructor(
|
||||
private ctx: Either<Message, ChatInputCommandInteraction>,
|
||||
) {}
|
||||
|
||||
/**
|
||||
* Getting the Message object. Crashes if module type is
|
||||
* CommandType.Slash or the event fired in a Both command was
|
||||
* ChatInputCommandInteraction
|
||||
*/
|
||||
public get message() {
|
||||
return this.ctx.expect(SernError.MismatchEvent);
|
||||
}
|
||||
/**
|
||||
* Getting the ChatInputCommandInteraction object. Crashes if module type is
|
||||
* CommandType.Text or the event fired in a Both command was
|
||||
* Message
|
||||
*/
|
||||
public get interaction() {
|
||||
return this.ctx.expectErr(SernError.MismatchEvent);
|
||||
}
|
||||
|
||||
public get id(): Snowflake {
|
||||
return safeUnwrap(
|
||||
this.ctx
|
||||
.map(m => m.id)
|
||||
.mapErr(i => i.id));
|
||||
}
|
||||
|
||||
public get channel() {
|
||||
return safeUnwrap(this.ctx
|
||||
.map(m => m.channel)
|
||||
.mapErr(i => i.channel));
|
||||
}
|
||||
/**
|
||||
* If context is holding a message, message.author
|
||||
* else, interaction.user
|
||||
*/
|
||||
public get user(): User {
|
||||
return safeUnwrap(this.ctx
|
||||
.map(m => m.author)
|
||||
.mapErr(i => i.user)
|
||||
);
|
||||
}
|
||||
|
||||
public get createdTimestamp(): number {
|
||||
return safeUnwrap(this.ctx
|
||||
.map(m => m.createdTimestamp)
|
||||
.mapErr(i => i.createdTimestamp)
|
||||
);
|
||||
}
|
||||
|
||||
public get guild() {
|
||||
return safeUnwrap(this.ctx
|
||||
.map(m => m.guild)
|
||||
.mapErr(i => i.guild)
|
||||
);
|
||||
}
|
||||
|
||||
public get guildId() {
|
||||
return safeUnwrap(this.ctx
|
||||
.map(m => m.guildId)
|
||||
.mapErr(i => i.guildId)
|
||||
);
|
||||
}
|
||||
|
||||
/*
|
||||
* interactions can return APIGuildMember if the guild it is emitted from is not cached
|
||||
*/
|
||||
public get member() {
|
||||
return safeUnwrap(this.ctx
|
||||
.map(m => m.member)
|
||||
.mapErr(i => i.member)
|
||||
);
|
||||
}
|
||||
|
||||
public get client(): Client {
|
||||
return safeUnwrap(this.ctx
|
||||
.map(m => m.client)
|
||||
.mapErr(i => i.client)
|
||||
);
|
||||
}
|
||||
|
||||
public get inGuild(): boolean {
|
||||
return safeUnwrap(this.ctx
|
||||
.map(m=>m.inGuild())
|
||||
.mapErr(i => i.inGuild())
|
||||
);
|
||||
}
|
||||
public isMessage() {
|
||||
return this.ctx.map(() => true).unwrapOr(false);
|
||||
}
|
||||
|
||||
public isSlash() {
|
||||
return !this.isMessage();
|
||||
}
|
||||
|
||||
static wrap(wrappable: ChatInputCommandInteraction | Message): Context {
|
||||
if ('token' in wrappable) {
|
||||
return new Context(Right(wrappable));
|
||||
}
|
||||
return new Context(Left(wrappable));
|
||||
}
|
||||
|
||||
public reply(content: ReplyOptions) {
|
||||
return safeUnwrap(this.ctx
|
||||
.map( m => m.reply(content as string | MessageReplyOptions))
|
||||
.mapErr(i => i.reply(content as string | InteractionReplyOptions).then(() => i.fetchReply()))
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -1,38 +0,0 @@
|
||||
/**
|
||||
* @enum { string }
|
||||
*/
|
||||
export enum SernError {
|
||||
/**
|
||||
* Throws when registering an invalid module.
|
||||
* This means it is undefined or an invalid command type was provided
|
||||
*/
|
||||
InvalidModuleType = 'Detected an unknown module type',
|
||||
/**
|
||||
* Attempted to lookup module in command module store. Nothing was found!
|
||||
*/
|
||||
UndefinedModule = `A module could not be detected`,
|
||||
/**
|
||||
* Attempted to lookup module in command module store. Nothing was found!
|
||||
*/
|
||||
MismatchModule = `A module type mismatched with event emitted!`,
|
||||
/**
|
||||
* Unsupported interaction at this moment.
|
||||
*/
|
||||
NotSupportedInteraction = `This interaction is not supported.`,
|
||||
/**
|
||||
* One plugin called `controller.stop()` (end command execution / loading)
|
||||
*/
|
||||
PluginFailure = `A plugin failed to call controller.next()`,
|
||||
/**
|
||||
* A crash that occurs when accessing an invalid property of Context
|
||||
*/
|
||||
MismatchEvent = `You cannot use message when an interaction fired or vice versa`,
|
||||
/**
|
||||
* Unsupported feature attempted to access at this time
|
||||
*/
|
||||
NotSupportedYet = `This feature is not supported yet`,
|
||||
/**
|
||||
* Required Dependency not found
|
||||
*/
|
||||
MissingRequired = `@sern/client is required but was not found`
|
||||
}
|
||||
@@ -1,38 +0,0 @@
|
||||
import type { SernEventsMapping } from '../../types/handler';
|
||||
import type {
|
||||
DiscordEmitterPlugin,
|
||||
DiscordEventPlugin,
|
||||
ExternalEmitterPlugin,
|
||||
ExternalEventPlugin,
|
||||
SernEmitterPlugin,
|
||||
SernEventPlugin,
|
||||
} from '../plugins/plugin';
|
||||
import type { Awaitable, ClientEvents } from 'discord.js';
|
||||
import type { EventType } from './enums';
|
||||
import type { Module } from '../../types/module';
|
||||
|
||||
|
||||
export interface SernEventCommand<T extends keyof SernEventsMapping = keyof SernEventsMapping> extends Module {
|
||||
name?: T;
|
||||
type: EventType.Sern;
|
||||
onEvent: SernEventPlugin[];
|
||||
plugins: SernEmitterPlugin[];
|
||||
execute(...args: SernEventsMapping[T]): Awaitable<unknown>;
|
||||
}
|
||||
|
||||
export interface DiscordEventCommand<T extends keyof ClientEvents = keyof ClientEvents> extends Module {
|
||||
name?: T;
|
||||
type: EventType.Discord;
|
||||
onEvent: DiscordEventPlugin[];
|
||||
plugins: DiscordEmitterPlugin[];
|
||||
execute(...args: ClientEvents[T]): Awaitable<unknown>;
|
||||
}
|
||||
|
||||
export interface ExternalEventCommand extends Module {
|
||||
name?: string
|
||||
emitter: string;
|
||||
type: EventType.External;
|
||||
onEvent: ExternalEventPlugin[];
|
||||
plugins: ExternalEmitterPlugin[];
|
||||
execute(...args: unknown[]): Awaitable<unknown>;
|
||||
}
|
||||
@@ -1,26 +0,0 @@
|
||||
import type { CommandModule } from '../../types/module';
|
||||
import { ApplicationCommandType, ComponentType } from 'discord.js';
|
||||
|
||||
/**
|
||||
* Storing all command modules
|
||||
* This dependency is usually injected into ModuleManager
|
||||
*/
|
||||
export class ModuleStore {
|
||||
readonly BothCommands = new Map<string, CommandModule>();
|
||||
readonly ApplicationCommands = {
|
||||
[ApplicationCommandType.User]: new Map<string, CommandModule>(),
|
||||
[ApplicationCommandType.Message]: new Map<string, CommandModule>(),
|
||||
[ApplicationCommandType.ChatInput]: new Map<string, CommandModule>(),
|
||||
};
|
||||
readonly ModalSubmit = new Map<string, CommandModule>();
|
||||
readonly TextCommands = new Map<string, CommandModule>();
|
||||
readonly InteractionHandlers = {
|
||||
[ComponentType.Button]: new Map<string, CommandModule>(),
|
||||
[ComponentType.StringSelect]: new Map<string, CommandModule>(),
|
||||
[ComponentType.ChannelSelect] : new Map<string, CommandModule>(),
|
||||
[ComponentType.MentionableSelect] : new Map<string, CommandModule>(),
|
||||
[ComponentType.RoleSelect] : new Map<string, CommandModule>(),
|
||||
[ComponentType.UserSelect] : new Map<string, CommandModule>(),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
import Context from './context';
|
||||
import type Wrapper from './wrapper';
|
||||
import { ModuleStore } from './moduleStore';
|
||||
|
||||
export * from './enums';
|
||||
export {
|
||||
Context,
|
||||
Wrapper,
|
||||
ModuleStore
|
||||
};
|
||||
@@ -1,15 +0,0 @@
|
||||
import type { Dependencies } from '../../types/handler';
|
||||
|
||||
/**
|
||||
* An object to be passed into Sern#init() function.
|
||||
* @typedef {object} Wrapper
|
||||
*/
|
||||
interface Wrapper {
|
||||
readonly defaultPrefix?: string;
|
||||
readonly commands: string;
|
||||
readonly events?: string;
|
||||
readonly containerConfig : {
|
||||
get: (...keys: (keyof Dependencies)[]) => unknown[];
|
||||
}
|
||||
}
|
||||
export default Wrapper;
|
||||
@@ -1,9 +0,0 @@
|
||||
import type { Awaitable } from 'discord.js';
|
||||
|
||||
export async function arrAsync<T>(promiseLike: Awaitable<T>[]): Promise<T[]> {
|
||||
const arr: T[] = [];
|
||||
for await (const el of promiseLike) {
|
||||
arr.push(el);
|
||||
}
|
||||
return arr;
|
||||
}
|
||||
@@ -1,42 +0,0 @@
|
||||
import * as Files from './readFile';
|
||||
import { basename } from 'path';
|
||||
import { Err, Ok, Result } from 'ts-results-es';
|
||||
import { Observable, of, switchMap } from 'rxjs';
|
||||
/**
|
||||
* A function that returns whatever value is provided.
|
||||
* Used for singleton in iti
|
||||
* @param value
|
||||
*/
|
||||
export const _const = <T>(value: T) => () => value;
|
||||
/**
|
||||
* A function that returns another function
|
||||
* Used for transient in iti
|
||||
* @param value
|
||||
*/
|
||||
export const transient = <T>( value : T) => () => _const(value);
|
||||
|
||||
export function nameOrFilename(modName: string | undefined, absPath: string) {
|
||||
return modName ?? Files.fmtFileName(basename(absPath));
|
||||
}
|
||||
|
||||
//function wrappers for empty ok / err
|
||||
export const ok = _const(Ok.EMPTY);
|
||||
export const err = _const(Err.EMPTY);
|
||||
|
||||
|
||||
export function partition<T, V>(arr: (T & V)[], condition: (e: (T & V)) => boolean) : [T[], V[]] {
|
||||
const t : T[] = [];
|
||||
const v : V[] = [];
|
||||
for(const el of arr) {
|
||||
if(condition(el)) {
|
||||
t.push(el as T);
|
||||
} else {
|
||||
v.push(el as V);
|
||||
}
|
||||
}
|
||||
return [ t, v ];
|
||||
}
|
||||
|
||||
export function reducePlugins(src: Observable<Result<void, void>[]>) : Observable<boolean> {
|
||||
return src.pipe(switchMap(s => of(s.every((a) => a.ok))));
|
||||
}
|
||||
@@ -1,15 +0,0 @@
|
||||
import type { Message } from 'discord.js';
|
||||
|
||||
/**
|
||||
* Removes the first character(s) _[depending on prefix length]_ of the message
|
||||
* @param msg
|
||||
* @param prefix The prefix to remove
|
||||
* @returns The message without the prefix
|
||||
* @example
|
||||
* message.content = '!ping';
|
||||
* console.log(fmt(message, '!'));
|
||||
* // [ 'ping' ]
|
||||
*/
|
||||
export function fmt(msg: Message, prefix: string): string[] {
|
||||
return msg.content.slice(prefix.length).trim().split(/\s+/g);
|
||||
}
|
||||
@@ -1,23 +0,0 @@
|
||||
import type { DiscordEventCommand, ExternalEventCommand, SernEventCommand } from '../structures/events';
|
||||
import { CommandModule, EventType } from '../..';
|
||||
import type { AnyModule, CommandModuleDefs, EventModule } from '../../types/module';
|
||||
|
||||
export function correctModuleType<T extends keyof CommandModuleDefs>(
|
||||
plug: AnyModule | undefined,
|
||||
type: T,
|
||||
): plug is CommandModuleDefs[T] {
|
||||
// Another way to check if type is equivalent,
|
||||
// It will check based on flag system instead
|
||||
return plug !== undefined && (plug.type & type) !== 0;
|
||||
}
|
||||
|
||||
|
||||
export function isDiscordEvent(el: EventModule | CommandModule): el is DiscordEventCommand {
|
||||
return el.type === EventType.Discord;
|
||||
}
|
||||
export function isSernEvent(el: EventModule | CommandModule): el is SernEventCommand {
|
||||
return el.type === EventType.Sern;
|
||||
}
|
||||
export function isExternalEvent(el: EventModule | CommandModule): el is ExternalEventCommand {
|
||||
return el.type === EventType.External && 'emitter' in el;
|
||||
}
|
||||
@@ -1,65 +0,0 @@
|
||||
import { readdirSync, statSync } from 'fs';
|
||||
import { join } from 'path';
|
||||
import { type Observable, from, concatAll } from 'rxjs';
|
||||
import { SernError } from '../structures/errors';
|
||||
import { type Result, Err, Ok } from 'ts-results-es';
|
||||
|
||||
|
||||
// Courtesy @Townsy45
|
||||
function readPath(dir: string, arrayOfFiles: string[] = []): string[] {
|
||||
try {
|
||||
const files = readdirSync(dir);
|
||||
for (const file of files) {
|
||||
if (statSync(dir + '/' + file).isDirectory()) readPath(dir + '/' + file, arrayOfFiles);
|
||||
else arrayOfFiles.push(join(dir, '/', file));
|
||||
}
|
||||
} catch (err) {
|
||||
throw err;
|
||||
}
|
||||
|
||||
return arrayOfFiles;
|
||||
}
|
||||
|
||||
export const fmtFileName = (n: string) => n.substring(0, n.length - 3);
|
||||
|
||||
/**
|
||||
*
|
||||
* @returns {Observable<{ mod: Module; absPath: string; }[]>} data from command files
|
||||
* @param commandDir
|
||||
*/
|
||||
|
||||
export function buildData<T>(commandDir: string): Observable<
|
||||
Result<
|
||||
{
|
||||
mod: T;
|
||||
absPath: string;
|
||||
},
|
||||
SernError
|
||||
>
|
||||
> {
|
||||
const commands = getCommands(commandDir);
|
||||
return from(
|
||||
Promise.all(
|
||||
commands.map(async absPath => {
|
||||
let mod: T | undefined;
|
||||
try {
|
||||
// eslint-disable-next-line @typescript-eslint/no-var-requires
|
||||
mod = require(absPath).default;
|
||||
} catch {
|
||||
mod = (await import(`file:///` + absPath)).default;
|
||||
}
|
||||
if (mod === undefined) {
|
||||
return Err(SernError.UndefinedModule);
|
||||
}
|
||||
try {
|
||||
mod = new (mod as unknown as new () => T)();
|
||||
} catch {}
|
||||
return Ok({ mod, absPath });
|
||||
}),
|
||||
),
|
||||
).pipe(concatAll());
|
||||
}
|
||||
|
||||
export function getCommands(dir: string): string[] {
|
||||
return readPath(join(process.cwd(), dir));
|
||||
}
|
||||
@@ -1,42 +0,0 @@
|
||||
import { ApplicationCommandOptionType, AutocompleteInteraction } from 'discord.js';
|
||||
import type { SernAutocompleteData, SernOptionsData } from '../../types/module';
|
||||
|
||||
export default function treeSearch(
|
||||
iAutocomplete: AutocompleteInteraction,
|
||||
options: SernOptionsData[] | undefined,
|
||||
): SernAutocompleteData | undefined {
|
||||
if (options === undefined) return undefined;
|
||||
const _options = options.slice(); // required to prevent direct mutation of options
|
||||
let autocompleteData: SernAutocompleteData | undefined;
|
||||
|
||||
while (_options.length > 0) {
|
||||
const cur = _options.pop()!;
|
||||
switch (cur.type) {
|
||||
case ApplicationCommandOptionType.Subcommand:
|
||||
{
|
||||
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 (cur.autocomplete) {
|
||||
const choice = iAutocomplete.options.getFocused(true);
|
||||
if (cur.name === choice.name && cur.autocomplete) {
|
||||
autocompleteData = cur;
|
||||
}
|
||||
}
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
return autocompleteData;
|
||||
}
|
||||
74
src/handlers/event-utils.ts
Normal file
74
src/handlers/event-utils.ts
Normal file
@@ -0,0 +1,74 @@
|
||||
import type { Emitter, Logging } from '../core/interfaces';
|
||||
import { SernError } from '../core/structures/enums'
|
||||
import { Ok, wrapAsync} from '../core/structures/result';
|
||||
import type { Module } from '../types/core-modules';
|
||||
import { inspect } from 'node:util'
|
||||
import { resultPayload } from '../core/functions'
|
||||
import merge from 'deepmerge'
|
||||
|
||||
|
||||
interface ExecutePayload {
|
||||
module: Module;
|
||||
args: unknown[];
|
||||
[key: string]: unknown
|
||||
}
|
||||
|
||||
|
||||
function isObject(item: unknown) {
|
||||
return (item && typeof item === 'object' && !Array.isArray(item));
|
||||
}
|
||||
|
||||
//_module is frozen, preventing from mutations
|
||||
export async function callInitPlugins(_module: Module, deps: Dependencies, emit?: boolean) {
|
||||
let module = _module;
|
||||
const emitter = deps['@sern/emitter'];
|
||||
for(const plugin of module.plugins ?? []) {
|
||||
const result = await plugin.execute({ module, absPath: module.meta.absPath, deps });
|
||||
if (!result) throw Error("Plugin did not return anything. " + inspect(plugin, false, Infinity, true));
|
||||
if(!result.ok) {
|
||||
if(emit) {
|
||||
emitter?.emit('module.register',
|
||||
resultPayload('failure', module, result.error ?? SernError.PluginFailure));
|
||||
}
|
||||
throw Error((result.error ?? SernError.PluginFailure) +
|
||||
'on module ' + module.name + " " + module.meta.absPath);
|
||||
}
|
||||
}
|
||||
return module
|
||||
}
|
||||
|
||||
export function executeModule(emitter: Emitter, logger: Logging|undefined, { module, args } : ExecutePayload) {
|
||||
|
||||
const moduleCalled = wrapAsync(async () => {
|
||||
return module.execute(...args);
|
||||
})
|
||||
moduleCalled
|
||||
.then((res) => {
|
||||
if(res.ok) {
|
||||
emitter.emit('module.activate', resultPayload('success', module))
|
||||
} else {
|
||||
if(!emitter.emit('error', resultPayload('failure', module, res.error))) {
|
||||
// node crashes here.
|
||||
logger?.error({ 'message': res.error })
|
||||
}
|
||||
}
|
||||
})
|
||||
.catch(err => {
|
||||
throw err
|
||||
})
|
||||
};
|
||||
|
||||
|
||||
export async function callPlugins({ args, module }: ExecutePayload) {
|
||||
let state = {};
|
||||
for(const plugin of module.onEvent??[]) {
|
||||
const result = await plugin.execute(...args);
|
||||
if(!result.ok) {
|
||||
return result;
|
||||
}
|
||||
if(isObject(result.value)) {
|
||||
state = merge(state, result.value!);
|
||||
}
|
||||
}
|
||||
return Ok(state);
|
||||
}
|
||||
74
src/handlers/interaction.ts
Normal file
74
src/handlers/interaction.ts
Normal file
@@ -0,0 +1,74 @@
|
||||
import type { Module, SernAutocompleteData } from '../types/core-modules'
|
||||
import { callPlugins, executeModule } from './event-utils';
|
||||
import { SernError } from '../core/structures/enums'
|
||||
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';
|
||||
|
||||
|
||||
|
||||
export function interactionHandler(deps: UnpackedDependencies, defaultPrefix?: string) {
|
||||
//i wish javascript had clojure destructuring
|
||||
const { '@sern/client': client,
|
||||
'@sern/modules': moduleManager,
|
||||
'@sern/logger': log,
|
||||
'@sern/emitter': reporter } = deps
|
||||
|
||||
client.on('interactionCreate', async (event) => {
|
||||
|
||||
//returns array of possible ids
|
||||
const possibleIds = Id.reconstruct(event);
|
||||
|
||||
let modules = possibleIds
|
||||
.map(({ id, params }) => ({ module: moduleManager.get(id)!, params }))
|
||||
.filter(({ module }) => module !== undefined);
|
||||
|
||||
if(modules.length == 0) {
|
||||
return;
|
||||
}
|
||||
const { module, params } = modules.at(0)!;
|
||||
let payload;
|
||||
// handles autocomplete
|
||||
if(isAutocomplete(event)) {
|
||||
const lookupTable = module.locals['@sern/lookup-table'] as Map<string, SernAutocompleteData>
|
||||
const subCommandGroup = event.options.getSubcommandGroup(false) ?? "",
|
||||
subCommand = event.options.getSubcommand(false) ?? "",
|
||||
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)) {
|
||||
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 {
|
||||
throw Error("Unknown interaction while handling in interactionCreate event " + event)
|
||||
}
|
||||
const result = await callPlugins(payload)
|
||||
if(!result.ok) {
|
||||
reporter.emit('module.activate', resultPayload('failure', module, result.error ?? SernError.PluginFailure))
|
||||
return
|
||||
}
|
||||
if(payload.args.length !== 2) {
|
||||
throw Error ('Invalid payload')
|
||||
}
|
||||
//@ts-ignore assigning final state from plugin
|
||||
payload.args[1].state = result.value
|
||||
|
||||
// note: do not await this. will be blocking if long task (ie waiting for modal input)
|
||||
executeModule(reporter, log, payload);
|
||||
});
|
||||
}
|
||||
54
src/handlers/message.ts
Normal file
54
src/handlers/message.ts
Normal file
@@ -0,0 +1,54 @@
|
||||
import type { Message } from 'discord.js';
|
||||
import { callPlugins, executeModule } from './event-utils';
|
||||
import { SernError } from '../core/structures/enums'
|
||||
import { createSDT, fmt, resultPayload } from '../core/functions'
|
||||
import type { UnpackedDependencies } from '../types/utility';
|
||||
import type { Module } from '../types/core-modules';
|
||||
import { Context } from '../core/structures/context';
|
||||
|
||||
/**
|
||||
* Ignores messages from any person / bot except itself
|
||||
* @param prefix
|
||||
*/
|
||||
function isBotOrNoPrefix(msg: Message, prefix: string) {
|
||||
return msg.author.bot || !hasPrefix(prefix, msg.content);
|
||||
}
|
||||
|
||||
function hasPrefix(prefix: string, content: string) {
|
||||
const prefixInContent = content.slice(0, prefix.length);
|
||||
return prefixInContent.localeCompare(prefix, undefined, { sensitivity: 'accent' }) === 0;
|
||||
}
|
||||
|
||||
export function messageHandler (deps: UnpackedDependencies, defaultPrefix?: string) {
|
||||
const {"@sern/emitter": emitter,
|
||||
'@sern/logger': log,
|
||||
'@sern/modules': mg,
|
||||
'@sern/client': client} = deps
|
||||
|
||||
if (!defaultPrefix) {
|
||||
log?.debug({ message: 'No prefix found. message handler shutting down' });
|
||||
return;
|
||||
}
|
||||
client.on('messageCreate', async message => {
|
||||
if(isBotOrNoPrefix(message, defaultPrefix)) {
|
||||
return
|
||||
}
|
||||
const [prefix] = fmt(message.content, defaultPrefix);
|
||||
let module = mg.get(`${prefix}_T`) ?? mg.get(`${prefix}_B`) as Module;
|
||||
if(!module) {
|
||||
log?.warning({ message: 'Possibly undefined behavior: could not find a static id to resolve' });
|
||||
}
|
||||
const payload = { module, args: [Context.wrap(message, defaultPrefix), createSDT(module, deps, undefined)] }
|
||||
const result = await callPlugins(payload)
|
||||
if (!result.ok) {
|
||||
emitter.emit('module.activate', resultPayload('failure', module, result.error ?? SernError.PluginFailure))
|
||||
return
|
||||
}
|
||||
|
||||
//@ts-ignore
|
||||
payload.args[1].state = result.value
|
||||
|
||||
executeModule(emitter, log, payload)
|
||||
})
|
||||
|
||||
}
|
||||
99
src/handlers/presence.ts
Normal file
99
src/handlers/presence.ts
Normal file
@@ -0,0 +1,99 @@
|
||||
import { Presence } from "../core/presences";
|
||||
import { Services } from "../core/ioc";
|
||||
import * as Files from "../core/module-loading";
|
||||
type SetPresence = (conf: Presence.Result) => Promise<unknown>
|
||||
|
||||
const parseConfig = async (conf: Promise<Presence.Result>, setPresence: SetPresence) => {
|
||||
const result = await conf;
|
||||
|
||||
if ('repeat' in result) {
|
||||
const { onRepeat, repeat } = result;
|
||||
// Validate configuration
|
||||
if (repeat === undefined) {
|
||||
throw new Error("repeat option is undefined");
|
||||
}
|
||||
if (onRepeat === undefined) {
|
||||
throw new Error("onRepeat callback is undefined, but repeat exists");
|
||||
}
|
||||
// Initial state
|
||||
let currentState = result;
|
||||
const processState = async (state: typeof currentState) => {
|
||||
try {
|
||||
const result = onRepeat(state);
|
||||
// If it's a promise, await it, otherwise use the value directly
|
||||
return result instanceof Promise ? await result : result;
|
||||
} catch (error) {
|
||||
// TODO process error
|
||||
//console.error(error);
|
||||
return state; // Return previous state on error
|
||||
}
|
||||
};
|
||||
// Handle numeric interval
|
||||
if (typeof repeat === 'number') {
|
||||
// Return a promise that never resolves (or resolves on cleanup)
|
||||
return new Promise((resolve) => {
|
||||
// Immediately return initial state
|
||||
processState(currentState);
|
||||
|
||||
// Set up interval
|
||||
let isProcessing = false;
|
||||
const intervalId = setInterval(() => {
|
||||
// Skip if previous operation is still running
|
||||
if (isProcessing) return;
|
||||
isProcessing = true;
|
||||
|
||||
processState(currentState)
|
||||
.then(newState => {
|
||||
currentState = newState;
|
||||
return setPresence(currentState)
|
||||
})
|
||||
.catch(console.error)
|
||||
.finally(() => {
|
||||
isProcessing = false;
|
||||
});
|
||||
}, repeat);
|
||||
|
||||
// Optional: Return cleanup function
|
||||
return () => clearInterval(intervalId);
|
||||
});
|
||||
}
|
||||
// Handle event-based repeat
|
||||
else {
|
||||
const handler = async () => {
|
||||
currentState = await onRepeat(currentState);
|
||||
await setPresence(currentState);
|
||||
};
|
||||
let has_registered = false;
|
||||
return new Promise((resolve) => {
|
||||
const [target, eventName] = repeat;
|
||||
|
||||
// Immediately return initial state
|
||||
processState(currentState);
|
||||
|
||||
// Set up event listener
|
||||
if(!has_registered) {
|
||||
target.addListener(eventName, handler);
|
||||
has_registered=true;
|
||||
}
|
||||
// Optional: Return cleanup function
|
||||
return () => target.removeListener(eventName, handler);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// No repeat configuration, just return the result
|
||||
return setPresence(result);
|
||||
};
|
||||
|
||||
export const presenceHandler = async (path: string, setPresence: SetPresence) => {
|
||||
const presence = await
|
||||
Files.importModule<Presence.Config<(keyof Dependencies)[]>>(path)
|
||||
.then(({ module }) => {
|
||||
//fetch services with the order preserved, passing it to the execute fn
|
||||
const fetchedServices = Services(...module.inject ?? []);
|
||||
return async () => module.execute(...fetchedServices);
|
||||
})
|
||||
|
||||
return parseConfig(presence(), setPresence);
|
||||
|
||||
}
|
||||
58
src/handlers/ready.ts
Normal file
58
src/handlers/ready.ts
Normal file
@@ -0,0 +1,58 @@
|
||||
import * as Files from "../core/module-loading";
|
||||
import { once } from "node:events";
|
||||
import { createLookupTable, resultPayload } from "../core/functions";
|
||||
import { CommandType } from "../core/structures/enums";
|
||||
import { Module, SernOptionsData } from "../types/core-modules";
|
||||
import type { UnpackedDependencies, Wrapper } from "../types/utility";
|
||||
import { callInitPlugins } from "./event-utils";
|
||||
import { SernAutocompleteData } from "..";
|
||||
import { Events } from "discord.js";
|
||||
|
||||
export default async function (
|
||||
dirs: string | string[],
|
||||
deps: UnpackedDependencies,
|
||||
) {
|
||||
const {
|
||||
"@sern/client": client,
|
||||
"@sern/logger": log,
|
||||
"@sern/emitter": sEmitter,
|
||||
"@sern/modules": commands,
|
||||
} = deps;
|
||||
log?.info({ message: "Waiting on discord client to be ready..." });
|
||||
await once(client, Events.ClientReady);
|
||||
log?.info({ message: "Client signaled ready, registering modules" });
|
||||
|
||||
// https://observablehq.com/@ehouais/multiple-promises-as-an-async-generator
|
||||
// possibly optimize to concurrently import modules
|
||||
|
||||
const directories = Array.isArray(dirs) ? dirs : [dirs];
|
||||
|
||||
for (const dir of directories) {
|
||||
for await (const path of Files.readRecursive(dir)) {
|
||||
const { module } = await Files.importModule<Module>(path);
|
||||
const validType =
|
||||
module.type >= CommandType.Text &&
|
||||
module.type <= CommandType.ChannelSelect;
|
||||
if (!validType) {
|
||||
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));
|
||||
}
|
||||
}
|
||||
sEmitter.emit("modulesLoaded");
|
||||
}
|
||||
21
src/handlers/tasks.ts
Normal file
21
src/handlers/tasks.ts
Normal file
@@ -0,0 +1,21 @@
|
||||
import * as Files from '../core/module-loading'
|
||||
import { UnpackedDependencies, Wrapper } from "../types/utility";
|
||||
import type { ScheduledTask } from "../types/core-modules";
|
||||
import { relative } from "path";
|
||||
import { fileURLToPath } from "url";
|
||||
|
||||
export const registerTasks = async (tasksDirs: string | string[], deps: UnpackedDependencies) => {
|
||||
const taskManager = deps['@sern/scheduler']
|
||||
|
||||
const directories = Array.isArray(tasksDirs) ? tasksDirs : [tasksDirs];
|
||||
|
||||
for (const dir of directories) {
|
||||
for await (const path of Files.readRecursive(dir)) {
|
||||
let { module } = await Files.importModule<ScheduledTask>(path);
|
||||
//module.name is assigned by Files.importModule<>
|
||||
// the id created for the task is unique
|
||||
const uuid = module.name+"/"+relative(dir,fileURLToPath(path))
|
||||
taskManager.schedule(uuid, module, deps)
|
||||
}
|
||||
}
|
||||
}
|
||||
62
src/handlers/user-defined-events.ts
Normal file
62
src/handlers/user-defined-events.ts
Normal file
@@ -0,0 +1,62 @@
|
||||
import { EventType, SernError } from '../core/structures/enums';
|
||||
import { callInitPlugins } from './event-utils'
|
||||
import { EventModule } from '../types/core-modules';
|
||||
import * as Files from '../core/module-loading'
|
||||
import type { UnpackedDependencies } from '../types/utility';
|
||||
import type { Emitter } from '../core/interfaces';
|
||||
import { inspect } from 'util'
|
||||
import { resultPayload } from '../core/functions';
|
||||
import type { Wrapper } from '../'
|
||||
|
||||
export default async function(deps: UnpackedDependencies, wrapper: Wrapper) {
|
||||
const eventModules: EventModule[] = [];
|
||||
const eventDirs = Array.isArray(wrapper.events!) ? wrapper.events! : [wrapper.events!];
|
||||
|
||||
for (const dir of eventDirs) {
|
||||
for await (const path of Files.readRecursive(dir)) {
|
||||
let { module } = await Files.importModule<EventModule>(path);
|
||||
await callInitPlugins(module, deps)
|
||||
eventModules.push(module);
|
||||
}
|
||||
}
|
||||
|
||||
const logger = deps['@sern/logger'], report = deps['@sern/emitter'];
|
||||
for (const module of eventModules) {
|
||||
let source: Emitter;
|
||||
|
||||
switch (module.type) {
|
||||
case EventType.Sern:
|
||||
source=deps['@sern/emitter'];
|
||||
break
|
||||
case EventType.Discord:
|
||||
source=deps['@sern/client'];
|
||||
break
|
||||
case EventType.External:
|
||||
source=deps[module.emitter] as Emitter;
|
||||
break
|
||||
default: throw Error(SernError.InvalidModuleType + ' while creating event handler');
|
||||
}
|
||||
if(!source && typeof source !== 'object') {
|
||||
throw Error(`${source} cannot be constructed into an event listener`)
|
||||
}
|
||||
|
||||
if(!('addListener' in source && 'removeListener' in source)) {
|
||||
throw Error('source must implement Emitter')
|
||||
}
|
||||
const execute = async (...args: any[]) => {
|
||||
try {
|
||||
if(args) {
|
||||
if('once' in module) { source.removeListener(String(module.name!), execute); }
|
||||
await Reflect.apply(module.execute, null, args);
|
||||
}
|
||||
} catch(e) {
|
||||
const err = e instanceof Error ? e : Error(inspect(e, { colors: true }));
|
||||
if(!report.emit('error', resultPayload('failure', module, err))) {
|
||||
logger?.error({ message: inspect(err) });
|
||||
}
|
||||
}
|
||||
}
|
||||
source.addListener(String(module.name!), execute)
|
||||
}
|
||||
}
|
||||
|
||||
66
src/index.ts
66
src/index.ts
@@ -1,11 +1,55 @@
|
||||
import SernEmitter from './handler/sernEmitter';
|
||||
export { eventModule, commandModule, EventExecutable, CommandExecutable } from './handler/sern';
|
||||
export * as Sern from './handler/sern';
|
||||
export * from './types/handler';
|
||||
export * from './types/module';
|
||||
export * from './handler/structures/structxports';
|
||||
export * from './handler/plugins/plugin';
|
||||
export * from './handler/contracts/index';
|
||||
export { SernEmitter };
|
||||
export { _const as single, transient as many } from './handler/utilities/functions';
|
||||
export { useContainerRaw } from './handler/dependencies/provider';
|
||||
export * as Sern from './sern';
|
||||
|
||||
export type {
|
||||
Module,
|
||||
CommandModule,
|
||||
EventModule,
|
||||
BothCommand,
|
||||
ContextMenuMsg,
|
||||
ContextMenuUser,
|
||||
SlashCommand,
|
||||
TextCommand,
|
||||
ButtonCommand,
|
||||
StringSelectCommand,
|
||||
MentionableSelectCommand,
|
||||
UserSelectCommand,
|
||||
ChannelSelectCommand,
|
||||
RoleSelectCommand,
|
||||
ModalSubmitCommand,
|
||||
DiscordEventCommand,
|
||||
SernEventCommand,
|
||||
ExternalEventCommand,
|
||||
CommandModuleDefs,
|
||||
EventModuleDefs,
|
||||
SernAutocompleteData,
|
||||
SernOptionsData,
|
||||
SernSubCommandData,
|
||||
SernSubCommandGroupData,
|
||||
SDT,
|
||||
ScheduledTask
|
||||
} from './types/core-modules';
|
||||
|
||||
export type {
|
||||
PluginResult,
|
||||
InitPlugin,
|
||||
ControlPlugin,
|
||||
Plugin,
|
||||
AnyPlugin,
|
||||
} from './types/core-plugin';
|
||||
|
||||
|
||||
export type { Payload, SernEventsMapping, Wrapper } from './types/utility';
|
||||
|
||||
export {
|
||||
commandModule,
|
||||
eventModule,
|
||||
discordEvent,
|
||||
scheduledTask
|
||||
} from './core/modules';
|
||||
|
||||
export * from './core/presences'
|
||||
export * from './core/interfaces'
|
||||
export * from './core/plugin';
|
||||
export { CommandType, PluginType, PayloadType, EventType } from './core/structures/enums';
|
||||
export { Context } from './core/structures/context';
|
||||
export { type CoreDependencies, makeDependencies, single, transient, Service, Services } from './core/ioc';
|
||||
|
||||
80
src/sern.ts
Normal file
80
src/sern.ts
Normal file
@@ -0,0 +1,80 @@
|
||||
//side effect: global container
|
||||
import { useContainerRaw } from '@sern/ioc/global';
|
||||
// set asynchronous capturing of errors
|
||||
import events from 'node:events'
|
||||
events.captureRejections = true;
|
||||
|
||||
import callsites from 'callsites';
|
||||
import * as Files from './core/module-loading';
|
||||
import eventsHandler from './handlers/user-defined-events';
|
||||
import ready from './handlers/ready';
|
||||
import { interactionHandler } from './handlers/interaction';
|
||||
import { messageHandler } from './handlers/message'
|
||||
import { presenceHandler } from './handlers/presence';
|
||||
import type { Payload, UnpackedDependencies, Wrapper } from './types/utility';
|
||||
import type { Presence} from './core/presences';
|
||||
import { registerTasks } from './handlers/tasks';
|
||||
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
* @param maybeWrapper Options to pass into sern.
|
||||
* Function to start the handler up
|
||||
* @example
|
||||
* ```ts title="src/index.ts"
|
||||
* Sern.init({
|
||||
* commands: 'dist/commands',
|
||||
* events: 'dist/events',
|
||||
* })
|
||||
* ```
|
||||
*/
|
||||
|
||||
export function init(maybeWrapper: Wrapper = { commands: "./dist/commands" }) {
|
||||
const startTime = performance.now();
|
||||
const deps = useContainerRaw().deps<UnpackedDependencies>();
|
||||
if (maybeWrapper.events !== undefined) {
|
||||
eventsHandler(deps, maybeWrapper)
|
||||
.then(() => {
|
||||
deps['@sern/logger']?.info({ message: "Events registered" });
|
||||
});
|
||||
} else {
|
||||
deps['@sern/logger']?.info({ message: "No events registered" });
|
||||
}
|
||||
|
||||
// autohandle errors that occur in modules.
|
||||
// convenient for rapid iteration
|
||||
if(maybeWrapper.handleModuleErrors) {
|
||||
if(!deps['@sern/logger']) {
|
||||
throw Error('A logger is required to handleModuleErrors.\n A default logger is already supplied!');
|
||||
}
|
||||
deps['@sern/logger']?.info({ 'message': 'handleModuleErrors enabled' })
|
||||
deps['@sern/emitter'].addListener('error', (payload: Payload) => {
|
||||
if(payload.type === 'failure') {
|
||||
deps['@sern/logger']?.error({ message: payload.reason })
|
||||
} else {
|
||||
deps['@sern/logger']?.warning({ message: "error event should only have payloads of 'failure'" });
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
const initCallsite = callsites()[1].getFileName();
|
||||
const presencePath = Files.shouldHandle(initCallsite!, "presence");
|
||||
//Ready event: load all modules and when finished, time should be taken and logged
|
||||
ready(maybeWrapper.commands, deps)
|
||||
.then(() => {
|
||||
const time = ((performance.now() - startTime) / 1000).toFixed(2);
|
||||
deps['@sern/logger']?.info({ message: `sern: registered in ${time} s` });
|
||||
if(presencePath.exists) {
|
||||
const setPresence = async (p: Presence.Result) => {
|
||||
return deps['@sern/client'].user?.setPresence(p);
|
||||
}
|
||||
presenceHandler(presencePath.path, setPresence);
|
||||
}
|
||||
if(maybeWrapper.tasks) {
|
||||
registerTasks(maybeWrapper.tasks, deps);
|
||||
}
|
||||
})
|
||||
.catch(err => { throw err });
|
||||
interactionHandler(deps, maybeWrapper.defaultPrefix);
|
||||
messageHandler(deps, maybeWrapper.defaultPrefix)
|
||||
}
|
||||
461
src/types/core-modules.ts
Normal file
461
src/types/core-modules.ts
Normal file
@@ -0,0 +1,461 @@
|
||||
import type {
|
||||
APIApplicationCommandBasicOption,
|
||||
APIApplicationCommandOptionBase,
|
||||
ApplicationCommandOptionType,
|
||||
BaseApplicationCommandOptionsData,
|
||||
AutocompleteInteraction,
|
||||
ButtonInteraction,
|
||||
ChannelSelectMenuInteraction,
|
||||
ClientEvents,
|
||||
MentionableSelectMenuInteraction,
|
||||
MessageContextMenuCommandInteraction,
|
||||
ModalSubmitInteraction,
|
||||
RoleSelectMenuInteraction,
|
||||
StringSelectMenuInteraction,
|
||||
UserContextMenuCommandInteraction,
|
||||
UserSelectMenuInteraction,
|
||||
ChatInputCommandInteraction,
|
||||
} from 'discord.js';
|
||||
import type { CommandType, EventType } from '../core/structures/enums';
|
||||
import { Context } from '../core/structures/context'
|
||||
import { ControlPlugin, InitPlugin, Plugin } from './core-plugin';
|
||||
import { Awaitable, SernEventsMapping, UnpackedDependencies, Dictionary } from './utility';
|
||||
|
||||
/**
|
||||
* SDT (State, Dependencies, Type) interface represents the core data structure
|
||||
* passed through the plugin pipeline to command modules.
|
||||
*
|
||||
* @interface SDT
|
||||
* @template TState - Type parameter for the state object's structure
|
||||
* @template TDeps - Type parameter for dependencies interface
|
||||
*
|
||||
* @property {Record<string, unknown>} state - Accumulated state data passed between plugins
|
||||
* @property {TDeps} deps - Instance of application dependencies
|
||||
* @property {CommandType} type - Command type identifier
|
||||
* @property {string} [params] - Optional parameters passed to the command
|
||||
*
|
||||
* @example
|
||||
* // Example of a plugin using SDT
|
||||
* const loggingPlugin = CommandControlPlugin((ctx, sdt: SDT) => {
|
||||
* console.log(`User ${ctx.user.id} executed command`);
|
||||
* return controller.next({ 'logging/timestamp': Date.now() });
|
||||
* });
|
||||
*
|
||||
* @example
|
||||
* // Example of state accumulation through multiple plugins
|
||||
* const plugin1 = CommandControlPlugin((ctx, sdt: SDT) => {
|
||||
* return controller.next({ 'plugin1/data': 'value1' });
|
||||
* });
|
||||
*
|
||||
* const plugin2 = CommandControlPlugin((ctx, sdt: SDT) => {
|
||||
* // Access previous state
|
||||
* const prevData = sdt.state['plugin1/data'];
|
||||
* return controller.next({ 'plugin2/data': 'value2' });
|
||||
* });
|
||||
*
|
||||
* @remarks
|
||||
* - State is immutable and accumulated through the plugin chain
|
||||
* - Keys in state should be namespaced to avoid collisions
|
||||
* - Dependencies are injected and available throughout the pipeline
|
||||
* - Type information helps plugins make type-safe decisions
|
||||
*
|
||||
* @see {@link CommandControlPlugin} for plugin implementation
|
||||
* @see {@link CommandType} for available command types
|
||||
* @see {@link Dependencies} for [dependency injection](https://sern.dev/v4/reference/dependencies/) interface
|
||||
*/
|
||||
export type SDT = {
|
||||
/**
|
||||
* Accumulated state passed between plugins in the pipeline.
|
||||
* Each plugin can add to or modify this state using controller.next().
|
||||
*
|
||||
* @type {Record<string, unknown>}
|
||||
* @example
|
||||
* // Good: Namespaced state key
|
||||
* { 'myPlugin/userData': { id: '123', name: 'User' } }
|
||||
*
|
||||
* // Avoid: Non-namespaced keys that might collide
|
||||
* { userData: { id: '123' } }
|
||||
*/
|
||||
state: Record<string, unknown>;
|
||||
|
||||
/**
|
||||
* Application dependencies available to plugins and command modules.
|
||||
* Typically includes services, configurations, and utilities.
|
||||
*
|
||||
* @type {Dependencies}
|
||||
*/
|
||||
deps: Dependencies;
|
||||
|
||||
/**
|
||||
* Identifies the type of command being processed.
|
||||
* Used by plugins to apply type-specific logic.
|
||||
*
|
||||
* @type {CommandType}
|
||||
*/
|
||||
type: CommandType;
|
||||
|
||||
/**
|
||||
* Optional parameters passed to the command.
|
||||
* May contain additional configuration or runtime data.
|
||||
*
|
||||
* @type {string}
|
||||
* @optional
|
||||
*/
|
||||
params?: string;
|
||||
|
||||
/**
|
||||
* A copy of the current module that the plugin is running in.
|
||||
*/
|
||||
module: { name: string;
|
||||
description: string;
|
||||
meta: Dictionary;
|
||||
locals: Dictionary; }
|
||||
};
|
||||
|
||||
export type Processed<T> = T & { name: string; description: string };
|
||||
|
||||
|
||||
/**
|
||||
* @since 1.0.0
|
||||
*/
|
||||
export interface Module {
|
||||
type: CommandType | EventType;
|
||||
name?: string;
|
||||
onEvent: ControlPlugin[];
|
||||
plugins: InitPlugin[];
|
||||
description?: string;
|
||||
meta: {
|
||||
id: string;
|
||||
absPath: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Custom data storage object for module-specific information.
|
||||
* Plugins and module code can use this to store and retrieve metadata,
|
||||
* configuration, or any other module-specific information.
|
||||
*
|
||||
* @type {Dictionary}
|
||||
* @description A key-value store that allows plugins and module code to persist
|
||||
* data at the module level. This is especially useful for InitPlugins that need
|
||||
* to attach metadata or configuration to modules.
|
||||
*
|
||||
* @example
|
||||
* // In a plugin
|
||||
* module.locals.registrationDate = Date.now();
|
||||
* module.locals.version = "1.0.0";
|
||||
* module.locals.permissions = ["ADMIN", "MODERATE"];
|
||||
*
|
||||
* @example
|
||||
* // In module execution
|
||||
* console.log(`Command registered on: ${new Date(module.locals.registrationDate)}`);
|
||||
*
|
||||
* @example
|
||||
* // Storing localization data
|
||||
* module.locals.translations = {
|
||||
* en: "Hello",
|
||||
* es: "Hola",
|
||||
* fr: "Bonjour"
|
||||
* };
|
||||
*
|
||||
* @example
|
||||
* // Storing command metadata
|
||||
* module.locals.metadata = {
|
||||
* category: "admin",
|
||||
* cooldown: 5000,
|
||||
* requiresPermissions: true
|
||||
* };
|
||||
*
|
||||
* @remarks
|
||||
* - The locals object is initialized as an empty object ({}) by default
|
||||
* - Keys should be namespaced to avoid collisions between plugins
|
||||
* - Values can be of any type
|
||||
* - Data persists for the lifetime of the module
|
||||
* - Commonly used by InitPlugins during module initialization
|
||||
*
|
||||
* @best-practices
|
||||
* 1. Namespace your keys to avoid conflicts:
|
||||
* ```typescript
|
||||
* module.locals['myPlugin:data'] = value;
|
||||
* ```
|
||||
*
|
||||
* 2. Document the data structure you're storing:
|
||||
* ```typescript
|
||||
* interface MyPluginData {
|
||||
* version: string;
|
||||
* timestamp: number;
|
||||
* }
|
||||
* module.locals['myPlugin:data'] = {
|
||||
* version: '1.0.0',
|
||||
* timestamp: Date.now()
|
||||
* } as MyPluginData;
|
||||
* ```
|
||||
*
|
||||
* 3. Use type-safe accessors when possible:
|
||||
* ```typescript
|
||||
* const getPluginData = (module: Module): MyPluginData =>
|
||||
* module.locals['myPlugin:data'];
|
||||
* ```
|
||||
*/
|
||||
locals: Dictionary;
|
||||
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;
|
||||
type: EventType.External;
|
||||
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
|
||||
| BothCommand
|
||||
| ContextMenuUser
|
||||
| ContextMenuMsg
|
||||
| ButtonCommand
|
||||
| StringSelectCommand
|
||||
| MentionableSelectCommand
|
||||
| UserSelectCommand
|
||||
| ChannelSelectCommand
|
||||
| RoleSelectCommand
|
||||
| ModalSubmitCommand;
|
||||
|
||||
//https://stackoverflow.com/questions/64092736/alternative-to-switch-statement-for-typescript-discriminated-union
|
||||
// Explicit Module Definitions for mapping
|
||||
export interface CommandModuleDefs {
|
||||
[CommandType.Text]: TextCommand;
|
||||
[CommandType.Slash]: SlashCommand;
|
||||
[CommandType.Both]: BothCommand;
|
||||
[CommandType.CtxMsg]: ContextMenuMsg;
|
||||
[CommandType.CtxUser]: ContextMenuUser;
|
||||
[CommandType.Button]: ButtonCommand;
|
||||
[CommandType.StringSelect]: StringSelectCommand;
|
||||
[CommandType.RoleSelect]: RoleSelectCommand;
|
||||
[CommandType.ChannelSelect]: ChannelSelectCommand;
|
||||
[CommandType.MentionableSelect]: MentionableSelectCommand;
|
||||
[CommandType.UserSelect]: UserSelectCommand;
|
||||
[CommandType.Modal]: ModalSubmitCommand;
|
||||
}
|
||||
|
||||
export interface EventModuleDefs<T extends keyof ClientEvents = keyof ClientEvents> {
|
||||
[EventType.Sern]: SernEventCommand;
|
||||
[EventType.Discord]: DiscordEventCommand<T>;
|
||||
[EventType.External]: ExternalEventCommand;
|
||||
}
|
||||
|
||||
export interface SernAutocompleteData
|
||||
extends Omit<BaseApplicationCommandOptionsData, 'autocomplete'> {
|
||||
autocomplete: true;
|
||||
type:
|
||||
| ApplicationCommandOptionType.String
|
||||
| ApplicationCommandOptionType.Number
|
||||
| ApplicationCommandOptionType.Integer;
|
||||
command: AutocompleteCommand;
|
||||
}
|
||||
|
||||
type CommandModuleNoPlugins = {
|
||||
[T in CommandType]: Omit<CommandModuleDefs[T], 'plugins' | 'onEvent' | 'meta' | 'locals'>;
|
||||
};
|
||||
type EventModulesNoPlugins<K extends keyof ClientEvents = keyof ClientEvents> = {
|
||||
[T in EventType]: Omit<EventModuleDefs<K>[T], 'plugins' | 'onEvent' | 'meta' | 'locals'> ;
|
||||
};
|
||||
|
||||
export type InputEvent<K extends keyof ClientEvents = keyof ClientEvents> = {
|
||||
[T in EventType]: EventModulesNoPlugins<K>[T] & {
|
||||
once?: boolean;
|
||||
plugins?: InitPlugin[]
|
||||
};
|
||||
}[EventType];
|
||||
|
||||
export type InputCommand = {
|
||||
[T in CommandType]: CommandModuleNoPlugins[T] & {
|
||||
plugins?: Plugin[];
|
||||
};
|
||||
}[CommandType];
|
||||
|
||||
/**
|
||||
* @see @link {https://sern.dev/v4/reference/autocomplete/}
|
||||
* Type that replaces autocomplete with {@link SernAutocompleteData}
|
||||
*/
|
||||
export type SernOptionsData =
|
||||
| SernSubCommandData
|
||||
| SernSubCommandGroupData
|
||||
| APIApplicationCommandBasicOption
|
||||
| SernAutocompleteData;
|
||||
|
||||
export interface SernSubCommandData
|
||||
extends APIApplicationCommandOptionBase<ApplicationCommandOptionType.Subcommand> {
|
||||
type: ApplicationCommandOptionType.Subcommand;
|
||||
options?: SernOptionsData[];
|
||||
}
|
||||
|
||||
export interface SernSubCommandGroupData extends BaseApplicationCommandOptionsData {
|
||||
type: ApplicationCommandOptionType.SubcommandGroup;
|
||||
options?: SernSubCommandData[];
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 4.0.0
|
||||
*/
|
||||
export interface ScheduledTaskContext {
|
||||
|
||||
/**
|
||||
* the uuid of the current task being run
|
||||
*/
|
||||
id: string;
|
||||
/**
|
||||
* the last time this task was executed. If this is the first time, it is null.
|
||||
*/
|
||||
lastTimeExecution: Date | null;
|
||||
/**
|
||||
* The next time this task will be executed.
|
||||
*/
|
||||
nextTimeExecution: Date | null;
|
||||
}
|
||||
|
||||
//name subject to change
|
||||
interface TaskAttrs {
|
||||
/**
|
||||
* An object of dependencies configured in `makeDependencies`
|
||||
*/
|
||||
deps: UnpackedDependencies
|
||||
}
|
||||
/**
|
||||
* @since 4.0.0
|
||||
*/
|
||||
export interface ScheduledTask {
|
||||
name?: string;
|
||||
trigger: string | Date;
|
||||
timezone?: string;
|
||||
execute(tasks: ScheduledTaskContext, sdt: TaskAttrs): Awaitable<void>
|
||||
}
|
||||
|
||||
|
||||
72
src/types/core-plugin.ts
Normal file
72
src/types/core-plugin.ts
Normal file
@@ -0,0 +1,72 @@
|
||||
/*
|
||||
* Plugins can be inserted on all commands and are emitted
|
||||
*
|
||||
* 1. On ready event, where all commands are loaded.
|
||||
* 2. On corresponding observable (when command triggers)
|
||||
*
|
||||
* The goal of plugins is to organize commands and
|
||||
* provide extensions to repetitive patterns
|
||||
* examples include refreshing modules,
|
||||
* categorizing commands, cool-downs, permissions, etc.
|
||||
* Plugins are reminiscent of middleware in express.
|
||||
*/
|
||||
|
||||
import type {
|
||||
Module,
|
||||
Processed,
|
||||
SDT,
|
||||
} from './core-modules';
|
||||
import type { Awaitable } from './utility';
|
||||
import type { CommandType, PluginType } from '../core/structures/enums'
|
||||
import type { Context } from '../core/structures/context'
|
||||
import type {
|
||||
ButtonInteraction,
|
||||
ChannelSelectMenuInteraction,
|
||||
ChatInputCommandInteraction,
|
||||
MentionableSelectMenuInteraction,
|
||||
MessageContextMenuCommandInteraction,
|
||||
ModalSubmitInteraction,
|
||||
RoleSelectMenuInteraction,
|
||||
StringSelectMenuInteraction,
|
||||
UserContextMenuCommandInteraction,
|
||||
UserSelectMenuInteraction,
|
||||
} from 'discord.js';
|
||||
import { Result } from '../core/structures/result';
|
||||
|
||||
export type PluginResult = Awaitable<Result<Record<string,unknown>|undefined, string|undefined>>;
|
||||
export interface InitArgs<T extends Processed<Module> = Processed<Module>> {
|
||||
module: T;
|
||||
absPath: string;
|
||||
deps: Dependencies
|
||||
}
|
||||
export interface Plugin<Args extends any[] = any[]> {
|
||||
type: PluginType;
|
||||
execute: (...args: Args) => PluginResult;
|
||||
}
|
||||
|
||||
export interface InitPlugin<Args extends any[] = any[]> extends Plugin<Args> {
|
||||
type: PluginType.Init;
|
||||
execute: (...args: Args) => PluginResult;
|
||||
}
|
||||
export interface ControlPlugin<Args extends any[] = any[]> extends Plugin<Args> {
|
||||
type: PluginType.Control;
|
||||
}
|
||||
|
||||
export type AnyPlugin = ControlPlugin | InitPlugin<[InitArgs<Processed<Module>>]>;
|
||||
|
||||
export type CommandArgs<I extends CommandType = CommandType> = CommandArgsMatrix[I]
|
||||
|
||||
interface CommandArgsMatrix {
|
||||
[CommandType.Text]: [Context & { get options(): string[]}, SDT];
|
||||
[CommandType.Slash]: [Context & { get options(): ChatInputCommandInteraction['options']}, SDT];
|
||||
[CommandType.Both]: [Context, SDT];
|
||||
[CommandType.CtxMsg]: [MessageContextMenuCommandInteraction, SDT];
|
||||
[CommandType.CtxUser]: [UserContextMenuCommandInteraction, SDT];
|
||||
[CommandType.Button]: [ButtonInteraction, SDT];
|
||||
[CommandType.StringSelect]: [StringSelectMenuInteraction, SDT];
|
||||
[CommandType.RoleSelect]: [RoleSelectMenuInteraction, SDT];
|
||||
[CommandType.ChannelSelect]: [ChannelSelectMenuInteraction, SDT];
|
||||
[CommandType.MentionableSelect]: [MentionableSelectMenuInteraction, SDT];
|
||||
[CommandType.UserSelect]: [UserSelectMenuInteraction, SDT];
|
||||
[CommandType.Modal]: [ModalSubmitInteraction, SDT];
|
||||
}
|
||||
27
src/types/dependencies.d.ts
vendored
Normal file
27
src/types/dependencies.d.ts
vendored
Normal file
@@ -0,0 +1,27 @@
|
||||
// This file serves an the interface for developers to augment the Dependencies interface
|
||||
// Developers will have to create a new file dependencies.d.ts in the root directory, augmenting
|
||||
// this type
|
||||
|
||||
/* eslint-disable @typescript-eslint/consistent-type-imports */
|
||||
|
||||
import { CoreDependencies } from '../core/ioc';
|
||||
|
||||
declare global {
|
||||
/**
|
||||
* discord.js client.
|
||||
* '@sern/client': Client
|
||||
* sern emitter listens to events that happen throughout
|
||||
* the handler. some include module.register, module.activate.
|
||||
* '@sern/emitter': Contracts.Emitter;
|
||||
* An error handler which is the final step before
|
||||
* the sern process actually crashes.
|
||||
'@sern/errors': Contracts.ErrorHandling;
|
||||
* Optional logger. Performs ... logging
|
||||
* '@sern/logger'?: Contracts.Logging;
|
||||
* Readonly module store. sern stores these
|
||||
* by module.meta.id -> Module
|
||||
* '@sern/modules': Map<string, Module>;
|
||||
*/
|
||||
interface Dependencies extends CoreDependencies {}
|
||||
}
|
||||
|
||||
@@ -1,57 +0,0 @@
|
||||
import type { CommandInteractionOptionResolver } from 'discord.js';
|
||||
import type { PayloadType } from '../handler/structures/enums';
|
||||
import type { InteractionReplyOptions, MessageReplyOptions } from 'discord.js';
|
||||
import type { EventEmitter } from 'events';
|
||||
import type { CommandModule, EventModule, AnyModule } from './module';
|
||||
import type { UnpackFunction } from 'iti';
|
||||
import type { ErrorHandling, Logging, ModuleManager } from '../handler/contracts';
|
||||
import type { ModuleStore } from '../handler/structures/moduleStore';
|
||||
import type SernEmitter from '../handler/sernEmitter';
|
||||
// Thanks to @kelsny
|
||||
export type ParseType<T> = {
|
||||
[K in keyof T]: T[K] extends unknown ? [k: K, args: T[K]] : never;
|
||||
}[keyof T];
|
||||
|
||||
export type Args = ParseType<{ text: string[]; slash: SlashOptions }>;
|
||||
|
||||
export type SlashOptions = Omit<CommandInteractionOptionResolver, 'getMessage' | 'getFocused'>;
|
||||
|
||||
/**
|
||||
* After modules are transformed, name and description are given default values if none
|
||||
* are provided to Module. This type represents that transformation
|
||||
*/
|
||||
export type DefinedCommandModule = CommandModule & { name: string; description: string };
|
||||
export type DefinedEventModule = EventModule & { name: string };
|
||||
export type AnyDefinedModule = DefinedCommandModule | DefinedEventModule
|
||||
export type Payload =
|
||||
| { type: PayloadType.Success; module: AnyModule }
|
||||
| { type: PayloadType.Failure; module?: AnyModule; reason: string | Error }
|
||||
| { type: PayloadType.Warning; reason: string};
|
||||
export type SernEventsMapping = {
|
||||
'module.register': [Payload];
|
||||
'module.activate': [Payload];
|
||||
'error': [Payload];
|
||||
'warning': [Payload];
|
||||
};
|
||||
export type LogPayload<T = unknown> = { message: T }
|
||||
export type Singleton<T> = () => T
|
||||
export type Transient<T> = () => () => T;
|
||||
|
||||
export interface Dependencies {
|
||||
'@sern/client': Singleton<EventEmitter>;
|
||||
'@sern/logger'?: Singleton<Logging>;
|
||||
'@sern/emitter': Singleton<SernEmitter>;
|
||||
'@sern/store' : Singleton<ModuleStore>;
|
||||
'@sern/modules' : Singleton<ModuleManager>;
|
||||
'@sern/errors': Singleton<ErrorHandling>;
|
||||
}
|
||||
|
||||
export type ReplyOptions = string | Omit<InteractionReplyOptions, 'fetchReply'> | MessageReplyOptions;
|
||||
|
||||
export type MapDeps<
|
||||
Deps extends Dependencies,
|
||||
T extends readonly unknown[]
|
||||
> = T extends [infer First extends keyof Deps, ...infer Rest extends readonly unknown[]]
|
||||
? [ UnpackFunction<Deps[First]>, ...(MapDeps<Deps, Rest> extends [never] ? [] : MapDeps<Deps,Rest>)] : [never]
|
||||
//Basically, '@sern/client' | '@sern/store' | '@sern/modules' | '@sern/error' | '@sern/emitter' will be provided defaults, and you can exclude the rest
|
||||
export type OptionalDependencies = '@sern/logger';
|
||||
@@ -1,215 +0,0 @@
|
||||
import type {
|
||||
ApplicationCommandAttachmentOption,
|
||||
ApplicationCommandChannelOptionData,
|
||||
ApplicationCommandChoicesData,
|
||||
ApplicationCommandNonOptionsData,
|
||||
ApplicationCommandNumericOptionData,
|
||||
ApplicationCommandOptionData,
|
||||
ApplicationCommandOptionType,
|
||||
ApplicationCommandSubCommandData,
|
||||
ApplicationCommandSubGroupData,
|
||||
AutocompleteInteraction,
|
||||
Awaitable,
|
||||
BaseApplicationCommandOptionsData,
|
||||
ButtonInteraction,
|
||||
MessageContextMenuCommandInteraction,
|
||||
ModalSubmitInteraction,
|
||||
UserContextMenuCommandInteraction,
|
||||
ChannelSelectMenuInteraction,
|
||||
MentionableSelectMenuInteraction,
|
||||
RoleSelectMenuInteraction,
|
||||
StringSelectMenuInteraction
|
||||
} from 'discord.js';
|
||||
import type {
|
||||
DiscordEventCommand,
|
||||
ExternalEventCommand,
|
||||
SernEventCommand,
|
||||
} from '../handler/structures/events';
|
||||
import { CommandType } from '../handler/structures/enums';
|
||||
import type { Args, SlashOptions } from './handler';
|
||||
import type Context from '../handler/structures/context';
|
||||
import type { AutocompletePlugin, CommandPlugin, EventPlugin } from '../handler/plugins/plugin';
|
||||
import { EventType } from '../handler/structures/enums';
|
||||
import type { UserSelectMenuInteraction } from 'discord.js';
|
||||
|
||||
export interface Module {
|
||||
type?: CommandType | EventType;
|
||||
name?: string;
|
||||
description?: string;
|
||||
execute: (...args: any[]) => any
|
||||
}
|
||||
|
||||
export interface TextCommand extends Module {
|
||||
type: CommandType.Text;
|
||||
onEvent: EventPlugin<CommandType.Text>[];
|
||||
plugins: CommandPlugin[];
|
||||
alias?: string[];
|
||||
execute: (ctx: Context, args: ['text', string[]]) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
export interface SlashCommand extends Module {
|
||||
type: CommandType.Slash;
|
||||
onEvent: EventPlugin<CommandType.Slash>[];
|
||||
plugins: CommandPlugin[];
|
||||
options?: SernOptionsData[];
|
||||
execute: (ctx: Context, args: ['slash', SlashOptions]) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
export interface BothCommand extends Module {
|
||||
type: CommandType.Both;
|
||||
onEvent: EventPlugin<CommandType.Both>[];
|
||||
plugins: CommandPlugin[];
|
||||
alias?: string[];
|
||||
options?: SernOptionsData[];
|
||||
execute: (ctx: Context, args: Args) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
export interface ContextMenuUser extends Module {
|
||||
type: CommandType.CtxUser;
|
||||
onEvent: EventPlugin<CommandType.CtxUser>[];
|
||||
plugins: CommandPlugin[];
|
||||
execute: (ctx: UserContextMenuCommandInteraction) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
export interface ContextMenuMsg extends Module {
|
||||
type: CommandType.CtxMsg;
|
||||
onEvent: EventPlugin<CommandType.CtxMsg>[];
|
||||
plugins: CommandPlugin[];
|
||||
execute: (ctx: MessageContextMenuCommandInteraction) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
export interface ButtonCommand extends Module {
|
||||
type: CommandType.Button;
|
||||
onEvent: EventPlugin<CommandType.Button>[];
|
||||
plugins: CommandPlugin[];
|
||||
execute: (ctx: ButtonInteraction) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
export interface StringSelectCommand extends Module {
|
||||
type: CommandType.StringSelect;
|
||||
onEvent: EventPlugin<CommandType.StringSelect>[];
|
||||
plugins: CommandPlugin[];
|
||||
execute: (ctx: StringSelectMenuInteraction) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
export interface ChannelSelectCommand extends Module {
|
||||
type: CommandType.ChannelSelect;
|
||||
onEvent: EventPlugin<CommandType.ChannelSelect>[];
|
||||
plugins: CommandPlugin[];
|
||||
execute: (ctx: ChannelSelectMenuInteraction) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
export interface RoleSelectCommand extends Module {
|
||||
type: CommandType.RoleSelect;
|
||||
onEvent: EventPlugin<CommandType.RoleSelect>[];
|
||||
plugins: CommandPlugin[];
|
||||
execute: (ctx: RoleSelectMenuInteraction) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
export interface MentionableSelectCommand extends Module {
|
||||
type: CommandType.MentionableSelect;
|
||||
onEvent: EventPlugin<CommandType.MentionableSelect>[];
|
||||
plugins: CommandPlugin[];
|
||||
execute: (ctx: MentionableSelectMenuInteraction) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
export interface UserSelectCommand extends Module {
|
||||
type: CommandType.UserSelect;
|
||||
onEvent: EventPlugin<CommandType.UserSelect>[];
|
||||
plugins: CommandPlugin[];
|
||||
execute: (ctx: UserSelectMenuInteraction) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
export interface ModalSubmitCommand extends Module {
|
||||
type: CommandType.Modal;
|
||||
onEvent: EventPlugin<CommandType.Modal>[];
|
||||
plugins: CommandPlugin[];
|
||||
execute: (ctx: ModalSubmitInteraction) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
export interface AutocompleteCommand extends Module {
|
||||
name?: never;
|
||||
description?: never;
|
||||
type?: never;
|
||||
onEvent: AutocompletePlugin[];
|
||||
execute: (ctx: AutocompleteInteraction) => Awaitable<unknown>;
|
||||
}
|
||||
|
||||
export type EventModule = DiscordEventCommand | SernEventCommand | ExternalEventCommand;
|
||||
export type CommandModule =
|
||||
| TextCommand
|
||||
| SlashCommand
|
||||
| BothCommand
|
||||
| ContextMenuUser
|
||||
| ContextMenuMsg
|
||||
| ButtonCommand
|
||||
| StringSelectCommand
|
||||
| MentionableSelectCommand
|
||||
| UserSelectCommand
|
||||
| ChannelSelectCommand
|
||||
| RoleSelectCommand
|
||||
| ModalSubmitCommand;
|
||||
|
||||
export type AnyModule = CommandModule | EventModule;
|
||||
|
||||
//https://stackoverflow.com/questions/64092736/alternative-to-switch-statement-for-typescript-discriminated-union
|
||||
// Explicit Module Definitions for mapping
|
||||
export type CommandModuleDefs = {
|
||||
[CommandType.Text]: TextCommand;
|
||||
[CommandType.Slash]: SlashCommand;
|
||||
[CommandType.Both]: BothCommand;
|
||||
[CommandType.CtxMsg]: ContextMenuMsg;
|
||||
[CommandType.CtxUser]: ContextMenuUser;
|
||||
[CommandType.Button]: ButtonCommand;
|
||||
[CommandType.StringSelect]: StringSelectCommand;
|
||||
[CommandType.RoleSelect] : RoleSelectCommand;
|
||||
[CommandType.ChannelSelect] : ChannelSelectCommand;
|
||||
[CommandType.MentionableSelect] : MentionableSelectCommand;
|
||||
[CommandType.UserSelect] : UserSelectCommand;
|
||||
[CommandType.Modal]: ModalSubmitCommand;
|
||||
};
|
||||
|
||||
export type EventModuleDefs = {
|
||||
[EventType.Sern]: SernEventCommand;
|
||||
[EventType.Discord]: DiscordEventCommand;
|
||||
[EventType.External]: ExternalEventCommand;
|
||||
};
|
||||
|
||||
export interface SernAutocompleteData extends Omit<BaseApplicationCommandOptionsData, 'autocomplete'> {
|
||||
autocomplete: true;
|
||||
type:
|
||||
| ApplicationCommandOptionType.String
|
||||
| ApplicationCommandOptionType.Number
|
||||
| ApplicationCommandOptionType.Integer;
|
||||
command: AutocompleteCommand;
|
||||
}
|
||||
|
||||
/**
|
||||
* Type that replaces autocomplete with {@link SernAutocompleteData}
|
||||
*/
|
||||
export type BaseOptions =
|
||||
| ApplicationCommandChoicesData
|
||||
| ApplicationCommandNonOptionsData
|
||||
| ApplicationCommandChannelOptionData
|
||||
| ApplicationCommandNumericOptionData
|
||||
| ApplicationCommandAttachmentOption
|
||||
| SernAutocompleteData;
|
||||
|
||||
export interface SernSubCommandData extends BaseApplicationCommandOptionsData {
|
||||
type: ApplicationCommandOptionType.Subcommand;
|
||||
required?: never;
|
||||
options?: BaseOptions[];
|
||||
}
|
||||
|
||||
export interface SernSubCommandGroupData extends BaseApplicationCommandOptionsData {
|
||||
type: ApplicationCommandOptionType.SubcommandGroup;
|
||||
required?: never;
|
||||
options?: SernSubCommandData[];
|
||||
}
|
||||
|
||||
export type SernOptionsData<U extends ApplicationCommandOptionData = ApplicationCommandOptionData> =
|
||||
U extends ApplicationCommandSubCommandData
|
||||
? SernSubCommandData
|
||||
: U extends ApplicationCommandSubGroupData
|
||||
? SernSubCommandGroupData
|
||||
: BaseOptions;
|
||||
90
src/types/utility.ts
Normal file
90
src/types/utility.ts
Normal file
@@ -0,0 +1,90 @@
|
||||
import type { InteractionReplyOptions, MessageReplyOptions } from 'discord.js';
|
||||
import type { Module } from './core-modules';
|
||||
|
||||
export type Awaitable<T> = PromiseLike<T> | T;
|
||||
export type Dictionary = Record<string, unknown>
|
||||
|
||||
export type AnyFunction = (...args: any[]) => unknown;
|
||||
|
||||
export interface SernEventsMapping {
|
||||
'module.register': [Payload];
|
||||
'module.activate': [Payload];
|
||||
error: [{ type: 'failure'; module?: Module; reason: string | Error }];
|
||||
warning: [Payload];
|
||||
modulesLoaded: [never?];
|
||||
}
|
||||
|
||||
export type Payload =
|
||||
| { type: 'success'; module: Module }
|
||||
| { type: 'failure'; module?: Module; reason: string | Error }
|
||||
| { type: 'warning'; module: undefined; reason: string };
|
||||
|
||||
export type UnpackFunction<T> = T extends (...args: any) => infer U ? U : T
|
||||
export type UnpackedDependencies = {
|
||||
[K in keyof Dependencies]: UnpackFunction<Dependencies[K]>
|
||||
}
|
||||
export type ReplyOptions = string | Omit<InteractionReplyOptions, 'fetchReply'> | MessageReplyOptions;
|
||||
|
||||
|
||||
/**
|
||||
* @interface Wrapper
|
||||
* @description Configuration interface for the sern framework. This interface defines
|
||||
* the structure for configuring essential framework features including command handling,
|
||||
* event management, and task scheduling.
|
||||
*/
|
||||
export interface Wrapper {
|
||||
/**
|
||||
* @property {string|string[]} commands
|
||||
* @description Specifies the directory path where command modules are located.
|
||||
* This is a required property that tells sern where to find and load command files.
|
||||
* The path should be relative to the project root. If given an array, each directory is loaded in order
|
||||
* they were declared. Order of modules in each directory is not guaranteed
|
||||
*
|
||||
* @example
|
||||
* commands: ["./dist/commands"]
|
||||
*/
|
||||
commands: string | string[];
|
||||
/**
|
||||
* @property {boolean} [handleModuleErrors]
|
||||
* @description Optional flag to enable automatic error handling for modules.
|
||||
* When enabled, sern will automatically catch and handle errors that occur
|
||||
* during module execution, preventing crashes and providing error logging.
|
||||
*
|
||||
* @default false
|
||||
*/
|
||||
handleModuleErrors?: boolean;
|
||||
/**
|
||||
* @property {string} [defaultPrefix]
|
||||
* @description Optional prefix for text commands. This prefix will be used
|
||||
* to identify text commands in messages. If not specified, text commands {@link CommandType.Text}
|
||||
* will be disabled.
|
||||
*
|
||||
* @example
|
||||
* defaultPrefix: "?"
|
||||
*/
|
||||
defaultPrefix?: string;
|
||||
/**
|
||||
* @property {string|string[]} [events]
|
||||
* @description Optional directory path where event modules are located.
|
||||
* If provided, Sern will automatically register and handle events from
|
||||
* modules in this directory. The path should be relative to the project root.
|
||||
* If given an array, each directory is loaded in order they were declared.
|
||||
* Order of modules in each directory is not guaranteed.
|
||||
*
|
||||
* @example
|
||||
* events: ["./dist/events"]
|
||||
*/
|
||||
events?: string | string[];
|
||||
/**
|
||||
* @property {string|string[]} [tasks]
|
||||
* @description Optional directory path where scheduled task modules are located.
|
||||
* If provided, Sern will automatically register and handle scheduled tasks
|
||||
* from modules in this directory. The path should be relative to the project root.
|
||||
* If given an array, each directory is loaded in order they were declared.
|
||||
* Order of modules in each directory is not guaranteed.
|
||||
*
|
||||
* @example
|
||||
* tasks: ["./dist/tasks"]
|
||||
*/
|
||||
tasks?: string | string[];
|
||||
}
|
||||
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,20 +0,0 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "esnext",
|
||||
"module": "commonjs",
|
||||
"outDir": "dist",
|
||||
"rootDir": "src",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"noImplicitAny": true,
|
||||
"strictNullChecks": true,
|
||||
"importsNotUsedAsValues": "error",
|
||||
"baseUrl": ".",
|
||||
"resolveJsonModule": true,
|
||||
"moduleResolution": "node",
|
||||
"skipLibCheck": true,
|
||||
"allowSyntheticDefaultImports": true,
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"include": ["src/secrets.json", "src"]
|
||||
}
|
||||
85
test/core/context.test.ts
Normal file
85
test/core/context.test.ts
Normal file
@@ -0,0 +1,85 @@
|
||||
import { describe, vi, it, expect } from'vitest'
|
||||
import { Context } from '../../src';
|
||||
import { faker } from '@faker-js/faker'
|
||||
describe('Context', () => {
|
||||
// Mocked message and interaction objects for testing
|
||||
const mockMessage = {
|
||||
id: 'messageId',
|
||||
channel: 'channelId',
|
||||
channelId: 'channelId',
|
||||
interaction: {
|
||||
id: faker.string.uuid()
|
||||
},
|
||||
author: { id: 'userId' },
|
||||
createdTimestamp: 1234567890,
|
||||
guild: 'guildId',
|
||||
guildId: 'guildId',
|
||||
member: { id: 'memberId' },
|
||||
client: { id: 'clientId' },
|
||||
inGuild: vi.fn().mockReturnValue(true),
|
||||
reply: vi.fn(),
|
||||
};
|
||||
|
||||
const mockInteraction = {
|
||||
id: 'interactionId',
|
||||
user: { id: 'userId' },
|
||||
channel: 'channelId',
|
||||
channelId: 'channelId',
|
||||
createdTimestamp: 1234567890,
|
||||
guild: 'guildId',
|
||||
guildId: 'guildId',
|
||||
fetchReply: vi.fn().mockResolvedValue({}),
|
||||
member: { id: 'memberId' },
|
||||
client: { id: 'clientId' },
|
||||
isChatInputCommand: vi.fn().mockResolvedValue(true),
|
||||
inGuild: vi.fn().mockReturnValue(true),
|
||||
reply: vi.fn().mockResolvedValue({}),
|
||||
};
|
||||
|
||||
it('should create a context from a message', () => {
|
||||
//@ts-ignore
|
||||
const context = Context.wrap(mockMessage);
|
||||
expect(context).toBeDefined();
|
||||
expect(context.id).toBe('messageId');
|
||||
});
|
||||
it('should throw error if accessing interaction as message', () => {
|
||||
//@ts-ignore
|
||||
const context = Context.wrap(mockMessage);
|
||||
expect(context).toBeDefined();
|
||||
expect(() => context.interaction)
|
||||
.toThrowError('You cannot use message when an interaction fired or vice versa');
|
||||
|
||||
})
|
||||
it('should throw error if accessing message as interaction', () => {
|
||||
//@ts-ignore
|
||||
const context = Context.wrap(mockInteraction);
|
||||
expect(context).toBeDefined();
|
||||
expect(() => context.message)
|
||||
.toThrowError('You cannot use message when an interaction fired or vice versa');
|
||||
|
||||
})
|
||||
|
||||
it('should create a context from an interaction', () => {
|
||||
//@ts-ignore
|
||||
const context = Context.wrap(mockInteraction);
|
||||
expect(context).toBeDefined();
|
||||
expect(context.id).toBe('interactionId');
|
||||
});
|
||||
|
||||
it('should reply to a context with a message', async () => {
|
||||
//@ts-ignore
|
||||
const context = Context.wrap(mockMessage);
|
||||
const replyOptions = { content: 'Hello, world!' };
|
||||
await context.reply(replyOptions);
|
||||
expect(mockMessage.reply).toHaveBeenCalledWith(replyOptions);
|
||||
});
|
||||
|
||||
it('should reply to a context with an interaction', async () => {
|
||||
//@ts-ignore
|
||||
const context = Context.wrap(mockInteraction);
|
||||
const replyOptions = { content: 'Hello, world!' };
|
||||
await context.reply(replyOptions);
|
||||
expect(mockInteraction.reply).toHaveBeenCalledWith(replyOptions);
|
||||
});
|
||||
|
||||
});
|
||||
11
test/core/contracts.test.ts
Normal file
11
test/core/contracts.test.ts
Normal file
@@ -0,0 +1,11 @@
|
||||
import { assertType, describe, it } from 'vitest';
|
||||
|
||||
import * as __Services from '../../src/core/structures/default-services';
|
||||
import * as Contracts from '../../src/core/interfaces';
|
||||
|
||||
describe('default contracts', () => {
|
||||
it('should satisfy contracts', () => {
|
||||
assertType<Contracts.Logging>(new __Services.DefaultLogging());
|
||||
assertType<Contracts.ErrorHandling>(new __Services.DefaultErrorHandling());
|
||||
});
|
||||
});
|
||||
27
test/core/create-plugin.test.ts
Normal file
27
test/core/create-plugin.test.ts
Normal file
@@ -0,0 +1,27 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import {
|
||||
CommandControlPlugin,
|
||||
CommandInitPlugin,
|
||||
EventInitPlugin,
|
||||
} from '../../src';
|
||||
import { PluginType, controller } from '../../src';
|
||||
|
||||
describe('create-plugins', () => {
|
||||
it('should make proper control plugins', () => {
|
||||
const pl2 = CommandControlPlugin(() => controller.next());
|
||||
expect(pl2).to.have.all.keys(['type', 'execute']);
|
||||
expect(pl2.type).toBe(PluginType.Control);
|
||||
expect(pl2.execute).an('function');
|
||||
});
|
||||
it('should make proper init plugins', () => {
|
||||
const pl = EventInitPlugin(() => controller.next());
|
||||
expect(pl).to.have.all.keys(['type', 'execute']);
|
||||
expect(pl.type).toBe(PluginType.Init);
|
||||
expect(pl.execute).an('function');
|
||||
|
||||
const pl2 = CommandInitPlugin(() => controller.next());
|
||||
expect(pl2).to.have.all.keys(['type', 'execute']);
|
||||
expect(pl2.type).toBe(PluginType.Init);
|
||||
expect(pl2.execute).an('function');
|
||||
});
|
||||
});
|
||||
294
test/core/functions.test.ts
Normal file
294
test/core/functions.test.ts
Normal file
@@ -0,0 +1,294 @@
|
||||
//@ts-nocheck
|
||||
import { afterEach, describe, expect, it, vi } from 'vitest';
|
||||
import { PluginType, SernOptionsData, controller } from '../../src/index';
|
||||
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();
|
||||
});
|
||||
|
||||
|
||||
it('should partition plugins correctly', () => {
|
||||
const plugins = createRandomPlugins(100);
|
||||
const [onEvent, init] = partitionPlugins(plugins);
|
||||
for (const el of onEvent) expect(el.type).to.equal(PluginType.Control);
|
||||
|
||||
for (const el of init) expect(el.type).to.equal(PluginType.Init);
|
||||
});
|
||||
|
||||
describe('autocomplete', ( ) => {
|
||||
|
||||
it('should tree search options tree depth 1', () => {
|
||||
const options: SernOptionsData[] = [
|
||||
createRandomChoice(),
|
||||
{
|
||||
type: ApplicationCommandOptionType.String,
|
||||
name: 'autocomplete',
|
||||
description: 'here',
|
||||
autocomplete: true,
|
||||
command: { onEvent: [], execute: vi.fn() },
|
||||
},
|
||||
];
|
||||
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', () => {
|
||||
const subcommandName = faker.string.alpha();
|
||||
const options: SernOptionsData[] = [
|
||||
{
|
||||
type: ApplicationCommandOptionType.Subcommand,
|
||||
name: subcommandName,
|
||||
description: faker.string.alpha(),
|
||||
options: [
|
||||
createRandomChoice(),
|
||||
createRandomChoice(),
|
||||
createRandomChoice(),
|
||||
{
|
||||
type: ApplicationCommandOptionType.String,
|
||||
name: 'nested',
|
||||
description: faker.string.alpha(),
|
||||
autocomplete: true,
|
||||
command: {
|
||||
onEvent: [],
|
||||
execute: () => {},
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
];
|
||||
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', () => {
|
||||
const subgroupName = faker.string.alpha()
|
||||
const subcommandName = faker.string.alpha();
|
||||
const options: SernOptionsData[] = [
|
||||
{
|
||||
type: ApplicationCommandOptionType.SubcommandGroup,
|
||||
name: subgroupName,
|
||||
description: faker.string.alpha(),
|
||||
options: [
|
||||
{
|
||||
type: ApplicationCommandOptionType.Subcommand,
|
||||
name: subcommandName,
|
||||
description: faker.string.alpha(),
|
||||
options: [
|
||||
createRandomChoice(),
|
||||
createRandomChoice(),
|
||||
{
|
||||
type: ApplicationCommandOptionType.String,
|
||||
name: 'nested',
|
||||
description: faker.string.alpha(),
|
||||
autocomplete: true,
|
||||
command: {
|
||||
onEvent: [],
|
||||
execute: () => {},
|
||||
},
|
||||
},
|
||||
createRandomChoice(),
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
];
|
||||
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 ', () => {
|
||||
const subcommandName = faker.string.alpha();
|
||||
const groupname = faker.string.alpha()
|
||||
const options: SernOptionsData[] = [
|
||||
{
|
||||
type: ApplicationCommandOptionType.SubcommandGroup,
|
||||
name: groupname,
|
||||
description: faker.string.alpha(),
|
||||
options: [
|
||||
{
|
||||
type: ApplicationCommandOptionType.Subcommand,
|
||||
name: subcommandName,
|
||||
description: faker.string.alpha(),
|
||||
options: [
|
||||
createRandomChoice(),
|
||||
createRandomChoice(),
|
||||
{
|
||||
type: ApplicationCommandOptionType.String,
|
||||
name: 'nested',
|
||||
description: faker.string.alpha(),
|
||||
autocomplete: true,
|
||||
command: {
|
||||
onEvent: [],
|
||||
execute: () => {},
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: ApplicationCommandOptionType.Subcommand,
|
||||
name: subcommandName + 'a',
|
||||
description: faker.string.alpha(),
|
||||
options: [
|
||||
createRandomChoice(),
|
||||
{
|
||||
type: ApplicationCommandOptionType.String,
|
||||
name: 'nested',
|
||||
description: faker.string.alpha(),
|
||||
autocomplete: true,
|
||||
command: {
|
||||
onEvent: [],
|
||||
execute: () => {},
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
];
|
||||
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', () => {
|
||||
const groupName = faker.string.alpha()
|
||||
const subcommandName = faker.string.alpha();
|
||||
const options: SernOptionsData[] = [
|
||||
{
|
||||
type: ApplicationCommandOptionType.SubcommandGroup,
|
||||
name: groupName,
|
||||
description: faker.string.alpha(),
|
||||
options: [
|
||||
{
|
||||
type: ApplicationCommandOptionType.Subcommand,
|
||||
name: subcommandName,
|
||||
description: faker.string.alpha(),
|
||||
options: [
|
||||
createRandomChoice(),
|
||||
createRandomChoice(),
|
||||
{
|
||||
type: ApplicationCommandOptionType.String,
|
||||
name: 'nested',
|
||||
description: faker.string.alpha(),
|
||||
autocomplete: true,
|
||||
command: {
|
||||
onEvent: [],
|
||||
execute: () => {},
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: ApplicationCommandOptionType.Subcommand,
|
||||
name: subcommandName + 'anothera',
|
||||
description: faker.string.alpha(),
|
||||
options: [
|
||||
createRandomChoice(),
|
||||
{
|
||||
type: ApplicationCommandOptionType.String,
|
||||
name: 'nested',
|
||||
description: faker.string.alpha(),
|
||||
autocomplete: true,
|
||||
command: {
|
||||
onEvent: [],
|
||||
execute: () => {},
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
];
|
||||
|
||||
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('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: subcommandGroupName,
|
||||
description: faker.string.alpha(),
|
||||
options: [
|
||||
{
|
||||
type: ApplicationCommandOptionType.Subcommand,
|
||||
name: subcommandName,
|
||||
description: faker.string.alpha(),
|
||||
options: [
|
||||
createRandomChoice(),
|
||||
createRandomChoice(),
|
||||
{
|
||||
type: ApplicationCommandOptionType.String,
|
||||
name: optionName,
|
||||
description: faker.string.alpha(),
|
||||
autocomplete: true,
|
||||
command: {
|
||||
onEvent: [],
|
||||
execute: vi.fn(),
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: ApplicationCommandOptionType.Subcommand,
|
||||
name: subcommandName + 'a',
|
||||
description: faker.string.alpha(),
|
||||
options: [
|
||||
createRandomChoice(),
|
||||
{
|
||||
type: ApplicationCommandOptionType.String,
|
||||
name: optionName,
|
||||
description: faker.string.alpha(),
|
||||
autocomplete: true,
|
||||
command: {
|
||||
onEvent: [],
|
||||
execute: vi.fn(),
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
];
|
||||
let accumulator = '';
|
||||
let result: unknown;
|
||||
const table = createLookupTable(options)
|
||||
for (const char of optionName) {
|
||||
accumulator += char;
|
||||
|
||||
const focusedValue = {
|
||||
name: accumulator,
|
||||
value: faker.string.alpha(),
|
||||
focused: true,
|
||||
};
|
||||
result = table.get(`<parent>/${subcommandGroupName}/${subcommandName}/${focusedValue.name}` );
|
||||
}
|
||||
expect(result).toBeTruthy();
|
||||
});
|
||||
})
|
||||
|
||||
|
||||
});
|
||||
94
test/core/id.test.ts
Normal file
94
test/core/id.test.ts
Normal file
@@ -0,0 +1,94 @@
|
||||
//@ts-nocheck
|
||||
import { expect, test, vi } from 'vitest'
|
||||
import { CommandType } from '../../src/core/structures/enums';
|
||||
|
||||
import * as Id from '../../src/core/id'
|
||||
import { ButtonInteraction, ModalSubmitInteraction } from 'discord.js';
|
||||
|
||||
test('id -> Text', () => {
|
||||
expect(Id.create("ping", CommandType.Text)).toBe("ping_T")
|
||||
})
|
||||
|
||||
test('id -> Both', () => {
|
||||
expect(Id.create("ping", CommandType.Both)).toBe("ping_B")
|
||||
})
|
||||
|
||||
test('id -> CtxMsg', () => {
|
||||
expect(Id.create("ping", CommandType.CtxMsg)).toBe("ping_A3")
|
||||
})
|
||||
test('id -> CtxUsr', () => {
|
||||
expect(Id.create("ping", CommandType.CtxUser)).toBe("ping_A2")
|
||||
})
|
||||
test('id -> Modal', () => {
|
||||
expect(Id.create("my-modal", CommandType.Modal)).toBe("my-modal_M");
|
||||
})
|
||||
|
||||
test('id -> Button', () => {
|
||||
expect(Id.create("my-button", CommandType.Button)).toBe("my-button_C2");
|
||||
})
|
||||
|
||||
test('id -> Slash', () => {
|
||||
expect(Id.create("myslash", CommandType.Slash)).toBe("myslash_A1");
|
||||
})
|
||||
|
||||
test('id -> StringSelect', () => {
|
||||
expect(Id.create("mystringselect", CommandType.StringSelect)).toBe("mystringselect_C3");
|
||||
})
|
||||
|
||||
test('id -> UserSelect', () => {
|
||||
expect(Id.create("myuserselect", CommandType.UserSelect)).toBe("myuserselect_C5");
|
||||
})
|
||||
|
||||
test('id -> RoleSelect', () => {
|
||||
expect(Id.create("myroleselect", CommandType.RoleSelect)).toBe("myroleselect_C6");
|
||||
})
|
||||
|
||||
test('id -> MentionSelect', () => {
|
||||
expect(Id.create("mymentionselect", CommandType.MentionableSelect)).toBe("mymentionselect_C7");
|
||||
})
|
||||
|
||||
test('id -> ChannelSelect', () => {
|
||||
const modal = Id.create("mychannelselect", CommandType.ChannelSelect)
|
||||
expect(modal).toBe("mychannelselect_C8");
|
||||
})
|
||||
|
||||
test('id reconstruct button', () => {
|
||||
const idload = Id.reconstruct(new ButtonInteraction("btn"))
|
||||
expect(idload[0].id).toBe("btn_C2")
|
||||
})
|
||||
|
||||
test('id reconstruct button with params', () => {
|
||||
const idload = Id.reconstruct(new ButtonInteraction("btn/asdf"))
|
||||
expect(idload[0].id).toBe("btn_C2")
|
||||
expect(idload[0].params).toBe("asdf")
|
||||
})
|
||||
test('id reconstruct modal with params', () => {
|
||||
const idload = Id.reconstruct(new ModalSubmitInteraction("btn/asdf"))
|
||||
expect(idload[0].id).toBe("btn_M")
|
||||
expect(idload[0].params).toBe("asdf")
|
||||
})
|
||||
test('id reconstruct modal', () => {
|
||||
const idload = Id.reconstruct(new ModalSubmitInteraction("btn"))
|
||||
expect(idload[0].id).toBe("btn_M")
|
||||
expect(idload[0].params).toBe(undefined)
|
||||
})
|
||||
test('id reconstruct button with empty params', () => {
|
||||
const idload = Id.reconstruct(new ButtonInteraction("btn/"))
|
||||
expect(idload[0].id).toBe("btn_C2")
|
||||
expect(idload[0].params).toBe("")
|
||||
})
|
||||
test('id reconstruct with multiple slashes', () => {
|
||||
const idload = Id.reconstruct(new ButtonInteraction("btn//"))
|
||||
expect(idload[0].id).toBe("btn_C2")
|
||||
expect(idload[0].params).toBe("/")
|
||||
})
|
||||
|
||||
|
||||
test('id reconstruct button', () => {
|
||||
const idload = Id.reconstruct(new ButtonInteraction("btn"))
|
||||
expect(idload[0].id).toBe("btn_C2")
|
||||
expect(idload[0].params).toBe(undefined)
|
||||
})
|
||||
|
||||
|
||||
|
||||
64
test/core/module-loading.test.ts
Normal file
64
test/core/module-loading.test.ts
Normal file
@@ -0,0 +1,64 @@
|
||||
import { describe, it, expect } from 'vitest'
|
||||
import path from 'node:path'
|
||||
import * as Files from '../../src/core/module-loading'
|
||||
import { Module } from '../../src/types/core-modules'
|
||||
import { AssertionError } from 'node:assert'
|
||||
//TODO: mock fs?
|
||||
describe('module-loading', () => {
|
||||
it('should get the filename of the commandmodule (linux, esm)', () => {
|
||||
const fname = "///home/pooba/Projects/sern/halibu/dist/commands/ping.js"
|
||||
const callsiteinfo = Files.parseCallsite(fname)
|
||||
expect(callsiteinfo.name).toBe("ping")
|
||||
})
|
||||
it('should get filename of commandmodule (linux, cjs)', () => {
|
||||
const fname = "file:///home/pooba/Projects/sern/halibu/dist/commands/ping.js"
|
||||
const callsiteinfo = Files.parseCallsite(fname)
|
||||
expect(callsiteinfo.name).toBe("ping")
|
||||
|
||||
})
|
||||
it('should get the filename of the commandmodule (windows, cjs)', () => {
|
||||
//this test case is impossible on linux.
|
||||
if(process.platform == 'win32') {
|
||||
const fname = "C:\\pooba\\Projects\\sern\\halibu\\dist\\commands\\ping.js"
|
||||
const callsiteinfo = Files.parseCallsite(fname)
|
||||
expect(callsiteinfo.name).toEqual("ping");
|
||||
}
|
||||
})
|
||||
it('should get filename of commandmodule (windows, esm)', () => {
|
||||
//this test case is impossible on linux.
|
||||
if(process.platform == 'win32') {
|
||||
const fname = "file:///C:\\pooba\\Projects\\sern\\halibu\\dist\\commands\\ping.js"
|
||||
const callsiteinfo = Files.parseCallsite(fname)
|
||||
expect(callsiteinfo.name).toEqual("ping");
|
||||
}
|
||||
|
||||
})
|
||||
|
||||
it('should import a commandModule properly', async () => {
|
||||
const { module } = await Files.importModule<Module>(path.resolve("test", 'mockules', "module.ts"));
|
||||
expect(module.name).toBe('module')
|
||||
})
|
||||
it('should throw when failed commandModule import', async () => {
|
||||
try {
|
||||
await Files.importModule(path.resolve('test', 'mockules', 'failed.ts'))
|
||||
} catch(e) {
|
||||
expect(e instanceof AssertionError)
|
||||
}
|
||||
})
|
||||
it('should throw when failed commandModule import', async () => {
|
||||
try {
|
||||
await Files.importModule(path.resolve('test', 'mockules', 'failed.ts'))
|
||||
} catch(e) {
|
||||
expect(e instanceof AssertionError)
|
||||
}
|
||||
})
|
||||
|
||||
it('reads all modules in mockules', async () => {
|
||||
const ps = [] as string[]
|
||||
for await (const fpath of Files.readRecursive(path.resolve('test', 'mockules'))) {
|
||||
ps.push(fpath)
|
||||
}
|
||||
expect(ps.length === 4)
|
||||
})
|
||||
|
||||
})
|
||||
92
test/core/presence.test.ts
Normal file
92
test/core/presence.test.ts
Normal file
@@ -0,0 +1,92 @@
|
||||
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
||||
import { Presence } from '../../src';
|
||||
import * as Files from '../../src/core/module-loading'
|
||||
import { presenceHandler } from '../../src/handlers/presence'
|
||||
|
||||
// Example test suite for the module function
|
||||
describe('module function', () => {
|
||||
it('should return a valid configuration', () => {
|
||||
const config = Presence.module({
|
||||
inject: ['dependency1', 'dependency2'],
|
||||
execute: vi.fn(),
|
||||
});
|
||||
|
||||
expect(config).toBeDefined();
|
||||
expect(config.inject).toEqual(['dependency1', 'dependency2']);
|
||||
expect(typeof config.execute).toBe('function');
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
describe('of function', () => {
|
||||
it('should return a valid presence configuration without repeat and onRepeat', () => {
|
||||
const presenceConfig = Presence.of({
|
||||
status: 'online',
|
||||
afk: false,
|
||||
activities: [{ name: 'Test Activity' }],
|
||||
shardId: [1, 2, 3],
|
||||
}).once();
|
||||
|
||||
expect(presenceConfig).toBeDefined();
|
||||
//@ts-ignore Maybe fix?
|
||||
expect(presenceConfig.repeat).toBeUndefined();
|
||||
//@ts-ignore Maybe fix?
|
||||
expect(presenceConfig.onRepeat).toBeUndefined();
|
||||
expect(presenceConfig).toMatchObject({
|
||||
status: 'online',
|
||||
afk: false,
|
||||
activities: [{ name: 'Test Activity' }],
|
||||
shardId: [1, 2, 3],
|
||||
});
|
||||
});
|
||||
|
||||
it('should return a valid presence configuration with repeat and onRepeat', () => {
|
||||
const onRepeatCallback = vi.fn();
|
||||
const presenceConfig = Presence.of({
|
||||
status: 'idle',
|
||||
activities: [{ name: 'Another Test Activity' }],
|
||||
}).repeated(onRepeatCallback, 5000);
|
||||
|
||||
expect(presenceConfig).toBeDefined();
|
||||
expect(presenceConfig.repeat).toBe(5000);
|
||||
expect(presenceConfig.onRepeat).toBe(onRepeatCallback);
|
||||
expect(presenceConfig).toMatchObject({
|
||||
status: 'idle',
|
||||
activities: [{ name: 'Another Test Activity' }],
|
||||
});
|
||||
});
|
||||
|
||||
|
||||
})
|
||||
|
||||
|
||||
describe('Presence module execution', () => {
|
||||
const mockExecuteResult = Presence.of({
|
||||
status: 'online',
|
||||
}).once();
|
||||
|
||||
const mockModule = Presence.module({
|
||||
inject: [ '@sern/client'],
|
||||
execute: vi.fn().mockReturnValue(mockExecuteResult)
|
||||
})
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
// Mock Files.importModule
|
||||
vi.spyOn(Files, 'importModule').mockResolvedValue({
|
||||
module: mockModule
|
||||
});
|
||||
|
||||
|
||||
|
||||
});
|
||||
it('should set presence once.', async () => {
|
||||
const setPresenceMock = vi.fn();
|
||||
const mockPath = '/path/to/presence/config';
|
||||
|
||||
await presenceHandler(mockPath, setPresenceMock);
|
||||
|
||||
expect(Files.importModule).toHaveBeenCalledWith(mockPath);
|
||||
expect(setPresenceMock).toHaveBeenCalledOnce();
|
||||
})
|
||||
|
||||
})
|
||||
@@ -1,20 +0,0 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "esnext",
|
||||
"module": "esnext",
|
||||
"outDir": "dist",
|
||||
"rootDir": "src",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"noImplicitAny": true,
|
||||
"strictNullChecks": true,
|
||||
"importsNotUsedAsValues": "error",
|
||||
"baseUrl": ".",
|
||||
"resolveJsonModule": true,
|
||||
"moduleResolution": "node",
|
||||
"skipLibCheck": true,
|
||||
"allowSyntheticDefaultImports": true,
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"include": ["src/secrets.json", "src"]
|
||||
}
|
||||
65
test/handlers.test.ts
Normal file
65
test/handlers.test.ts
Normal file
@@ -0,0 +1,65 @@
|
||||
//@ts-nocheck
|
||||
import { beforeEach, describe, expect, it, test } from 'vitest';
|
||||
import { callInitPlugins } from '../src/handlers/event-utils';
|
||||
|
||||
import { Client } from 'discord.js'
|
||||
import { faker } from '@faker-js/faker';
|
||||
import { EventEmitter } from 'events';
|
||||
import { CommandControlPlugin, CommandType, controller } from '../src';
|
||||
import { createRandomModule, createRandomInitPlugin } from './setup/util';
|
||||
|
||||
|
||||
|
||||
function mockDeps() {
|
||||
return {
|
||||
'@sern/client': new Client(),
|
||||
'@sern/emitter': new EventEmitter()
|
||||
}
|
||||
}
|
||||
|
||||
describe('calling init plugins', async () => {
|
||||
let deps;
|
||||
beforeEach(() => {
|
||||
deps = mockDeps()
|
||||
});
|
||||
|
||||
test ('call init plugins', async () => {
|
||||
const plugins = createRandomInitPlugin('go', { name: "abc" })
|
||||
const mod = createRandomModule([plugins])
|
||||
const s = await callInitPlugins(mod, deps, false)
|
||||
expect("abc").equal(s.name)
|
||||
})
|
||||
test('init plugins replace array', async () => {
|
||||
const plugins = createRandomInitPlugin('go', { opts: [] })
|
||||
const plugins2 = createRandomInitPlugin('go', { opts: ['a'] })
|
||||
const mod = createRandomModule([plugins, plugins2])
|
||||
const s = await callInitPlugins(mod, deps, false)
|
||||
expect(['a']).deep.equal(s.opts)
|
||||
})
|
||||
|
||||
})
|
||||
|
||||
|
||||
|
||||
|
||||
test('form sdt', async () => {
|
||||
|
||||
const expectedObject = {
|
||||
"plugin/abc": faker.person.jobArea(),
|
||||
"plugin2/abc": faker.git.branch(),
|
||||
"plugin3/cheese": faker.person.jobArea()
|
||||
}
|
||||
|
||||
const plugin = CommandControlPlugin<CommandType.Slash>((ctx,sdt) => {
|
||||
return controller.next({ "plugin/abc": expectedObject['plugin/abc'] });
|
||||
});
|
||||
const plugin2 = CommandControlPlugin<CommandType.Slash>((ctx,sdt) => {
|
||||
return controller.next({ "plugin2/abc": expectedObject['plugin2/abc'] });
|
||||
});
|
||||
const plugin3 = CommandControlPlugin<CommandType.Slash>((ctx,sdt) => {
|
||||
return controller.next({ "plugin3/cheese": expectedObject['plugin3/cheese'] });
|
||||
});
|
||||
|
||||
})
|
||||
|
||||
|
||||
0
test/mockules/failed.ts
Normal file
0
test/mockules/failed.ts
Normal file
6
test/mockules/module.ts
Normal file
6
test/mockules/module.ts
Normal file
@@ -0,0 +1,6 @@
|
||||
import { CommandType, commandModule } from '../../src/'
|
||||
export default commandModule({
|
||||
type: CommandType.Both,
|
||||
description: "",
|
||||
execute: (Ctx, args) => {}
|
||||
})
|
||||
6
test/mockules/ug/pass.ts
Normal file
6
test/mockules/ug/pass.ts
Normal file
@@ -0,0 +1,6 @@
|
||||
import { CommandType, commandModule } from '../../../src/'
|
||||
export default commandModule({
|
||||
type: CommandType.Both,
|
||||
description: "",
|
||||
execute: (Ctx, args) => {}
|
||||
})
|
||||
54
test/setup/setup-tests.ts
Normal file
54
test/setup/setup-tests.ts
Normal file
@@ -0,0 +1,54 @@
|
||||
import { vi } from 'vitest'
|
||||
import { makeDependencies } from '../../src';
|
||||
import { Client } from 'discord.js';
|
||||
|
||||
vi.mock('discord.js', async (importOriginal) => {
|
||||
const mod = await importOriginal()
|
||||
const ModalSubmitInteraction = class {
|
||||
customId;
|
||||
type = 5;
|
||||
isModalSubmit = vi.fn();
|
||||
constructor(customId) {
|
||||
this.customId = customId;
|
||||
}
|
||||
};
|
||||
const ButtonInteraction = class {
|
||||
customId;
|
||||
type = 3;
|
||||
componentType = 2;
|
||||
isButton = vi.fn();
|
||||
constructor(customId) {
|
||||
this.customId = customId;
|
||||
}
|
||||
};
|
||||
const AutocompleteInteraction = class {
|
||||
type = 4;
|
||||
option: string;
|
||||
constructor(s: string) {
|
||||
this.option = s;
|
||||
}
|
||||
options = {
|
||||
getFocused: vi.fn(),
|
||||
getSubcommand: vi.fn(),
|
||||
};
|
||||
};
|
||||
|
||||
return {
|
||||
Client : vi.fn(),
|
||||
Collection: mod.Collection,
|
||||
ComponentType: mod.ComponentType,
|
||||
InteractionType: mod.InteractionType,
|
||||
ApplicationCommandOptionType: mod.ApplicationCommandOptionType,
|
||||
ApplicationCommandType: mod.ApplicationCommandType,
|
||||
ModalSubmitInteraction,
|
||||
ButtonInteraction,
|
||||
AutocompleteInteraction,
|
||||
ChatInputCommandInteraction: vi.fn()
|
||||
};
|
||||
});
|
||||
|
||||
await makeDependencies(({ add }) => {
|
||||
add('@sern/client', { })
|
||||
})
|
||||
|
||||
|
||||
48
test/setup/util.ts
Normal file
48
test/setup/util.ts
Normal file
@@ -0,0 +1,48 @@
|
||||
import { faker } from "@faker-js/faker"
|
||||
import { CommandInitPlugin, CommandType, Module, controller } from "../../src"
|
||||
import { Processed } from "../../src/types/core-modules"
|
||||
import { vi } from 'vitest'
|
||||
|
||||
export function createRandomInitPlugin (s: 'go', mut?: Partial<Module>) {
|
||||
return CommandInitPlugin(({ module }) => {
|
||||
if(mut) {
|
||||
Object.entries(mut).forEach(([k, v]) => {
|
||||
module[k] = v
|
||||
})
|
||||
}
|
||||
return s == 'go'
|
||||
? controller.next()
|
||||
: controller.stop()
|
||||
})
|
||||
}
|
||||
|
||||
export function createRandomModule(plugins: any[]): Processed<Module> {
|
||||
return {
|
||||
type: CommandType.Both,
|
||||
meta: { id:"", absPath: "" },
|
||||
description: faker.string.alpha(),
|
||||
plugins,
|
||||
name: "cheese",
|
||||
onEvent: [],
|
||||
locals: {},
|
||||
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()),
|
||||
}));
|
||||
}
|
||||
@@ -1,18 +0,0 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"rootDir": "src",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"noImplicitAny": true,
|
||||
"experimentalDecorators": true,
|
||||
"strictNullChecks": true,
|
||||
"importsNotUsedAsValues": "error",
|
||||
"moduleResolution": "node",
|
||||
"skipLibCheck": true,
|
||||
"declaration": true,
|
||||
"allowSyntheticDefaultImports": true,
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"exclude": ["node_modules", "dist"],
|
||||
"include": ["src"]
|
||||
}
|
||||
@@ -1,8 +0,0 @@
|
||||
{
|
||||
"extends": "./tsconfig-base.json",
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"outDir": "dist/cjs",
|
||||
"target": "esnext"
|
||||
}
|
||||
}
|
||||
@@ -1,8 +0,0 @@
|
||||
{
|
||||
"extends": "./tsconfig-base.json",
|
||||
"compilerOptions": {
|
||||
"module": "esnext",
|
||||
"outDir": "dist/esm",
|
||||
"target": "esnext"
|
||||
}
|
||||
}
|
||||
21
tsconfig.json
Normal file
21
tsconfig.json
Normal file
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"rootDir": "src",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"strictNullChecks": true,
|
||||
"moduleResolution": "node16",
|
||||
"skipLibCheck": true,
|
||||
"declaration": true,
|
||||
"preserveSymlinks": true,
|
||||
"allowSyntheticDefaultImports": true,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"isolatedModules": true,
|
||||
"outDir": "dist",
|
||||
"module": "node16",
|
||||
"target": "esnext",
|
||||
"sourceMap": true
|
||||
},
|
||||
"exclude": ["node_modules", "dist"],
|
||||
"include": ["./src", "./src/**/*.d.ts"]
|
||||
}
|
||||
@@ -1,38 +0,0 @@
|
||||
import { defineConfig } from 'tsup';
|
||||
const shared = {
|
||||
entry: ['src/index.ts'],
|
||||
external: ['discord.js'],
|
||||
platform: 'node',
|
||||
clean: true,
|
||||
sourcemap: false
|
||||
};
|
||||
export default defineConfig([
|
||||
{
|
||||
format: 'esm',
|
||||
target: 'node16',
|
||||
tsconfig: './tsconfig-esm.json',
|
||||
outDir: './dist/esm',
|
||||
external: ['discord.js'],
|
||||
treeshake: true,
|
||||
outExtension() {
|
||||
return {
|
||||
js: '.mjs',
|
||||
};
|
||||
},
|
||||
...shared
|
||||
},
|
||||
{
|
||||
format: 'cjs',
|
||||
splitting: false,
|
||||
external: ['discord.js'],
|
||||
target: 'node16',
|
||||
tsconfig: './tsconfig-cjs.json',
|
||||
outDir: './dist/cjs',
|
||||
outExtension() {
|
||||
return {
|
||||
js: '.cjs',
|
||||
};
|
||||
},
|
||||
...shared
|
||||
},
|
||||
]);
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user