discord-analytics
Version:
A discord bot analytics to send your bot data
242 lines (241 loc) • 10.7 kB
JavaScript
"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const types_1 = require("../utils/types");
const package_json_1 = __importDefault(require("../package.json"));
const node_fetch_1 = __importDefault(require("node-fetch"));
/**
* @class DiscordAnalytics
* @description The Eris class for the DiscordAnalytics library.
* @param {DiscordAnalyticsOptions} options - Configuration options.
* @property {any} options.client - The Eris client to track events for.
* @property {string} options.apiToken - The API token for DiscordAnalytics.
* @property {boolean} options.sharded - /!\ Not compatible with Eris
* @property {boolean} options.debug - Enable or not the debug mode /!\ MUST BE USED ONLY FOR DEVELOPMENT PURPOSES /!\
* @example
* const { default: DiscordAnalytics } = require('discord-analytics/eris');
* const Eris = require('eris');
* const client = new Client("YOUR_BOT_TOKEN", {
* intents: ["guilds"]
* })
* client.on('ready', () => {
* const analytics = new DiscordAnalytics({
* client: client,
* apiToken: 'YOUR_API_TOKEN'
* });
* analytics.trackEvents();
* });
* client.connect()
*
* // Check docs for more informations about advanced usages : https://docs.discordanalytics.xyz/get-started/installation/eris
*/
class DiscordAnalytics {
_client;
_apiToken;
_sharded = false;
_debug;
_headers;
_isReady;
constructor(options) {
this._client = options.client;
this._apiToken = options.apiToken;
this._headers = {
'Content-Type': 'application/json',
'Authorization': `Bot ${this._apiToken}`
};
this._isReady = false;
this._debug = options.debug || false;
}
/**
* Initialize DiscordAnalytics on your bot
* /!\ Advanced users only
* /!\ Required to use DiscordAnalytics (except if you use the trackEvents function)
* /!\ Must be used when the client is ready (recommended to use in ready event to prevent problems)
*/
async init() {
(0, node_fetch_1.default)(`${types_1.ApiEndpoints.BASE_URL}${types_1.ApiEndpoints.EDIT_SETTINGS_URL.replace(':id', this._client.user.id)}`, {
headers: this._headers,
body: JSON.stringify({
username: this._client.user.username,
avatar: this._client.user.avatar,
framework: "eris",
version: package_json_1.default.version,
}),
method: "PATCH"
}).then(async (res) => {
if (res.status === 401)
return console.error(types_1.ErrorCodes.INVALID_API_TOKEN);
else if (res.status === 423)
return console.error(types_1.ErrorCodes.SUSPENDED_BOT);
else if (res.status !== 200)
return console.error(types_1.ErrorCodes.INVALID_RESPONSE);
if (this._debug)
console.debug("[DISCORDANALYTICS] Instance successfully initialized");
this._isReady = true;
if (this._debug) {
if (process.argv[2] === "--dev")
console.debug("[DISCORDANALYTICS] DevMode is enabled. Stats will be sent every 30s.");
else
console.debug("[DISCORDANALYTICS] DevMode is disabled. Stats will be sent every 5min.");
}
setInterval(async () => {
if (this._debug)
console.debug("[DISCORDANALYTICS] Sending stats...");
let guildCount = this._client.guilds.size;
let userCount = this._client.guilds.reduce((a, g) => a + g.memberCount, 0);
(0, node_fetch_1.default)(`${types_1.ApiEndpoints.BASE_URL}${types_1.ApiEndpoints.EDIT_STATS_URL.replace(':id', this._client.user.id)}`, {
headers: this._headers,
body: JSON.stringify(this.statsData),
method: "POST"
}).then(async (res) => {
if (res.status === 401)
return console.error(types_1.ErrorCodes.INVALID_API_TOKEN);
else if (res.status === 423)
return console.error(types_1.ErrorCodes.SUSPENDED_BOT);
else if (res.status !== 200)
return console.error(types_1.ErrorCodes.INVALID_RESPONSE);
if (res.status === 200) {
if (this._debug)
console.debug(`[DISCORDANALYTICS] Stats ${JSON.stringify(this.statsData)} sent to the API`);
this.statsData = {
date: new Date().toISOString().slice(0, 10),
guilds: guildCount,
users: userCount,
interactions: [],
locales: [],
guildsLocales: [],
guildMembers: await this.calculateGuildMembersRepartition(),
guildsStats: [],
addedGuilds: 0,
removedGuilds: 0,
users_type: {
admin: 0,
moderator: 0,
new_member: 0,
other: 0,
private_message: 0
}
};
}
}).catch(e => {
if (this._debug) {
console.debug("[DISCORDANALYTICS] " + types_1.ErrorCodes.DATA_NOT_SENT);
console.error(e);
}
});
}, process.argv[2] === "--dev" ? 30000 : 5 * 60000);
});
}
statsData = {
date: new Date().toISOString().slice(0, 10),
guilds: 0,
users: 0,
interactions: [],
locales: [],
guildsLocales: [],
guildMembers: {
little: 0,
medium: 0,
big: 0,
huge: 0
},
guildsStats: [],
addedGuilds: 0,
removedGuilds: 0,
users_type: {
admin: 0,
moderator: 0,
new_member: 0,
other: 0,
private_message: 0
}
};
async calculateGuildMembersRepartition() {
const res = {
little: 0,
medium: 0,
big: 0,
huge: 0
};
let guildsMembers = this._client.guilds.map((guild) => guild.memberCount);
for (const guild of guildsMembers) {
if (guild <= 100)
res.little++;
else if (guild > 100 && guild <= 500)
res.medium++;
else if (guild > 500 && guild <= 1500)
res.big++;
else if (guild > 1500)
res.huge++;
}
return res;
}
/**
* Track interactions
* /!\ Advanced users only
* /!\ You need to initialize the class first
* @param interaction - BaseInteraction class and its extensions only
*/
async trackInteractions(interaction) {
if (this._debug)
console.log("[DISCORDANALYTICS] trackInteractions() triggered");
if (!this._isReady)
throw new Error(types_1.ErrorCodes.INSTANCE_NOT_INITIALIZED);
let guilds = [];
this._client.guilds.map((current) => guilds.find((x) => x.locale === current.preferredLocale) ?
++guilds.find((x) => x.locale === current.preferredLocale).number :
guilds.push({ locale: current.preferredLocale, number: 1 }));
this.statsData.guildsLocales = guilds;
if (interaction.type === 2)
this.statsData.interactions.find((x) => x.name === interaction.data.name && x.type === interaction.type) ?
++this.statsData.interactions.find((x) => x.name === interaction.data.name && x.type === interaction.type).number :
this.statsData.interactions.push({ name: interaction.data.name, number: 1, type: interaction.type });
else if (interaction.type === 3)
this.statsData.interactions.find((x) => x.name === interaction.data.custom_id && x.type === interaction.type) ?
++this.statsData.interactions.find((x) => x.name === interaction.data.custom_id && x.type === interaction.type).number :
this.statsData.interactions.push({ name: interaction.data.custom_id, number: 1, type: interaction.type });
const guildData = this.statsData.guildsStats.find(guild => interaction.guildID ? guild.guildId === interaction.guildID : guild.guildId === "dm");
if (guildData)
this.statsData.guildsStats = this.statsData.guildsStats.filter(guild => guild.guildId === guildData.guildId);
const guild = this._client.guilds.get(interaction.guildID);
this.statsData.guildsStats.push({
guildId: interaction.guildID || "dm",
name: guild ? guild.name : "DM",
icon: guild && guild.icon ? guild.icon : undefined,
interactions: guildData ? guildData.interactions + 1 : 1,
members: guild ? guild.memberCount : 0
});
}
/**
* Track guilds
* /!\ Advanced users only
* /!\ You need to initialize the class first
* @param guild - The Guild instance only
* @param {TrackGuildType} type - "create" if the event is guildCreate and "delete" if is guildDelete
*/
async trackGuilds(guild, type) {
if (this._debug)
console.log(`[DISCORDANALYTICS] trackGuilds(${type}) triggered`);
if (type === "create")
this.statsData.addedGuilds++;
else
this.statsData.removedGuilds++;
}
/**
* Let DiscordAnalytics declare the events necessary for its operation.
* /!\ Not recommended for big bots
* /!\ Not compatible with other functions
*/
trackEvents() {
if (!this._client.ready)
this._client.on("ready", async () => await this.init());
else
this.init();
this._client.on("interactionCreate", async (interaction) => await this.trackInteractions(interaction));
this._client.on("guildCreate", (guild) => this.trackGuilds(guild, "create"));
this._client.on("guildDelete", (guild) => this.trackGuilds(guild, "delete"));
}
}
exports.default = DiscordAnalytics;