feat: Custom events & optimizations

.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x, 19.x, 20.x, 21.x, 22.x]
+      fail-fast: true
+
+    name: Test TypeScript build
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'pnpm'
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+      - name: Build the package
+        run: pnpm build
+      - name: Run tests
+        run: pnpm run coverage

.github/workflows/npm-publish.yml

@@ -11,12 +11,13 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install pnpm
         uses: pnpm/action-setup@v4
         with:
-          version: 9
-      - uses: actions/setup-node@v3
+          version: 10
+      - name: Use Node.js
+        uses: actions/setup-node@v4
         with:
           node-version: 20
           registry-url: https://registry.npmjs.org/
@@ -29,12 +30,13 @@ jobs:
     needs: build
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install pnpm
         uses: pnpm/action-setup@v4
         with:
-          version: 9
-      - uses: actions/setup-node@v3
+          version: 10
+      - name: Use Node.js
+        uses: actions/setup-node@v4
         with:
           node-version: 20
           registry-url: https://registry.npmjs.org/
@@ -43,11 +45,7 @@ jobs:
         run: pnpm install --frozen-lock
       - name: Build the package
         run: pnpm build
-      - name: Move files
-        run: rm -r ./src && mv ./dist/src/* ./ && rm -r ./dist
-      - name: Edit package.json imports
-        run: sed -i 's#../../package.json#../package.json#' discordjs/index.js && sed -i 's#../../package.json#../package.json#' discordjs-light/index.js && sed -i 's#../../package.json#../package.json#' eris/index.js && sed -i 's#../../package.json#../package.json#' oceanic/index.js
       - name: Publish to NPM
-        run: pnpm publish --no-git-checks
+        run: pnpm publish --recursive --no-git-checks
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.gitignore

@@ -2,6 +2,7 @@
 
 node_modules
 dist
+coverage
 .idea
 
 # Files

.npmignore

@@ -1,6 +1,9 @@
 node_modules
 src
-dist/test
+test
+examples
+coverage
+tsconfig.json
+*.ts
 .idea
-.github
-test
+.github

README.md

@@ -1,110 +1,22 @@
 # Discord Analytics
 
-## Installing the package
+## Overview
+Discord Analytics is a powerful tool that allows you to track and analyze your Discord bot's performance and user engagement. This repository contains packages for different Discord libraries, including Discord.js, Eris, Oceanic.js, and Discord.js-light.
+These packages provide a simple and efficient way to integrate Discord Analytics into your bot, enabling you to gather valuable insights and improve your bot's functionality.
+
+## Installing the packages
+> **Note:** Use the package manager of your choice (npm, yarn, pnpm) to install the packages.
 
 ```bash
-npm install discord-analytics
+npm install @discordanalytics/core # Core package
+npm install @discordanalytics/discordjs # For Discord.js
+npm install @discordanalytics/discordjs-light # For Discord.js-light
+npm install @discordanalytics/eris # For Eris
+npm install @discordanalytics/oceanic # For Oceanic.js
 ```
 
 ## Usage
 
-> **Note:** To use Discord Analytics, you need to have an API token. Check the docs for more informations : https://docs.discordanalytics.xyz/get-started/bot-registration
-
-**With Discord.js:**
-
-```js
-// Import Discord.js's client and intents
-const { Client, IntentsBitField } = require("discord.js")
-// import discord-analytics
-const { default: DiscordAnalytics } = require("discord-analytics/discordjs")
-
-// Create Discord client
-const client = new Client({
-    intents: [IntentsBitField.Flags.Guilds] // This intent is required
-});
-
-// Create Discord Analytics instance
-// Don't forget to replace YOUR_API_TOKEN by your Discord Analytics token !
-const analytics = new DiscordAnalytics({
-    client: client,
-    apiToken: 'YOUR_API_TOKEN',
-    sharded: false // Set it to true if your bot use shards
-});
-
-// start tracking selected events
-analytics.trackEvents();
-
-// When Discord client is ready
-client.on('ready', () => {
-    console.log("Bot is ready!");
-});
-
-// Login to Discord
-// Don't forget to replace token by your Discord bot token !
-client.login('token');
-```
-
-**With Eris:**
-
-```js
-const {Client} = require("eris");
-const {default: DiscordAnalytics} = require("discord-analytics/eris");
-
-// Create Eris client.
-// Don't forget to replace token by your Discord bot token !
-const bot = new Client("token");
-
-bot.on("ready", () => {
-    // Create Discord Analytics instance
-    // Don't forget to replace YOUR_API_TOKEN by your Discord Analytics token !
-    const analytics = new DiscordAnalytics({
-        client: client,
-        apiToken: 'YOUR_API_TOKEN'
-    });
-
-    // start tracking selected events
-    analytics.trackEvents();
-
-    console.log("Ready!");
-});
-
-// Login to Discord
-bot.connect();
-```
-
-**With Oceanic.js:**
-```js
-// Import Discord.js's client and intents
-const { Client } = require("oceanic.js")
-// import discord-analytics
-const { default: DiscordAnalytics } = require("discord-analytics/oceanic")
-
-// Create Discord client
-const client = new Client({
-  auth: "Bot <YOUR_BOT_TOKEN>",
-  gateway: {
-    intents: ["GUILDS"] // This intent is required
-  }
-})
-
-// Create Discord Analytics instance
-// Don't forget to replace YOUR_API_TOKEN by your Discord Analytics token !
-const analytics = new DiscordAnalytics({
-  client: client,
-  apiToken: 'YOUR_API_TOKEN'
-});
-
-// start tracking selected events
-analytics.trackEvents();
-
-// When Discord client is ready
-client.on('ready', () => {
-  console.log("Bot is ready!");
-});
-
-// Login to Discord
-// Don't forget to replace token by your Discord bot token !
-client.login('token');
-```
+[Discord.js](./packages/discordjs/README.md) | [Discord.js-light](./packages/discordjs-light/README.md) | [Eris](./packages/eris/README.md) | [Oceanic.js](./packages/oceanic/README.md)
 
-> For advanced usages and updated docs, please check https://docs.discordanalytics.xyz/get-started/installation
+> For advanced usages and updated docs, please check https://discordanalytics.xyz/docs/main/get-started/advanced-usage

package.json

@@ -1,55 +1,30 @@
 {
   "name": "discord-analytics",
-  "version": "2.5.0",
-  "description": "A discord bot analytics to send your bot data",
-  "main": "dist/index.js",
+  "version": "0.0.0",
+  "author": "Discord Analytics",
+  "homepage": "https://discordanalytics.xyz",
+  "license": "MIT",
+  "private": true,
+  "workspaces": [
+    "packages/*"
+  ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "init": "tsc --init",
-    "test:djs": "nodemon src/test/discordjs/index.ts --dev",
-    "test:eris": "nodemon src/test/eris/index.ts --dev",
-    "test:oceanic": "nodemon src/test/oceanic/index.ts --dev",
-    "build": "tsc"
+    "build": "pnpm -r run build",
+    "test": "vitest",
+    "coverage": "vitest run --coverage"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/DiscordAnalytics/node-package.git"
   },
-  "keywords": [
-    "Javascript",
-    "Discord",
-    "Discord.js",
-    "Discord.js-Light",
-    "Eris",
-    "API",
-    "Analytics",
-    "Oceanic"
-  ],
-  "author": "Discord Analytics",
-  "license": "MIT",
   "bugs": {
     "url": "https://github.com/DiscordAnalytics/node-package/issues"
   },
-  "homepage": "https://discordanalytics.xyz",
   "devDependencies": {
-    "@types/node": "^20.17.11",
-    "@types/node-fetch": "^2.6.12",
-    "discord.js": "^14.17.2",
-    "discord.js-light": "^4.10.0",
-    "dotenv": "^16.4.7",
-    "eris": "^0.17.2",
-    "nodemon": "^3.1.9",
-    "oceanic.js": "^1.11.2",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.7.2"
-  },
-  "dependencies": {
-    "node-fetch": "^2.7.0"
-  },
-  "peerDependencies": {
-    "discord.js": "14.x",
-    "discord.js-light": "4.10.0",
-    "eris": ">=0.17.2",
-    "oceanic.js": ">= 1.11.0 < 1.12.0"
+    "@types/node": "^22.15.2",
+    "@vitest/coverage-v8": "3.1.2",
+    "dotenv": "^16.5.0",
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.2"
   }
 }

packages/core/README.md

@@ -0,0 +1,24 @@
+# Discord Analytics
+
+## Overview
+This package is a wrapper for the Discord Analytics API. It allows you to track events and send them to the Discord Analytics API.
+
+## Installation
+You can install the package using npm:
+
+```bash
+npm install @discordanalytics/core
+# or
+yarn add @discordanalytics/core
+# or
+pnpm add @discordanalytics/core
+```
+
+### Usage
+Discord Analytics core package is used by other packages like `@discordanalytics/discordjs`, `@discordanalytics/discordjs-light`, `@discordanalytics/eris`, and `@discordanalytics/oceanic`. You don't need to use this package directly unless you want to use the core features without any wrapper.
+
+## API
+### `AnalyticsBase`
+The main class of the package. It is used to track events and send them to the Discord Analytics API.
+### `CustomEvent`
+A class that represents a custom event. It is used to track custom events and send them to the Discord Analytics API.

packages/core/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@discordanalytics/core",
+  "version": "3.5.0",
+  "description": "Core package to work with Discord Analytics",
+  "main": "dist/index.js",
+  "author": "Discord Analytics",
+  "homepage": "https://discordanalytics.xyz",
+  "readme": "README.md",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/DiscordAnalytics/node-package.git"
+  },
+  "bugs": {
+    "url": "https://github.com/DiscordAnalytics/node-package/issues"
+  },
+  "scripts": {
+    "build": "tsc"
+  },
+  "dependencies": {
+    "node-fetch": "^2.7.0"
+  },
+  "devDependencies": {
+    "@types/node": "*",
+    "@types/node-fetch": "2.6.12",
+    "typescript": "*"
+  }
+}