feat: adapt to v1

.husky/pre-commit

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npm run lint
+npm run lint

.npmignore

@@ -5,7 +5,7 @@ logs/
 *.log
 
 !dist/
-.eslintrc.json
+eslint.config.js
 .gitattributes
 .gitignore
 .github/

README.md

@@ -1,62 +1,196 @@
-# Top.gg Node SDK
+# Top.gg Node.js SDK
 
-An official module for interacting with the Top.<span>gg API
+> For more information, see the documentation here: https://topgg.js.org.
 
-# Installation
+The community-maintained Node.js library for Top.gg.
 
-`yarn add @top-gg/sdk` or `npm i @top-gg/sdk`
+## Chapters
 
-# Introduction
+- [Installation](#installation)
+- [Setting up](#setting-up)
+- [Usage](#usage)
+  - [Getting your project's information](#getting-your-projects-information)
+  - [Getting your project's vote information of a user](#getting-your-projects-vote-information-of-a-user)
+  - [Posting your bot's application commands list](#posting-your-bots-application-commands-list)
+  - [Generating widget URLs](#generating-widget-urls)
+  - [Webhooks](#webhooks)
+    - [Being notified whenever someone voted for your project](#being-notified-whenever-someone-voted-for-your-project)
 
-The base client is Topgg.Api, and it takes your Top.gg token and provides you with plenty of methods to interact with the API.
+## Installation
 
-See [this tutorial](https://github.com/top-gg/rust-sdk/assets/60427892/d2df5bd3-bc48-464c-b878-a04121727bff) on how to retrieve your API token.
 
-You can also setup webhooks via Topgg.Webhook, look down below at the examples for how to do so!
+### NPM
 
-# Links
+```sh
+$ npm i @top-gg/sdk
+```
+
+### Yarn
+
+```sh
+$ yarn add @top-gg/sdk
+```
+
+## Setting up
+
+```js
+import Topgg from "@top-gg/sdk";
+
+const client = new Topgg.Api(process.env.TOPGG_TOKEN);
+```
+
+## Usage
+
+### Getting your project's information
+
+```js
+const project = await client.getSelf();
+
+console.log(project);
+// =>
+// {
+//   id: '218109768489992192',
+//   name: 'Miki',
+//   type: 'bot',
+//   platform: 'discord',
+//   headline: 'A great bot with tons of features! language | admin | cards | fun | levels | roles | marriage | currency | custom commands!',
+//   tags: [
+//     'anime',
+//     'customizable-behavior',
+//     'economy',
+//     'fun',
+//     'game',
+//     'leveling',
+//     'multifunctional',
+//     'role-management',
+//     'roleplay',
+//     'social'
+//   ],
+//   votes: { current: 1120, total: 313389 },
+//   review: { score: 4.38, count: 62245 }
+// }
+```
+
+### Getting your project's vote information of a user
+
+#### Discord ID
+
+```js
+const vote = await client.getVote("661200758510977084");
+```
+
+#### Top.gg ID
+
+```js
+const vote = await client.getVote("8226924471638491136", "topgg");
+```
+
+### Posting your bot's application commands list
+
+#### Discord.js
+
+```js
+const commands = (await bot.application.commands.fetch()).map(cmd => cmd.toJSON());
+
+await client.postCommands(commands);
+```
+
+#### Eris
 
-[Documentation](https://topgg.js.org)
+```js
+const commands = await bot.getCommands();
+
+await client.postCommands(commands);
+```
+
+#### Discordeno
 
-[API Reference](https://docs.top.gg) | [GitHub](https://github.com/top-gg/node-sdk) | [NPM](https://npmjs.com/package/@top-gg/sdk) | [Discord Server](https://discord.gg/EYHTgJX)
+```js
+import { getApplicationCommands } from "discordeno";
 
-# Popular Examples
+const commands = await getApplicationCommands(bot);
 
-## Auto-Posting stats
+await client.postCommands(commands);
+```
 
-If you're looking for an easy way to post your bot's stats (server count, shard count), check out [`topgg-autoposter`](https://npmjs.com/package/topgg-autoposter)
+#### Harmony
 
 ```js
-const client = Discord.Client(); // Your discord.js client or any other
-const { AutoPoster } = require("topgg-autoposter");
+const commands = await bot.interactions.commands.all();
+
+await client.postCommands(commands);
+```
 
-AutoPoster("topgg-token", client).on("posted", () => {
-  console.log("Posted stats to Top.gg!");
-});
+#### Oceanic
+
+```js
+const commands = await bot.application.getGlobalCommands();
+
+await client.postCommands(commands);
+```
+
+#### Raw
+
+```js
+await client.postCommands([
+  {
+    options: [],
+    name: 'test',
+    name_localizations: null,
+    description: 'command description',
+    description_localizations: null,
+    contexts: [],
+    default_permission: null,
+    default_member_permissions: null,
+    dm_permission: false,
+    integration_types: [],
+    nsfw: false
+  }
+]);
 ```
 
-With this your server count and shard count will be posted to Top.<span>gg
+### Generating widget URLs
 
-## Webhook server
+#### Large
 
 ```js
-const express = require("express");
-const Topgg = require("@top-gg/sdk");
+const widgetUrl = Topgg.Widget.large(Topgg.WidgetType.DiscordBot, "574652751745777665");
+```
+
+#### Votes
+
+```js
+const widgetUrl = Topgg.Widget.votes(Topgg.WidgetType.DiscordBot, "574652751745777665");
+```
 
-const app = express(); // Your express app
+#### Owner
 
-const webhook = new Topgg.Webhook("topggauth123"); // add your Top.gg webhook authorization (not bot token)
+```js
+const widgetUrl = Topgg.Widget.owner(Topgg.WidgetType.DiscordBot, "574652751745777665");
+```
 
-app.post(
-  "/dblwebhook",
-  webhook.listener((vote) => {
-    // vote is your vote object
-    console.log(vote.user); // 221221226561929217
-  })
-); // attach the middleware
+#### Social
 
-app.listen(3000); // your port
+```js
+const widgetUrl = Topgg.Widget.social(Topgg.WidgetType.DiscordBot, "574652751745777665");
 ```
 
-With this example, your webhook dashboard (`https://top.gg/bot/{your bot's id}/webhooks`) should look like this:
-![](https://i.imgur.com/cZfZgK5.png)
+### Webhooks
+
+#### Being notified whenever someone voted for your project
+
+With express:
+
+```js
+import { Webhook } from "@top-gg/sdk";
+import express from "express";
+
+const app = express();
+const webhook = new Webhook(process.env.TOPGG_WEBHOOK_PASSWORD);
+
+app.post("/votes", webhook.listener(vote => {
+  console.log(`A user with the ID of ${vote.user} has voted us on Top.gg!`);
+}));
+
+app.listen(8080);
+```

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@top-gg/sdk",
-  "version": "3.1.6",
-  "description": "Official Top.gg Node SDK",
+  "version": "4.0.0",
+  "description": "A community-maintained Node.js API Client for the Top.gg API.",
   "main": "./dist/index.js",
   "scripts": {
     "test": "jest --verbose",
@@ -31,6 +31,7 @@
     "@types/node": "^20.5.9",
     "@typescript-eslint/eslint-plugin": "^6.6.0",
     "@typescript-eslint/parser": "^6.6.0",
+    "discord-api-types": "^0.38.38",
     "eslint": "^8.48.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-jest": "^27.2.3",

src/index.ts

@@ -1,3 +1,4 @@
 export * from "./structs/Api";
 export * from "./structs/Webhook";
+export * from "./structs/Widget";
 export * from "./typings";