feat: adapt to v1

.github/workflows/build.yml

@@ -13,9 +13,9 @@ jobs:
       matrix:
         node: [18, 20]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v5
       - name: Cache node_modules
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         env:
           cache-name: cache-node-modules
         with:
@@ -26,7 +26,7 @@ jobs:
             ${{ runner.os }}-build-
             ${{ runner.os }}-
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v5
         with:
           node-version: ${{ matrix.node }}
           check-latest: true

.github/workflows/publish.yml

@@ -8,8 +8,8 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
         with:
           node-version: 18
           check-latest: true

.github/workflows/test.yml

@@ -10,9 +10,9 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v5
       - name: Use Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v5
         with:
           node-version: 18
           check-latest: true

.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,270 @@
-# Top.gg Node SDK
+# Top.gg Node.js SDK
 
-An official module for interacting with the Top.<span>gg API
+The community-maintained Node.js library for Top.gg.
 
-# Installation
+## Chapters
 
-`yarn add @top-gg/sdk` or `npm i @top-gg/sdk`
+- [Installation](#installation)
+- [Setting up](#setting-up)
+- [Usage](#usage)
+  - [API v1](#api-v1-1)
+    - [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)
+  - [API v0](#api-v0-1)
+    - [Getting a bot](#getting-a-bot)
+    - [Getting several bots](#getting-several-bots)
+    - [Getting your project's voters](#getting-your-projects-voters)
+    - [Check if a user has voted for your project](#check-if-a-user-has-voted-for-your-project)
+    - [Getting your bot's statistics](#getting-your-bots-statistics)
+    - [Posting your bot's statistics](#posting-your-bots-statistics)
+    - [Automatically posting your bot's statistics every few minutes](#automatically-posting-your-bots-statistics-every-few-minutes)
+    - [Checking if the weekend vote multiplier is active](#checking-if-the-weekend-vote-multiplier-is-active)
+    - [Generating widget URLs](#generating-widget-urls)
+  - [Webhooks](#webhooks)
+    - [Being notified whenever someone voted for your project](#being-notified-whenever-someone-voted-for-your-project)
 
-# Introduction
+## Installation
 
-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.
+### NPM
 
-See [this tutorial](https://github.com/top-gg/rust-sdk/assets/60427892/d2df5bd3-bc48-464c-b878-a04121727bff) on how to retrieve your API token.
+```sh
+$ npm i @top-gg/sdk
+```
+
+### Yarn
 
-You can also setup webhooks via Topgg.Webhook, look down below at the examples for how to do so!
+```sh
+$ yarn add @top-gg/sdk
+```
 
-# Links
+## Setting up
 
-[Documentation](https://topgg.js.org)
+### API v1
 
-[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)
+> **NOTE**: API v1 also includes API v0.
 
-# Popular Examples
+```js
+import Topgg from "@top-gg/sdk";
 
-## Auto-Posting stats
+const client = new Topgg.V1Api(process.env.TOPGG_TOKEN);
+```
 
-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)
+### API v0
 
 ```js
-const client = Discord.Client(); // Your discord.js client or any other
-const { AutoPoster } = require("topgg-autoposter");
+import Topgg from "@top-gg/sdk";
+
+const client = new Topgg.Api(process.env.TOPGG_TOKEN);
+```
+
+## Usage
+
+### API v1
+
+#### 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
+
+```js
+const commands = await bot.getCommands();
+
+await client.postCommands(commands);
+```
 
-AutoPoster("topgg-token", client).on("posted", () => {
-  console.log("Posted stats to Top.gg!");
+##### Discordeno
+
+```js
+import { getApplicationCommands } from "discordeno";
+
+const commands = await getApplicationCommands(bot);
+
+await client.postCommands(commands);
+```
+
+##### Harmony
+
+```js
+const commands = await bot.interactions.commands.all();
+
+await client.postCommands(commands);
+```
+
+##### 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
+  }
+]);
+```
+
+### API v0
+
+#### Getting a bot
+
+```js
+const bot = await client.getBot("461521980492087297");
+```
+
+#### Getting several bots
+
+```js
+const bots = await client.getBots();
+```
+
+#### Getting your project's voters
+
+##### First page
+
+```js
+const voters = await client.getVoters();
+```
+
+##### Subsequent pages
+
+```js
+const voters = await client.getVoters(2);
+```
+
+#### Check if a user has voted for your project
+
+```js
+const hasVoted = await client.hasVoted("661200758510977084");
+```
+
+#### Getting your bot's statistics
+
+```js
+const stats = await client.getStats();
+```
+
+#### Posting your bot's statistics
+
+```js
+
+await api.postStats({
+  serverCount: bot.getServerCount(),
+});
+```
+
+#### Automatically posting your bot's statistics every few minutes
+
+You would need to use the third-party `topgg-autoposter` package to be able to autopost. Install it in your terminal like so:
+
+##### NPM
+
+```sh
+$ npm i topgg-autoposter
+```
+
+##### Yarn
+
+```sh
+$ yarn add topgg-autoposter
+```
+
+Then in your code:
+
+```js
+import { AutoPoster } from "topgg-autoposter";
+
+// Your discord.js client or any other
+const client = Discord.Client();
+
+AutoPoster(process.env.TOPGG_TOKEN, client).on("posted", () => {
+  console.log("Successfully posted statistics to Top.gg!");
 });
 ```
 
-With this your server count and shard count will be posted to Top.<span>gg
+#### Checking if the weekend vote multiplier is active
+
+```js
+const isWeekend = await client.isWeekend();
+```
+
+#### Generating widget URLs
+
+##### Large
+
+```js
+const widgetUrl = Topgg.Widget.large(Topgg.WidgetType.DiscordBot, "574652751745777665");
+```
 
-## Webhook server
+##### Votes
 
 ```js
-const express = require("express");
-const Topgg = require("@top-gg/sdk");
+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);
+```