@discordanalytics/discordjs-light 2.8.0 → 2.8.2

package/dist/index.d.ts

@@ -0,0 +1,54 @@
+import { AnalyticsBase, AnalyticsOptions } from '@discordanalytics/core';
+/**
+ * @class DiscordAnalytics
+ * @description The Discord.js-light class for the DiscordAnalytics library.
+ * @param {AnalyticsOptions} options - Configuration options.
+ * @property {any} options.client The Discord.js-light client to track events for.
+ * @property {string} options.api_key The API token for DiscordAnalytics.
+ * @property {boolean} options.sharded Whether the Discord.js-light 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/discord.js-light');
+ * const { Client, IntentsBitField } = require('discord.js-light');
+ * const client = new Client({
+ *   intents: ['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/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@discordanalytics/discordjs-light",
-  "version": "2.8.0",
+  "version": "2.8.2",
   "description": "Discord.js light package for working with Discord Analytics",
+  "files": [
+    "dist"
+  ],
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "author": "Discord Analytics",
   "homepage": "https://discordanalytics.xyz",
   "readme": "README.md",
@@ -14,9 +18,7 @@
     "url": "https://github.com/DiscordAnalytics/node-package/issues"
   },
   "dependencies": {
-    "@types/node-fetch": "^2.6.13",
-    "node-fetch": "^2.7.0",
-    "@discordanalytics/core": "2.8.0"
+    "@discordanalytics/core": "2.8.2"
   },
   "devDependencies": {
     "discord.js-light": "^4.10.0",