feat: adapt to v1

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: Build library
+name: Build SDK
 
 on:
   push:
@@ -11,11 +11,11 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [18, 20]
+        node: [21, 22, 24, 25]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v6
       - name: Cache node_modules
-        uses: actions/cache@v3
+        uses: actions/cache@v5
         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@v6
         with:
           node-version: ${{ matrix.node }}
           check-latest: true

.github/workflows/publish.yml

@@ -8,10 +8,10 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
         with:
-          node-version: 18
+          node-version: 21
           check-latest: true
           registry-url: https://registry.npmjs.org/
       - run: npm publish --access public

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Jest Tests
+name: Run tests
 
 on:
   push:
@@ -10,14 +10,14 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v6
       - name: Use Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v6
         with:
-          node-version: 18
+          node-version: 21
           check-latest: true
           registry-url: https://registry.npmjs.org/
       - name: Install Dependencies
         run: npm install
-      - name: Run Jest tests
-        run: npm run test
+      - name: Run tests
+        run: npm test

.husky/pre-commit

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

.nvmrc

@@ -1 +1 @@
-18.18.2
+18.18.2

README.md

@@ -1,62 +1,175 @@
-# 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 SDK 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)
+  - [Getting a cursor-based paginated list of votes for your project](#getting-a-cursor-based-paginated-list-of-votes-for-your-project)
+  - [Posting your bot's application commands list](#posting-your-bots-application-commands-list)
+  - [Generating widget URLs](#generating-widget-urls)
+  - [Webhooks](#webhooks)
 
-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");
+```
+
+### Getting a cursor-based paginated list of votes for your project
 
-[Documentation](https://topgg.js.org)
+```js
+const since = new Date("2026-01-01");
 
-[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)
+const firstPage = await client.getVotes(since);
+console.log(firstPage.votes);
 
-# Popular Examples
+const secondPage = await firstPage.next();
+console.log(secondPage.votes);
+```
 
-## Auto-Posting stats
+### Posting your bot's application commands list
 
-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)
+#### Discord.js
 
 ```js
-const client = Discord.Client(); // Your discord.js client or any other
-const { AutoPoster } = require("topgg-autoposter");
+const commands = (await bot.application.commands.fetch()).map(command => command.toJSON());
 
-AutoPoster("topgg-token", client).on("posted", () => {
-  console.log("Posted stats to Top.gg!");
-});
+await client.postCommands(commands);
 ```
 
-With this your server count and shard count will be posted to Top.<span>gg
+#### Raw
+
+```js
+// Array of application commands that
+// can be serialized to Discord API's raw JSON format.
+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
+  }
+]);
+```
+
+### Generating widget URLs
+
+#### Large
+
+```js
+const widgetUrl = Topgg.Widget.large("discord", "bot", "1026525568344264724");
+```
 
-## Webhook server
+#### Votes
 
 ```js
-const express = require("express");
-const Topgg = require("@top-gg/sdk");
+const widgetUrl = Topgg.Widget.votes("discord", "bot", "1026525568344264724");
+```
 
-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("discord", "bot", "1026525568344264724");
+```
 
-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("discord", "bot", "1026525568344264724");
 ```
 
-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
+
+With express:
+
+```js
+import { Webhook } from "@top-gg/sdk";
+import express from "express";
+
+const app = express();
+const webhook = new Webhook(process.env.TOPGG_WEBHOOK_SECRET);
+
+// POST /webhook
+app.post("/webhook", webhook.listener((payload) => {
+  console.log(payload);
+}));
+
+app.listen(8080);
+```

eslint.config.js

@@ -1,31 +1,29 @@
-const js = require('@eslint/js');
-const ts = require("@typescript-eslint/eslint-plugin");
+import tsPlugin from "@typescript-eslint/eslint-plugin";
+import ts from "@typescript-eslint/eslint-plugin";
+import tsParser from "@typescript-eslint/parser";
+import js from "@eslint/js";
 
-const tsPlugin = require('@typescript-eslint/eslint-plugin');
-const jestPlugin = require('eslint-plugin-jest');
-
-module.exports = [
+export default [
   {
     ignores: ["node_modules/*", "docs/*", "dist/*"]
   },
   {
     ...js.configs.recommended,
     files: ["src/**/*.ts"],
     languageOptions: {
-      parser: require('@typescript-eslint/parser'),
+      parser: tsParser,
       parserOptions: {
-        project: './tsconfig.json',
+        projectService: true
       },
       globals: {
         es6: true,
         browser: true,
-        node: true,
-        jest: true
-      }
+        node: true
+      },
+      sourceType: "module"
     },
     plugins: {
-      "@typescript-eslint": tsPlugin,
-      jest: jestPlugin
+      "@typescript-eslint": tsPlugin
     },
     rules: {
       ...ts.configs.recommended.rules,