@discordanalytics/core 2.8.2 → 2.9.0

package/dist/index.d.ts

@@ -1,136 +0,0 @@
-import { GuildsStatsData, InteractionData, LocaleData, TrackGuildType } from './types';
-/**
- * DiscordAnalytics Base Class
- * @class AnalyticsBase
- * @description Base class for DiscordAnalytics
- * @param {string} api_key The API key for DiscordAnalytics
- * @param {boolean} debug Optional flag to enable debug mode /!\ MUST BE USED ONLY FOR DEBUGGING PURPOSES
- * @returns {AnalyticsBase} An instance of the AnalyticsBase class
- * @example
- * const analytics = new AnalyticsBase('YOUR_API_KEY');
- * analytics.sendStats('YOUR_CLIENT_ID', 0, 0);
- */
-export declare class AnalyticsBase {
-    private readonly _api_key;
-    private readonly _headers;
-    private readonly debug_mode;
-    stats_data: {
-        date: string;
-        guilds: number;
-        users: number;
-        interactions: InteractionData[];
-        locales: LocaleData[];
-        guildsLocales: LocaleData[];
-        guildMembers: {
-            little: number;
-            medium: number;
-            big: number;
-            huge: number;
-        };
-        guildsStats: GuildsStatsData[];
-        addedGuilds: number;
-        removedGuilds: number;
-        users_type: {
-            admin: number;
-            moderator: number;
-            new_member: number;
-            other: number;
-            private_message: number;
-        };
-        custom_events: Record<string, number>;
-        user_install_count: number;
-    };
-    client_id: string;
-    constructor(api_key: string, debug?: boolean);
-    debug(...args: any[]): void;
-    error(content: any, exit?: boolean): void;
-    /**
-     * Custom events
-     * /!\ Advanced users only
-     * /!\ You need to initialize the class first
-     * @param event_key The event key to track
-     * @returns {CustomEvent} The CustomEvent instance
-     * @example
-     * const event = analytics.events('my_custom_event');
-     * event.increment(1);
-     * event.decrement(1);
-     * event.set(10);
-     */
-    events(event_key: string): CustomEvent;
-    updateOrInsert<T>(array: T[], match: (item: T) => boolean, update: (item: T) => void, insert: () => T): void;
-    calculateGuildMembers(guildMembers: number[]): {
-        little: number;
-        medium: number;
-        big: number;
-        huge: number;
-    };
-    /**
-     * Track guilds
-     * /!\ Advanced users only
-     * /!\ You need to initialize the class first
-     * @param {TrackGuildType} type 'create' if the event is guildCreate and 'delete' if is guildDelete
-     */
-    trackGuilds(type: TrackGuildType): void;
-    /**
-     * API call with retries
-     * @param method The HTTP method to use (GET, POST, PUT, DELETE)
-     * @param url The URL to call
-     * @param body The body to send (optional)
-     * @param max_retries The maximum number of retries (default: 5)
-     * @param backoff_factor The backoff factor to use (default: 0.5)
-     * @returns {Promise<void | Response>} The response from the API
-     */
-    api_call_with_retries(method: string, url: string, body?: string, max_retries?: number, backoff_factor?: number): Promise<void | Response>;
-    /**
-     * Send stats to the API
-     * @param client_id The client ID of the bot
-     * @param guild_count The number of guilds the bot is in (default: 0)
-     * @param user_count The number of users the bot is in (default: 0)
-     * @param user_install_count The number of user installs (default: 0)
-     * @param guild_members The number of members in each guild (optional)
-     * @returns {Promise<void>} A promise that resolves when the stats are sent
-     */
-    sendStats(client_id: string, guild_count?: number, user_count?: number, user_install_count?: number, guild_members?: number[]): Promise<void>;
-}
-/**
- * CustomEvent class
- * @class CustomEvent
- * @description Class for custom events
- * @param {AnalyticsBase} analytics The AnalyticsBase instance
- * @param {string} event_key The event key to track
- * @returns {CustomEvent} An instance of the CustomEvent class
- * @example
- * const event = analytics.events('my_custom_event');
- * event.increment(1);
- * event.decrement(1);
- * event.set(10);
- * event.get();
- */
-export declare class CustomEvent {
-    private readonly _analytics;
-    private readonly _event_key;
-    private _last_action;
-    constructor(analytics: AnalyticsBase, event_key: string);
-    private ensure;
-    /**
-     * Increment the event by a value
-     * @param value The value to increment the event by (default: 1)
-     */
-    increment(value?: number): void;
-    /**
-     * Decrement the event by a value
-     * @param value The value to decrement the event by (default: 1)
-     */
-    decrement(value?: number): void;
-    /**
-     * Set the event to a value
-     * @param value The value to set the event to
-     */
-    set(value: number): void;
-    /**
-     * Get the event value
-     * @returns {number} The event value
-     */
-    get(): number;
-}
-export * from './types';

package/dist/index.js

@@ -1,293 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomEvent = exports.AnalyticsBase = void 0;
-const types_1 = require("./types");
-/**
- * DiscordAnalytics Base Class
- * @class AnalyticsBase
- * @description Base class for DiscordAnalytics
- * @param {string} api_key The API key for DiscordAnalytics
- * @param {boolean} debug Optional flag to enable debug mode /!\ MUST BE USED ONLY FOR DEBUGGING PURPOSES
- * @returns {AnalyticsBase} An instance of the AnalyticsBase class
- * @example
- * const analytics = new AnalyticsBase('YOUR_API_KEY');
- * analytics.sendStats('YOUR_CLIENT_ID', 0, 0);
- */
-class AnalyticsBase {
-    _api_key;
-    _headers;
-    debug_mode = false;
-    stats_data = {
-        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,
-        },
-        custom_events: {},
-        user_install_count: 0,
-    };
-    client_id = '';
-    constructor(api_key, debug = false) {
-        this._api_key = api_key;
-        this.debug_mode = debug;
-        this._headers = {
-            'Content-Type': 'application/json',
-            Authorization: `Bot ${this._api_key}`,
-        };
-    }
-    debug(...args) {
-        if (this.debug_mode)
-            console.debug(...args);
-    }
-    error(content, exit = false) {
-        console.error(content);
-        if (exit)
-            process.exit(1);
-    }
-    /**
-     * Custom events
-     * /!\ Advanced users only
-     * /!\ You need to initialize the class first
-     * @param event_key The event key to track
-     * @returns {CustomEvent} The CustomEvent instance
-     * @example
-     * const event = analytics.events('my_custom_event');
-     * event.increment(1);
-     * event.decrement(1);
-     * event.set(10);
-     */
-    events(event_key) {
-        this.debug(`[DISCORDANALYTICS] Getting event ${event_key}`);
-        if (typeof event_key !== 'string')
-            throw new Error(`[DISCORDANALYTICS] ${types_1.ErrorCodes.INVALID_VALUE_TYPE}`);
-        return new CustomEvent(this, event_key);
-    }
-    updateOrInsert(array, match, update, insert) {
-        const item = array.find(match);
-        if (item)
-            update(item);
-        else
-            array.push(insert());
-    }
-    calculateGuildMembers(guildMembers) {
-        return guildMembers.reduce((acc, count) => {
-            if (count <= 100)
-                acc.little++;
-            else if (count <= 500)
-                acc.medium++;
-            else if (count <= 1500)
-                acc.big++;
-            else
-                acc.huge++;
-            return acc;
-        }, { little: 0, medium: 0, big: 0, huge: 0 });
-    }
-    /**
-     * Track guilds
-     * /!\ Advanced users only
-     * /!\ You need to initialize the class first
-     * @param {TrackGuildType} type 'create' if the event is guildCreate and 'delete' if is guildDelete
-     */
-    trackGuilds(type) {
-        this.debug(`[DISCORDANALYTICS] trackGuilds(${type}) triggered`);
-        if (type === 'create')
-            this.stats_data.addedGuilds++;
-        else
-            this.stats_data.removedGuilds++;
-    }
-    /**
-     * API call with retries
-     * @param method The HTTP method to use (GET, POST, PUT, DELETE)
-     * @param url The URL to call
-     * @param body The body to send (optional)
-     * @param max_retries The maximum number of retries (default: 5)
-     * @param backoff_factor The backoff factor to use (default: 0.5)
-     * @returns {Promise<void | Response>} The response from the API
-     */
-    async api_call_with_retries(method, url, body, max_retries = 5, backoff_factor = 0.5) {
-        let retries = 0;
-        let response;
-        while (retries < max_retries) {
-            try {
-                response = await fetch(url, {
-                    method,
-                    headers: this._headers,
-                    body,
-                });
-                if (response.ok)
-                    return response;
-                else if (response.status === 401)
-                    return this.error(`[DISCORDANALYTICS] ${types_1.ErrorCodes.INVALID_API_TOKEN}`);
-                else if (response.status === 423)
-                    return this.error(`[DISCORDANALYTICS] ${types_1.ErrorCodes.SUSPENDED_BOT}`);
-                else if (response.status === 404 && url.includes('events'))
-                    return this.error(`[DISCORDANALYTICS] ${types_1.ErrorCodes.INVALID_EVENT_KEY}`, true);
-                else if (response.status !== 200)
-                    return this.error(`[DISCORDANALYTICS] ${types_1.ErrorCodes.INVALID_RESPONSE}`);
-            }
-            catch (error) {
-                retries++;
-                const retry_after = Math.pow(2, retries) * backoff_factor;
-                this.error(`[DISCORDANALYTICS] Error: ${error}. Retrying in ${retry_after} seconds...`);
-                if (retries >= max_retries)
-                    return this.error(`[DISCORDANALYTICS] ${types_1.ErrorCodes.MAX_RETRIES_EXCEEDED}`);
-                await new Promise((resolve) => setTimeout(resolve, retry_after * 1000));
-            }
-        }
-    }
-    /**
-     * Send stats to the API
-     * @param client_id The client ID of the bot
-     * @param guild_count The number of guilds the bot is in (default: 0)
-     * @param user_count The number of users the bot is in (default: 0)
-     * @param user_install_count The number of user installs (default: 0)
-     * @param guild_members The number of members in each guild (optional)
-     * @returns {Promise<void>} A promise that resolves when the stats are sent
-     */
-    async sendStats(client_id, guild_count = 0, user_count = 0, user_install_count = 0, guild_members = []) {
-        this.debug('[DISCORDANALYTICS] Sending stats...');
-        const url = types_1.ApiEndpoints.EDIT_STATS_URL.replace(':id', client_id);
-        const body = JSON.stringify(this.stats_data);
-        await this.api_call_with_retries('POST', url, body);
-        this.debug('[DISCORDANALYTICS] Stats sent to the API', body);
-        this.stats_data = {
-            date: new Date().toISOString().slice(0, 10),
-            guilds: guild_count,
-            users: user_count,
-            interactions: [],
-            locales: [],
-            guildsLocales: [],
-            guildMembers: this.calculateGuildMembers(guild_members),
-            guildsStats: [],
-            addedGuilds: 0,
-            removedGuilds: 0,
-            users_type: {
-                admin: 0,
-                moderator: 0,
-                new_member: 0,
-                other: 0,
-                private_message: 0,
-            },
-            custom_events: this.stats_data.custom_events,
-            user_install_count,
-        };
-    }
-}
-exports.AnalyticsBase = AnalyticsBase;
-/**
- * CustomEvent class
- * @class CustomEvent
- * @description Class for custom events
- * @param {AnalyticsBase} analytics The AnalyticsBase instance
- * @param {string} event_key The event key to track
- * @returns {CustomEvent} An instance of the CustomEvent class
- * @example
- * const event = analytics.events('my_custom_event');
- * event.increment(1);
- * event.decrement(1);
- * event.set(10);
- * event.get();
- */
-class CustomEvent {
-    _analytics;
-    _event_key;
-    _last_action;
-    constructor(analytics, event_key) {
-        this._analytics = analytics;
-        this._event_key = event_key;
-        this._last_action = "";
-        this.ensure();
-    }
-    async ensure() {
-        if (typeof this._analytics.stats_data.custom_events[this._event_key] !== 'number' && process.env.NODE_ENV === 'production') {
-            this._analytics.debug(`[DISCORDANALYTICS] Fetching value for event ${this._event_key}`);
-            const url = types_1.ApiEndpoints.EVENT_URL.replace(':id', this._analytics.client_id).replace(':event', this._event_key);
-            const res = await this._analytics.api_call_with_retries('GET', url);
-            if (res instanceof Response && this._last_action !== 'set') {
-                const data = await res.json();
-                this._analytics.stats_data.custom_events[this._event_key] = (this._analytics.stats_data.custom_events[this._event_key] || 0) + (data.today_value || 0);
-            }
-            this._analytics.debug(`[DISCORDANALYTICS] Value fetched for event ${this._event_key}`);
-        }
-    }
-    /**
-     * Increment the event by a value
-     * @param value The value to increment the event by (default: 1)
-     */
-    increment(value = 1) {
-        this._analytics.debug(`[DISCORDANALYTICS] Incrementing event ${this._event_key} by ${value}`);
-        if (typeof value !== 'number')
-            throw new Error(`[DISCORDANALYTICS] ${types_1.ErrorCodes.INVALID_VALUE_TYPE}`);
-        if (value < 0)
-            throw new Error(`[DISCORDANALYTICS] ${types_1.ErrorCodes.INVALID_EVENTS_COUNT}`);
-        this._analytics.stats_data.custom_events[this._event_key] = (this._analytics.stats_data.custom_events[this._event_key] || 0) + value;
-        this._last_action = 'increment';
-    }
-    /**
-     * Decrement the event by a value
-     * @param value The value to decrement the event by (default: 1)
-     */
-    decrement(value = 1) {
-        this._analytics.debug(`[DISCORDANALYTICS] Decrementing event ${this._event_key} by ${value}`);
-        if (typeof value !== 'number')
-            throw new Error(`[DISCORDANALYTICS] ${types_1.ErrorCodes.INVALID_VALUE_TYPE}`);
-        if (value < 0 || this.get() - value < 0)
-            throw new Error(`[DISCORDANALYTICS] ${types_1.ErrorCodes.INVALID_EVENTS_COUNT}`);
-        this._analytics.stats_data.custom_events[this._event_key] -= value;
-        this._last_action = 'decrement';
-    }
-    /**
-     * Set the event to a value
-     * @param value The value to set the event to
-     */
-    set(value) {
-        this._analytics.debug(`[DISCORDANALYTICS] Setting event ${this._event_key} to ${value}`);
-        if (typeof value !== 'number')
-            throw new Error(`[DISCORDANALYTICS] ${types_1.ErrorCodes.INVALID_VALUE_TYPE}`);
-        if (value < 0)
-            throw new Error(`[DISCORDANALYTICS] ${types_1.ErrorCodes.INVALID_EVENTS_COUNT}`);
-        this._analytics.stats_data.custom_events[this._event_key] = value;
-        this._last_action = 'set';
-    }
-    /**
-     * Get the event value
-     * @returns {number} The event value
-     */
-    get() {
-        this._analytics.debug(`[DISCORDANALYTICS] Getting event ${this._event_key}`);
-        return this._analytics.stats_data.custom_events[this._event_key];
-    }
-}
-exports.CustomEvent = CustomEvent;
-__exportStar(require("./types"), exports);

package/dist/types.d.ts

@@ -1,56 +0,0 @@
-export declare const api_url = "https://discordanalytics.xyz/api";
-export declare const ApiEndpoints: {
-    EDIT_SETTINGS_URL: string;
-    EDIT_STATS_URL: string;
-    EVENT_URL: string;
-};
-export declare const ErrorCodes: {
-    INVALID_CLIENT_TYPE: string;
-    CLIENT_NOT_READY: string;
-    INVALID_RESPONSE: string;
-    INVALID_API_TOKEN: string;
-    DATA_NOT_SENT: string;
-    SUSPENDED_BOT: string;
-    INSTANCE_NOT_INITIALIZED: string;
-    INVALID_EVENTS_COUNT: string;
-    INVALID_VALUE_TYPE: string;
-    INVALID_EVENT_KEY: string;
-    MAX_RETRIES_EXCEEDED: string;
-};
-export type Locale = 'id' | 'en-US' | 'en-GB' | 'bg' | 'zh-CN' | 'zh-TW' | 'hr' | 'cs' | 'da' | 'nl' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'it' | 'ja' | 'ko' | 'lt' | 'no' | 'pl' | 'pt-BR' | 'ro' | 'ru' | 'es-ES' | 'sv-SE' | 'th' | 'tr' | 'uk' | 'vi';
-export declare enum InteractionType {
-    Ping = 1,
-    ApplicationCommand = 2,
-    MessageComponent = 3,
-    ApplicationCommandAutocomplete = 4,
-    ModalSubmit = 5
-}
-export declare enum ApplicationCommandType {
-    ChatInputCommand = 1,
-    UserCommand = 2,
-    MessageCommand = 3
-}
-export interface InteractionData {
-    name: string;
-    number: number;
-    type: InteractionType;
-    command_type?: ApplicationCommandType;
-}
-export interface LocaleData {
-    locale: Locale;
-    number: number;
-}
-export interface GuildsStatsData {
-    guildId: string;
-    name: string;
-    icon: string | null;
-    members: number;
-    interactions: number;
-}
-export interface AnalyticsOptions {
-    client: any;
-    api_key: string;
-    sharded?: boolean;
-    debug?: boolean;
-}
-export type TrackGuildType = 'create' | 'delete';

package/dist/types.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApplicationCommandType = exports.InteractionType = exports.ErrorCodes = exports.ApiEndpoints = exports.api_url = void 0;
-exports.api_url = 'https://discordanalytics.xyz/api';
-exports.ApiEndpoints = {
-    EDIT_SETTINGS_URL: `${exports.api_url}/bots/:id`,
-    EDIT_STATS_URL: `${exports.api_url}/bots/:id/stats`,
-    EVENT_URL: `${exports.api_url}/bots/:id/events/:event`,
-};
-exports.ErrorCodes = {
-    INVALID_CLIENT_TYPE: 'Invalid client type, please use a valid client.',
-    CLIENT_NOT_READY: 'Client is not ready, please start the client first.',
-    INVALID_RESPONSE: 'Invalid response from the API, please try again later.',
-    INVALID_API_TOKEN: 'Invalid API token, please get one at ' + exports.api_url.split('/api')[0] + ' and try again.',
-    DATA_NOT_SENT: 'Data cannot be sent to the API, I will try again in a minute.',
-    SUSPENDED_BOT: 'Your bot has been suspended, please check your mailbox for more information.',
-    INSTANCE_NOT_INITIALIZED: 'It seem that you didn\'t initialize your instance. Please check the docs for more informations.',
-    INVALID_EVENTS_COUNT: 'invalid events count',
-    INVALID_VALUE_TYPE: 'invalid value type',
-    INVALID_EVENT_KEY: 'invalid event key',
-    MAX_RETRIES_EXCEEDED: 'Max retries exceeded, please check your network connection or the API status.',
-};
-var InteractionType;
-(function (InteractionType) {
-    InteractionType[InteractionType["Ping"] = 1] = "Ping";
-    InteractionType[InteractionType["ApplicationCommand"] = 2] = "ApplicationCommand";
-    InteractionType[InteractionType["MessageComponent"] = 3] = "MessageComponent";
-    InteractionType[InteractionType["ApplicationCommandAutocomplete"] = 4] = "ApplicationCommandAutocomplete";
-    InteractionType[InteractionType["ModalSubmit"] = 5] = "ModalSubmit";
-})(InteractionType || (exports.InteractionType = InteractionType = {}));
-var ApplicationCommandType;
-(function (ApplicationCommandType) {
-    ApplicationCommandType[ApplicationCommandType["ChatInputCommand"] = 1] = "ChatInputCommand";
-    ApplicationCommandType[ApplicationCommandType["UserCommand"] = 2] = "UserCommand";
-    ApplicationCommandType[ApplicationCommandType["MessageCommand"] = 3] = "MessageCommand";
-})(ApplicationCommandType || (exports.ApplicationCommandType = ApplicationCommandType = {}));