discordthings-api 1.1.0 → 1.1.2

package/README.md

@@ -1,7 +1,19 @@
 # DiscordThings API Wrapper
 
-Official NPM package for interacting with the **DiscordThings.com** API.  
-Easily post bot stats and check user votes.
+[![npm version](https://img.shields.io/npm/v/discordthings-api.svg)](https://www.npmjs.com/package/discordthings-api)
+[![license](https://img.shields.io/npm/l/discordthings-api.svg)](https://github.com/wdiscordthings/discordthings-api/blob/master/LICENSE)
+[![Discord](https://img.shields.io/discord/1324151706698682419?color=7289da&label=Discord&logo=discord)](https://discord.gg/discordthings)
+
+The official Node.js library for interacting with the [DiscordThings.com](https://discordthings.com) API. Efficiently manage your bot's stats, synchronize slash commands, and verify user votes with a modern, promise-based wrapper.
+
+---
+
+## Features
+
+- **Post Stats**: Keep your bot's server and shard count up to date.
+- **Vote Verification**: Reward your users by checking if they've voted for your bot.
+- **Command Sync**: Push your bot's Slash Commands directly to our platform for better visibility.
+- **Lightweight**: Zero dependencies (only `axios`).
 
 ## Installation
 
@@ -9,57 +21,92 @@ Easily post bot stats and check user votes.
 npm install discordthings-api
 ```
 
-## Usage
+## Quick Start
 
-First, get your **API Token** from your User Profile on DiscordThings.
+First, obtain your **API Token** from your [Developer Profile](https://discordthings.com/dashboard) on DiscordThings.
 
 ```javascript
 const DiscordThings = require('discordthings-api');
 
-// Initialize with your User API Token
-const dthings = new DiscordThings('YOUR_API_TOKEN');
+// Initialize the client
+const dthings = new DiscordThings('YOUR_USER_API_TOKEN');
 
-const BOT_ID = 'YOUR_BOT_ID';
+const BOT_ID = '123456789012345678'; // Your Bot ID
+```
 
-async function syncStats() {
+### 1. Update Server Count
+```javascript
+async function updateStats() {
     try {
-        // Post Server Count (and optional Shard Count)
-        await dthings.postStats(BOT_ID, 1500, 2);
-        console.log('Stats posted successfully!');
-    } catch (error) {
-        console.error('Failed to post stats:', error.message);
+        await dthings.postStats(BOT_ID, 1250);
+        console.log('Stats updated on DiscordThings!');
+    } catch (err) {
+        console.error('Error updating stats:', err.message);
     }
 }
+```
 
-async function handleVoteCheck(userId) {
+### 2. Verify Votes
+```javascript
+async function checkVote(userId) {
     try {
-        // Check if a user voted
         const result = await dthings.checkVote(BOT_ID, userId);
         
         if (result.voted) {
-            console.log(`User ${userId} has voted!`);
-            console.log(`Next vote allowed at: ${result.nextVote}`);
+            console.log('User has voted!');
         } else {
-            console.log(`User ${userId} has not voted yet.`);
+            console.log('User hasn\'t voted in the last 12 hours.');
         }
-    } catch (error) {
-        console.error('Error checking vote:', error.message);
+    } catch (err) {
+        console.error('Error checking vote:', err.message);
     }
 }
+```
 
-syncStats();
+### 3. Sync Slash Commands
+```javascript
+async function syncCommands() {
+    const commands = [
+        {
+            name: 'ping',
+            description: 'Check bot latency',
+            type: 1 // Chat Input
+        },
+        {
+            name: 'help',
+            description: 'Get list of commands',
+            options: [{ name: 'cmd', description: 'Command to check', type: 3 }]
+        }
+    ];
+
+    try {
+        await dthings.syncCommands(BOT_ID, commands);
+        console.log('Commands synced successfully!');
+    } catch (err) {
+        console.error('Sync failed:', err.message);
+    }
+}
 ```
 
-## Methods
+## API Reference
 
-### `constructor(token, options?)`
-- `token`: Your API Token from the dashboard.
-- `options.baseUrl`: Optional (default: `https://discordthings.com/api`).
+### `new DiscordThings(token, [options])`
+- `token` (String): Your personal API Token.
+- `options.baseUrl` (String): Override default API endpoint.
 
-### `postStats(botId, serverCount, shardCount?)`
-- Updates the server and shard count for the specified bot.
-- **Note:** You must be the owner of the bot associated with the API Token.
+### `postStats(botId, serverCount, [shardCount])`
+- Updates the bot's server and shard presence.
+- Returns `Promise<Object>`.
 
 ### `checkVote(botId, userId)`
-- Checks if a specific user has voted for the bot in the last 12 hours.
-- Returns: `{ voted: boolean, lastVote: Date|null, nextVote: Date|null }`.
+- Checks for a valid vote cast within the last 12 hours.
+- Returns `Promise<{ voted: Boolean, lastVote: Date, nextVote: Date }>`.
+
+### `syncCommands(botId, commands)`
+- Synchronizes your bot's command list with the platform.
+- `commands`: Array of Command Objects (name, description, options, type).
+- Returns `Promise<Object>`.
+
+---
+
+Built with love by the [DiscordThings](https://discordthings.com) Team.

package/dist/index.d.ts

@@ -0,0 +1,57 @@
+export interface DiscordThingsOptions {
+    baseUrl?: string;
+}
+export interface VoteResult {
+    voted: boolean;
+    lastVote: string | null;
+    nextVote: string | null;
+}
+export interface CommandOption {
+    name: string;
+    description: string;
+    type: number;
+    required?: boolean;
+    choices?: {
+        name: string;
+        value: string | number;
+    }[];
+    options?: CommandOption[];
+}
+export interface Command {
+    name: string;
+    description: string;
+    type?: number;
+    options?: CommandOption[];
+}
+export declare class DiscordThings {
+    private client;
+    /**
+     * @param {string} token - Your User API Token
+     * @param {DiscordThingsOptions} [options] - Configuration options
+     */
+    constructor(token: string, options?: DiscordThingsOptions);
+    /**
+     * Post bot statistics to DiscordThings
+     * @param {string} botId - The ID of the bot
+     * @param {number} serverCount - Total number of servers the bot is in
+     * @param {number} [shardCount] - Total number of shards (optional)
+     * @returns {Promise<any>} API Response
+     */
+    postStats(botId: string, serverCount: number, shardCount?: number): Promise<any>;
+    /**
+     * Check if a user has voted for the bot
+     * @param {string} botId - The ID of the bot
+     * @param {string} userId - The ID of the user
+     * @returns {Promise<VoteResult>} Vote status object
+     */
+    checkVote(botId: string, userId: string): Promise<VoteResult | undefined>;
+    /**
+     * Sync commands for the bot
+     * @param {string} botId - The ID of the bot
+     * @param {Command[]} commands - Array of command objects
+     * @returns {Promise<any>} API Response
+     */
+    syncCommands(botId: string, commands: Command[]): Promise<any>;
+    private _handleError;
+}
+export default DiscordThings;

package/dist/index.js

@@ -0,0 +1,97 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DiscordThings = void 0;
+const axios_1 = __importDefault(require("axios"));
+class DiscordThings {
+    /**
+     * @param {string} token - Your User API Token
+     * @param {DiscordThingsOptions} [options] - Configuration options
+     */
+    constructor(token, options = {}) {
+        if (!token)
+            throw new Error('API Token is required');
+        this.client = axios_1.default.create({
+            baseURL: options.baseUrl || 'https://discordthings.com/api',
+            headers: {
+                'Authorization': token,
+                'Content-Type': 'application/json'
+            }
+        });
+    }
+    /**
+     * Post bot statistics to DiscordThings
+     * @param {string} botId - The ID of the bot
+     * @param {number} serverCount - Total number of servers the bot is in
+     * @param {number} [shardCount] - Total number of shards (optional)
+     * @returns {Promise<any>} API Response
+     */
+    async postStats(botId, serverCount, shardCount) {
+        if (!botId || serverCount === undefined)
+            throw new Error('Bot ID and server count are required');
+        try {
+            const response = await this.client.post(`/bots/${botId}/stats`, {
+                server_count: serverCount,
+                shard_count: shardCount
+            });
+            return response.data;
+        }
+        catch (error) {
+            this._handleError(error);
+        }
+    }
+    /**
+     * Check if a user has voted for the bot
+     * @param {string} botId - The ID of the bot
+     * @param {string} userId - The ID of the user
+     * @returns {Promise<VoteResult>} Vote status object
+     */
+    async checkVote(botId, userId) {
+        if (!botId || !userId)
+            throw new Error('Bot ID and User ID are required');
+        try {
+            const response = await this.client.get(`/bots/${botId}/check-vote`, {
+                params: { userId }
+            });
+            return response.data;
+        }
+        catch (error) {
+            this._handleError(error);
+        }
+    }
+    /**
+     * Sync commands for the bot
+     * @param {string} botId - The ID of the bot
+     * @param {Command[]} commands - Array of command objects
+     * @returns {Promise<any>} API Response
+     */
+    async syncCommands(botId, commands) {
+        if (!botId || !Array.isArray(commands))
+            throw new Error('Bot ID and commands array are required');
+        try {
+            const response = await this.client.post(`/bots/${botId}/commands`, {
+                commands
+            });
+            return response.data;
+        }
+        catch (error) {
+            this._handleError(error);
+        }
+    }
+    _handleError(error) {
+        if (axios_1.default.isAxiosError(error) && error.response) {
+            throw new Error(`API Error [${error.response.status}]: ${error.response.data.error || error.response.statusText}`);
+        }
+        throw error;
+    }
+}
+exports.DiscordThings = DiscordThings;
+// Support CommonJS require and ES imports
+exports.default = DiscordThings;
+module.exports = DiscordThings;
+// To maintain compatibility with the previous require('discordthings-api') pattern
+module.exports.default = DiscordThings;
+module.exports.DiscordThings = DiscordThings;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA6C;AA4B7C,MAAa,aAAa;IAGtB;;;OAGG;IACH,YAAY,KAAa,EAAE,UAAgC,EAAE;QACzD,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAErD,IAAI,CAAC,MAAM,GAAG,eAAK,CAAC,MAAM,CAAC;YACvB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,+BAA+B;YAC3D,OAAO,EAAE;gBACL,eAAe,EAAE,KAAK;gBACtB,cAAc,EAAE,kBAAkB;aACrC;SACJ,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,CAAC,KAAa,EAAE,WAAmB,EAAE,UAAmB;QACnE,IAAI,CAAC,KAAK,IAAI,WAAW,KAAK,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAEjG,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,KAAK,QAAQ,EAAE;gBAC5D,YAAY,EAAE,WAAW;gBACzB,WAAW,EAAE,UAAU;aAC1B,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CAAC,KAAa,EAAE,MAAc;QACzC,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QAE1E,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,KAAK,aAAa,EAAE;gBAChE,MAAM,EAAE,EAAE,MAAM,EAAE;aACrB,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAAC,KAAa,EAAE,QAAmB;QACjD,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAElG,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,KAAK,WAAW,EAAE;gBAC/D,QAAQ;aACX,CAAC,CAAC;YACH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC;IACL,CAAC;IAEO,YAAY,CAAC,KAAU;QAC3B,IAAI,eAAK,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,cAAc,KAAK,CAAC,QAAQ,CAAC,MAAM,MAAM,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QACvH,CAAC;QACD,MAAM,KAAK,CAAC;IAChB,CAAC;CACJ;AApFD,sCAoFC;AAED,0CAA0C;AAC1C,kBAAe,aAAa,CAAC;AAC7B,MAAM,CAAC,OAAO,GAAG,aAAa,CAAC;AAC/B,mFAAmF;AACnF,MAAM,CAAC,OAAO,CAAC,OAAO,GAAG,aAAa,CAAC;AACvC,MAAM,CAAC,OAAO,CAAC,aAAa,GAAG,aAAa,CAAC"}

package/package.json

@@ -1,9 +1,15 @@
 {
     "name": "discordthings-api",
-    "version": "1.1.0",
+    "version": "1.1.2",
     "description": "Official API Wrapper for DiscordThings.com",
-    "main": "index.js",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
     "scripts": {
+        "build": "tsc",
+        "prepublishOnly": "npm run build",
         "test": "echo \"Error: no test specified\" && exit 1"
     },
     "keywords": [
@@ -21,6 +27,10 @@
     },
     "repository": {
         "type": "git",
-        "url": "https://github.com/discordthings/npm-package.git"
+        "url": "https://github.com/wdiscordthings/discordthings-api.git"
+    },
+    "devDependencies": {
+        "@types/node": "^25.0.3",
+        "typescript": "^5.9.3"
     }
 }

package/index.js

@@ -1,91 +0,0 @@
-const axios = require('axios');
-
-class DiscordThings {
-    /**
-     * @param {string} token - Your Bot's API Token (from User Profile)
-     * @param {Object} options - Optional settings
-     * @param {string} [options.baseUrl='https://discordthings.com/api'] - API Base URL
-     */
-    constructor(token, options = {}) {
-        if (!token) throw new Error('A valid API Token is required');
-
-        this.token = token;
-        this.baseUrl = options.baseUrl || 'https://discordthings.com/api';
-
-        this.client = axios.create({
-            baseURL: this.baseUrl,
-            headers: {
-                'Content-Type': 'application/json',
-                'Authorization': this.token
-            }
-        });
-    }
-
-    /**
-     * Post Server and Shard Count Stats
-     * @param {string} botId - The ID of the bot
-     * @param {number} serverCount - Total number of servers
-     * @param {number} [shardCount=0] - Total number of shards (optional)
-     * @returns {Promise<Object>} API Response
-     */
-    async postStats(botId, serverCount, shardCount = 0) {
-        if (!botId) throw new Error('Bot ID is required');
-
-        try {
-            const response = await this.client.post(`/bots/${botId}/stats`, {
-                server_count: serverCount,
-                shard_count: shardCount
-            });
-            return response.data;
-        } catch (error) {
-            this._handleError(error);
-        }
-    }
-
-    /**
-     * Check if a user has voted for a bot
-     * @param {string} botId - The ID of the bot
-     * @param {string} userId - The ID of the user to check
-     * @returns {Promise<Object>} { voted: boolean, lastVote: Date, nextVote: Date }
-     */
-    async checkVote(botId, userId) {
-        if (!botId || !userId) throw new Error('Bot ID and User ID are required');
-
-        try {
-            const response = await this.client.get(`/bots/${botId}/check-vote`, {
-                params: { userId }
-            });
-            return response.data;
-        } catch (error) {
-            this._handleError(error);
-        }
-    }
-
-    /**
-     * Sync commands for the bot
-     * @param {string} botId - The ID of the bot
-     * @param {Array} commands - Array of command objects
-     * @returns {Promise<Object>} API Response
-     */
-    async syncCommands(botId, commands) {
-        if (!botId || !Array.isArray(commands)) throw new Error('Bot ID and commands array are required');
-
-        try {
-            const response = await this.client.post(`/bots/${botId}/commands`, {
-                commands
-            });
-            return response.data;
-        } catch (error) {
-            this._handleError(error);
-        }
-    }
-
-    _handleError(error) {
-        if (error.response) {
-            throw new Error(`API Error [${error.response.status}]: ${error.response.data.error || error.response.statusText}`);
-        }
-        throw error;
-    }
-}
-
-module.exports = DiscordThings;