Changes to how typings are exported (#49)

Top-gg-Community · Mar 4, 2021 · be0f946 · be0f946
1 parent 2bb947e
commit be0f946
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 12 deletions.
diff --git a/docs/Changelog.md b/docs/Changelog.md
@@ -2,6 +2,9 @@
 
 # Change Log
 
+## 3.0.9
+  - A change to how typings are used, properly exports via dist/typings
+
 ## 3.0.8
   - Change docs URL
   - Fix typos in a few method docs

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@top-gg/sdk",
-  "version": "3.0.8",
+  "version": "3.0.9",
   "description": "Official Top.gg Node SDK",
   "main": "./dist/index.js",
   "scripts": {

diff --git a/src/index.ts b/src/index.ts
@@ -1,4 +1,2 @@
-import './typings'
-
 export * from './structs/Api'
 export * from './structs/Webhook'
diff --git a/src/structs/Api.ts b/src/structs/Api.ts
@@ -3,6 +3,8 @@ import ApiError from '../utils/ApiError'
 import qs from 'querystring'
 import { EventEmitter } from 'events'
 
+import { Snowflake, BotStats, BotInfo, UserInfo, BotsResponse, ShortUser, BotsQuery } from '../typings'
+
 interface APIOptions {
   /**
    * Top.gg Token

diff --git a/src/structs/Webhook.ts b/src/structs/Webhook.ts
@@ -1,6 +1,8 @@
 import getBody from 'raw-body'
 import qs from 'querystring'
 
+import { WebhookPayload } from '../typings'
+
 /**
  * Top.gg Webhook
  * @example

diff --git a/src/typings.ts b/src/typings.ts
@@ -1,9 +1,9 @@
 /**
  * Discord ID
  */
-type Snowflake = string
+export type Snowflake = string
 
-interface BotInfo {
+export interface BotInfo {
   /**
    * The id of the bot
    */
@@ -99,7 +99,7 @@ interface BotInfo {
   donatebotguildid: Snowflake
 }
 
-interface BotStats {
+export interface BotStats {
   /**
    * The amount of servers the bot is in
    */
@@ -118,7 +118,7 @@ interface BotStats {
   shardCount?: number
 }
 
-interface UserInfo {
+export interface UserInfo {
   /**
    * The id of the user
    */
@@ -198,7 +198,7 @@ interface UserInfo {
   admin: boolean
 }
 
-interface BotsQuery {
+export interface BotsQuery {
   /**
    * The amount of bots to return. Max. 500
    */
@@ -223,7 +223,7 @@ interface BotsQuery {
   fields?: string[]|string
 }
 
-interface BotsResponse {
+export interface BotsResponse {
   /**
    * The matching bots
    */
@@ -246,7 +246,7 @@ interface BotsResponse {
   total: number
 }
 
-interface ShortUser {
+export interface ShortUser {
   /**
    * User's ID
    */
@@ -265,7 +265,7 @@ interface ShortUser {
   avatar: string
 }
 
-interface WebhookPayload {
+export interface WebhookPayload {
   /**
    * If webhook is a bot: ID of the bot that received a vote
    */