@discordanalytics/discordjs 2.8.1 → 2.9.0

package/dist/index.d.ts

@@ -1,54 +0,0 @@
-import { AnalyticsBase, AnalyticsOptions } from '@discordanalytics/core';
-/**
- * @class DiscordAnalytics
- * @description The Discord.js class for the DiscordAnalytics library.
- * @param {AnalyticsOptions} options Configuration options.
- * @property {any} options.client The Discord.js client to track events for.
- * @property {string} options.api_key The API token for DiscordAnalytics.
- * @property {boolean} options.sharded Whether the Discord.js client is sharded.
- * @property {boolean} options.debug Enable or not the debug mode /!\ MUST BE USED ONLY FOR DEVELOPMENT PURPOSES /!\
- * @example
- * const { default: DiscordAnalytics } = require('discord-analytics/discordjs');
- * const { Client, IntentsBitField } = require('discord.js');
- * const client = new Client({
- *   intents: [IntentsBitField.Flags.Guilds]
- * })
- * client.on('ready', () => {
- *   const analytics = new DiscordAnalytics({
- *     client: client,
- *     api_key: 'YOUR_API_TOKEN'
- *   });
- *   analytics.init();
- *   analytics.trackEvents();
- * });
- * client.login('YOUR_BOT_TOKEN');
- * @link https://discordanalytics.xyz/docs/main/get-started/installation/discord.js Check docs for more informations about advanced usages
- */
-export default class DiscordAnalytics extends AnalyticsBase {
-    private readonly _client;
-    private readonly _sharded;
-    private _isReady;
-    constructor(options: AnalyticsOptions);
-    /**
-     * Initialize DiscordAnalytics on your bot
-     * /!\ Advanced users only
-     * /!\ Required to use DiscordAnalytics
-     * /!\ Must be used when the client is ready (recommended to use in ready event to prevent problems)
-     */
-    init(): Promise<void>;
-    /**
-     * Track interactions
-     * /!\ Advanced users only
-     * /!\ You need to initialize the class first
-     * @param interaction BaseInteraction class and its extensions only
-     * @param interactionNameResolver A function that will resolve the name of the interaction
-     */
-    trackInteractions(interaction: any, interactionNameResolver?: (interaction: any) => string): Promise<void>;
-    /**
-     * Let DiscordAnalytics declare the events necessary for its operation.
-     * /!\ Not recommended for big bots
-     * /!\ Not compatible with other functions
-     * @param interactionNameResolver A function that will resolve the name of the interaction
-     */
-    trackEvents(interactionNameResolver?: (interaction: any) => string): void;
-}

package/dist/index.js

@@ -1,175 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const core_1 = require("@discordanalytics/core");
-const package_json_1 = __importDefault(require("../package.json"));
-/**
- * @class DiscordAnalytics
- * @description The Discord.js class for the DiscordAnalytics library.
- * @param {AnalyticsOptions} options Configuration options.
- * @property {any} options.client The Discord.js client to track events for.
- * @property {string} options.api_key The API token for DiscordAnalytics.
- * @property {boolean} options.sharded Whether the Discord.js client is sharded.
- * @property {boolean} options.debug Enable or not the debug mode /!\ MUST BE USED ONLY FOR DEVELOPMENT PURPOSES /!\
- * @example
- * const { default: DiscordAnalytics } = require('discord-analytics/discordjs');
- * const { Client, IntentsBitField } = require('discord.js');
- * const client = new Client({
- *   intents: [IntentsBitField.Flags.Guilds]
- * })
- * client.on('ready', () => {
- *   const analytics = new DiscordAnalytics({
- *     client: client,
- *     api_key: 'YOUR_API_TOKEN'
- *   });
- *   analytics.init();
- *   analytics.trackEvents();
- * });
- * client.login('YOUR_BOT_TOKEN');
- * @link https://discordanalytics.xyz/docs/main/get-started/installation/discord.js Check docs for more informations about advanced usages
- */
-class DiscordAnalytics extends core_1.AnalyticsBase {
-    _client;
-    _sharded = false;
-    _isReady = false;
-    constructor(options) {
-        super(options.api_key, options.debug);
-        this._client = options.client;
-        this._sharded = options.sharded || false;
-    }
-    /**
-     * Initialize DiscordAnalytics on your bot
-     * /!\ Advanced users only
-     * /!\ Required to use DiscordAnalytics
-     * /!\ Must be used when the client is ready (recommended to use in ready event to prevent problems)
-     */
-    async init() {
-        if (process.env.NODE_ENV !== 'production')
-            return console.log("[DISCORDANALYTICS] NODE_ENV != 'production', initialization skipped");
-        const url = core_1.ApiEndpoints.EDIT_SETTINGS_URL.replace(':id', this._client.user.id);
-        const body = JSON.stringify({
-            username: this._client.user.username,
-            avatar: this._client.user.avatar,
-            framework: 'discord.js',
-            version: package_json_1.default.version,
-            team: this._client.application.owner
-                ? this._client.application.owner.hasOwnProperty('members')
-                    ? this._client.application.owner.members.map((member) => member.user.id)
-                    : [this._client.application.owner.id]
-                : [],
-        });
-        await this.api_call_with_retries('PATCH', url, body);
-        this.debug('[DISCORDANALYTICS] Instance successfully initialized');
-        this.client_id = this._client.user.id;
-        this._isReady = true;
-        const fast_mode = process.argv[2] === '--fast';
-        this.debug(`[DISCORDANALYTICS] Fast mode is ${fast_mode ? 'enabled' : 'disabled'}. Stats will be sent every ${fast_mode ? '30s' : '5min'}.`);
-        setInterval(async () => {
-            this.debug('[DISCORDANALYTICS] Sending stats...');
-            const guildCount = this._sharded
-                ? ((await this._client.shard?.broadcastEval((c) => c.guilds.cache.size))?.reduce((a, b) => a + b, 0) || 0)
-                : this._client.guilds.cache.size;
-            const userCount = this._sharded
-                ? ((await this._client.shard?.broadcastEval((c) => c.guilds.cache.reduce((a, g) => a + (g.memberCount || 0), 0)))?.reduce((a, b) => a + b, 0) || 0)
-                : this._client.guilds.cache.reduce((a, g) => a + (g.memberCount || 0), 0);
-            const userInstallCount = this._sharded
-                ? ((await this._client.shard?.broadcastEval((c) => c.approximateUserInstallCount))?.reduce((a, b) => a + b, 0) || 0)
-                : this._client.approximateUserInstallCount;
-            const guildMembers = !this._sharded
-                ? this._client.guilds.cache.map((guild) => guild.memberCount)
-                : ((await this._client.shard?.broadcastEval((c) => c.guilds.cache.map((guild) => guild.memberCount)))?.flat() ?? []);
-            let guildLocales = [];
-            this._client.guilds.cache.map((current) => guildLocales.find((x) => x.locale === current.preferredLocale) ?
-                ++guildLocales.find((x) => x.locale === current.preferredLocale).number :
-                guildLocales.push({ locale: current.preferredLocale, number: 1 }));
-            this.stats_data.guildsLocales = guildLocales;
-            await this.sendStats(this._client.user.id, guildCount, userCount, userInstallCount, guildMembers);
-        }, fast_mode ? 30000 : 300000);
-    }
-    /**
-     * Track interactions
-     * /!\ Advanced users only
-     * /!\ You need to initialize the class first
-     * @param interaction BaseInteraction class and its extensions only
-     * @param interactionNameResolver A function that will resolve the name of the interaction
-     */
-    async trackInteractions(interaction, interactionNameResolver) {
-        this.debug(`[DISCORDANALYTICS] trackInteractions(${interaction.type}) triggered`);
-        if (!this._isReady)
-            return this.error(core_1.ErrorCodes.INSTANCE_NOT_INITIALIZED);
-        this.updateOrInsert(this.stats_data.locales, (x) => x.locale === interaction.locale, (x) => x.number++, () => ({ locale: interaction.locale, number: 1 }));
-        if (interaction.type === core_1.InteractionType.ApplicationCommand) {
-            const commandType = interaction.command
-                ? interaction.command.type
-                : core_1.ApplicationCommandType.ChatInputCommand;
-            const commandName = interactionNameResolver
-                ? interactionNameResolver(interaction)
-                : interaction.commandName;
-            this.updateOrInsert(this.stats_data.interactions, (x) => x.name === commandName
-                && x.type === interaction.type
-                && x.command_type === commandType, (x) => x.number++, () => ({
-                name: commandName,
-                number: 1,
-                type: interaction.type,
-                command_type: commandType,
-            }));
-        }
-        else if (interaction.type === core_1.InteractionType.MessageComponent || interaction.type === core_1.InteractionType.ModalSubmit) {
-            const interactionName = interactionNameResolver
-                ? interactionNameResolver(interaction)
-                : interaction.customId;
-            this.updateOrInsert(this.stats_data.interactions, (x) => x.name === interactionName && x.type === interaction.type, (x) => x.number++, () => ({
-                name: interactionName,
-                number: 1,
-                type: interaction.type,
-            }));
-        }
-        this.updateOrInsert(this.stats_data.guildsStats, (x) => x.guildId === (interaction.guild ? interaction.guild.id : 'dm'), (x) => x.interactions++, () => ({
-            guildId: interaction.guild ? interaction.guild.id : 'dm',
-            name: interaction.guild ? interaction.guild.name : 'DM',
-            icon: interaction.guild && interaction.guild.icon ? interaction.guild.icon : undefined,
-            interactions: 1,
-            members: interaction.guild ? interaction.guild.memberCount : 0,
-        }));
-        const oneWeekAgo = new Date();
-        oneWeekAgo.setDate(oneWeekAgo.getDate() - 7);
-        if (!interaction.inGuild())
-            ++this.stats_data.users_type.private_message;
-        else if (interaction.member
-            && interaction.member.permissions
-            && interaction.member.permissions.has(8n)
-            || interaction.member.permissions.has(32n))
-            ++this.stats_data.users_type.admin;
-        else if (interaction.member
-            && interaction.member.permissions
-            && interaction.member.permissions.has(8192n)
-            || interaction.member.permissions.has(2n)
-            || interaction.member.permissions.has(4n)
-            || interaction.member.permissions.has(4194304n)
-            || interaction.member.permissions.has(8388608n)
-            || interaction.member.permissions.has(16777216n)
-            || interaction.member.permissions.has(1099511627776n))
-            ++this.stats_data.users_type.moderator;
-        else if (interaction.member
-            && interaction.member.joinedAt
-            && interaction.member.joinedAt > oneWeekAgo)
-            ++this.stats_data.users_type.new_member;
-    }
-    /**
-     * Let DiscordAnalytics declare the events necessary for its operation.
-     * /!\ Not recommended for big bots
-     * /!\ Not compatible with other functions
-     * @param interactionNameResolver A function that will resolve the name of the interaction
-     */
-    trackEvents(interactionNameResolver) {
-        this.debug('[DISCORDANALYTICS] trackEvents() triggered');
-        if (!this._isReady)
-            return this.error(core_1.ErrorCodes.INSTANCE_NOT_INITIALIZED);
-        this._client.on('interactionCreate', async (interaction) => await this.trackInteractions(interaction, interactionNameResolver));
-        this._client.on('guildCreate', (guild) => this.trackGuilds('create'));
-        this._client.on('guildDelete', (guild) => this.trackGuilds('delete'));
-    }
-}
-exports.default = DiscordAnalytics;