@discordanalytics/core 2.8.0 → 2.8.2

package/dist/index.d.ts

@@ -0,0 +1,136 @@
+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/types.d.ts

@@ -0,0 +1,56 @@
+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/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@discordanalytics/core",
-  "version": "2.8.0",
+  "version": "2.8.2",
   "description": "Core package to work with Discord Analytics",
+  "files": [
+    "dist"
+  ],
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "author": "Discord Analytics",
   "homepage": "https://discordanalytics.xyz",
   "readme": "README.md",