wip: lib overhaul (#20)

* chore!: complete rewrite

refactor(constants): move default options to a single file
chore(constants): define symbols for internal communication
refactor(functions/utility): improve formatDuration
refactor(functions/validation): improve all predicates
refactor(main/player)!: rethink options, initialization, prop names
refactor(Node)!: rework reconnect logic, remove unnecessary props, adapt to REST
refactor(NodeManager)!: better naming, new methods, fix and expose metrics
refactor(REST)!: remove retry limit, request queue, and improve types
refactor(plugins/lavalyrics): adapt to changes in Queue
refactor(FilterManager)!: remove direct filter access via data prop
feat(FilterManager): specific clear types, include pluginFilters in filter names
refactor(Queue)!: rename few props, adapt to external changes
refactor(QueueManager)!: remove unnecessary methods, adapt to external changes
refactor(typings): additions/modifications and name/description changes as needed
refactor(VoiceManager)!: do not auto-destroy player on guild/channel delete
refactor(VoiceRegion): adapt to external changes
refactor(VoiceState)!: remove unnecessary props, adapt to external changes

* refactor(functions/validation): run checks only when needed

* refactor(Playlist): throw for data with no track(s)

* chore: setup jest

* chore: write tests

* ci: add workflow for codecov coverage

* ci: update checkout and setup-node actions

* ci: set explicit perms for coverage, remove token (test)

* chore: update readme

Author: execaman

.github/workflows/coverage.yml

@@ -0,0 +1,27 @@
+name: Coverage
+
+on: [push, pull_request]
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Node
+        uses: actions/setup-node@v6
+        with:
+          cache: npm
+          node-version: 22
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm test
+
+      - name: Upload results to Codecov
+        uses: codecov/codecov-action@v5

.github/workflows/documentation.yml

@@ -26,10 +26,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Setup Node
-        uses: actions/setup-node@v5
+        uses: actions/setup-node@v6
         with:
           cache: npm
           node-version: 22

.gitignore

@@ -1,3 +1,4 @@
+/coverage
 /docs
 /lib
 node_modules/

README.md

@@ -1,25 +1,19 @@
 <div align="center">
   <img alt="Discolink" src="assets/music-album.png" width="120" />
 
-  [Icon designed by juicy_fish](https://www.flaticon.com/authors/juicy-fish)
+  [Icon by juicy_fish](https://www.flaticon.com/authors/juicy-fish)
   <br/>
-  [Documentation](https://github.com/execaman/discolink/wiki) | [API Reference](https://execaman.github.io/discolink)
-  
+  [API Reference](https://execaman.github.io/discolink) | [Coverage](http://app.codecov.io/gh/execaman/discolink)
+
 ![NPM Version](https://img.shields.io/npm/v/discolink?style=flat&logo=npm)
-![NPM Downloads](https://img.shields.io/npm/dm/discolink)
+![Codecov Coverage](https://img.shields.io/codecov/c/github/execaman/discolink?logo=codecov)
+
 </div>
 
 ## 🎯 Purpose
 
 The goal of this library is to abstract away obvious steps involved in the process of acting as an intermediary between [Lavalink](https://lavalink.dev/api) and [Discord](https://discord.com/developers/docs/events/gateway) to give developers a cleaner yet intuitive interface to work with.
 
-## ✨ Features
-
-- Built-in queue system
-- Automatic player relocation
-- Built-in custom plugin support
-- Automatic relevant-node selection
-
 ## ⚙️ Requirements
 
 - **Runtime** - one of the following:
@@ -59,7 +53,8 @@ client.on("raw", (payload) => {
 client.login();
 ```
 
-## 📝 Additional Notes
+## 📝 Implementation
 
-- Handle track end reasons other than `cleanup` and `finished` manually
-- Always check for `reconnecting` or `changingNode` when handling voice states
+- Handle track end reasons other than `cleanup` and `finished`
+- Handle voice states with care, e.g. `reconnecting`, `changingNode`, etc.
+- Handle queue destruction/relocation, e.g. guild/channel delete, node close/disconnect, etc.

jest.config.ts

@@ -0,0 +1,26 @@
+import { createDefaultPreset } from "ts-jest";
+import type { Config } from "jest";
+
+const config: Config = {
+  clearMocks: true,
+  collectCoverage: true,
+  collectCoverageFrom: [
+    "src/Functions/**/*.ts",
+    "src/Queue/Playlist.ts",
+    "src/Queue/Track.ts",
+    "!src/Typings/**/*",
+    "!src/**/index.ts",
+  ],
+  coverageDirectory: "coverage",
+  coverageProvider: "v8",
+  globals: {
+    $clientName: "name",
+    $clientVersion: "version",
+    $clientRepository: "repository",
+  },
+  preset: "ts-jest",
+  testEnvironment: "node",
+  ...createDefaultPreset(),
+};
+
+export default config;