topgg-api-types 0.0.1

package/README.md

@@ -0,0 +1,73 @@
+# topgg-api-types
+
+A lightweight collection of TypeScript types and runtime validators for the Top.gg API.
+This package provides type definitions for the various endpoints and data structures used in the Top.gg API,
+making it easier for developers to work with the API in a type-safe manner.
+
+> [!NOTE]
+> This package is currently in development and not all comments and documentation are complete. The types and validators should be complete and accurate though.
+> It is not yet uploaded to npm, but you can clone the repository and use it locally in your projects.
+
+## Installation
+
+```bash
+npm install topgg-api-types
+# or
+pnpm add topgg-api-types
+# or
+yarn add topgg-api-types
+# or
+bun add topgg-api-types
+# or
+poop add topgg-api-types
+```
+
+## Usage
+
+### TypeScript Types (Recommended for most users)
+
+Import TypeScript types for static type checking and IntelliSense:
+
+```ts
+import type { User, VoteCreateWebhookPayload, GetProjectResponse } from "topgg-api-types/v1";
+
+// Use types in your code
+const user: User = {
+  id: "1234567890",
+  platform_id: "9876543210",
+  name: "MyUser",
+  avatar_url: "https://example.com/avatar.png",
+};
+```
+
+### Runtime Validators
+
+If you need runtime validation with Zod, import from the validators subpath:
+
+```ts
+import { UserSchema, VoteCreateWebhookPayloadSchema } from "topgg-api-types/v1/validators";
+
+// Validate incoming webhook data
+try {
+  const validatedPayload = VoteCreateWebhookPayloadSchema.parse(req.body);
+  console.log("Valid vote webhook:", validatedPayload);
+} catch (error) {
+  console.error("Invalid webhook payload:", error);
+}
+```
+
+The validators are written with zod/mini, which is a lightweight version of Zod that provides basic validation functionality with a smaller bundle size.
+
+## Available Exports
+
+- `topgg-api-types/v1` - Version 1 types (current)
+- `topgg-api-types/v1/validators` - Version 1 Zod validators
+- `topgg-api-types/v0` - Version 0 types
+- `topgg-api-types/v0/validators` - Version 0 Zod validators
+
+## Why Two Approaches?
+
+- **Types only**: Smaller bundle size, better IntelliSense, no runtime overhead - perfect for most users
+- **Validators**: Runtime validation with Zod - use when you need to validate API responses or webhook payloads
+
+Choose the approach that fits your needs, or use both together!

package/dist/index-BzCAuhll.d.ts

@@ -0,0 +1,6 @@
+//#region src/utils/index.d.ts
+type Snowflake = string;
+type ISO8601Date = string;
+//#endregion
+export { Snowflake as n, ISO8601Date as t };
+//# sourceMappingURL=index-BzCAuhll.d.ts.map

package/dist/index-Dj7klI6c.d.cts

@@ -0,0 +1,6 @@
+//#region src/utils/index.d.ts
+type Snowflake = string;
+type ISO8601Date = string;
+//#endregion
+export { Snowflake as n, ISO8601Date as t };
+//# sourceMappingURL=index-Dj7klI6c.d.cts.map

package/dist/index.cjs

@@ -0,0 +1,28 @@
+require('./validators-B3dxgWHu.cjs');
+const require_v1_validators = require('./v1/validators.cjs');
+
+exports.BaseProjectSchema = require_v1_validators.BaseProjectSchema;
+exports.ErrorSchema = require_v1_validators.ErrorSchema;
+exports.GetProjectResponseSchema = require_v1_validators.GetProjectResponseSchema;
+exports.GetProjectVotesQuerySchema = require_v1_validators.GetProjectVotesQuerySchema;
+exports.GetProjectVotesResponseSchema = require_v1_validators.GetProjectVotesResponseSchema;
+exports.GetVoteStatusByUserQuerySchema = require_v1_validators.GetVoteStatusByUserQuerySchema;
+exports.GetVoteStatusByUserResponseSchema = require_v1_validators.GetVoteStatusByUserResponseSchema;
+exports.IntegrationCreateDataSchema = require_v1_validators.IntegrationCreateDataSchema;
+exports.IntegrationCreateResponseSchema = require_v1_validators.IntegrationCreateResponseSchema;
+exports.IntegrationCreateWebhookPayloadSchema = require_v1_validators.IntegrationCreateWebhookPayloadSchema;
+exports.IntegrationDeleteDataSchema = require_v1_validators.IntegrationDeleteDataSchema;
+exports.IntegrationDeleteWebhookPayloadSchema = require_v1_validators.IntegrationDeleteWebhookPayloadSchema;
+exports.IntegrationSupportedWebhookScopesSchema = require_v1_validators.IntegrationSupportedWebhookScopesSchema;
+exports.ProjectPlatformTypeSchema = require_v1_validators.ProjectPlatformTypeSchema;
+exports.ProjectTypeSchema = require_v1_validators.ProjectTypeSchema;
+exports.ProjectVoteSchema = require_v1_validators.ProjectVoteSchema;
+exports.UserSchema = require_v1_validators.UserSchema;
+exports.UserSourceSchema = require_v1_validators.UserSourceSchema;
+exports.VoteCreateDataSchema = require_v1_validators.VoteCreateDataSchema;
+exports.VoteCreateWebhookPayloadSchema = require_v1_validators.VoteCreateWebhookPayloadSchema;
+exports.VoteSchema = require_v1_validators.VoteSchema;
+exports.WebhookEventTypeSchema = require_v1_validators.WebhookEventTypeSchema;
+exports.WebhookPayloadBaseSchema = require_v1_validators.WebhookPayloadBaseSchema;
+exports.WebhookTestDataSchema = require_v1_validators.WebhookTestDataSchema;
+exports.WebhookTestWebhookPayloadSchema = require_v1_validators.WebhookTestWebhookPayloadSchema;

package/dist/index.d.cts

@@ -0,0 +1,3 @@
+import { BaseProject, ErrorResponse, GetProjectResponse, GetProjectVotesQuery, GetProjectVotesResponse, GetVoteStatusByUserQuery, GetVoteStatusByUserResponse, IntegrationCreateData, IntegrationCreateResponse, IntegrationCreateWebhookPayload, IntegrationDeleteData, IntegrationDeleteWebhookPayload, IntegrationWebhookEventType, ProjectPlatformType, ProjectType, ProjectVote, User, UserSource, Vote, VoteCreateData, VoteCreateWebhookPayload, WebhookEventType, WebhookEventTypes, WebhookPayloadBase, WebhookTestData, WebhookTestWebhookPayload } from "./v1.cjs";
+import { BaseProjectSchema, ErrorSchema, GetProjectResponseSchema, GetProjectVotesQuerySchema, GetProjectVotesResponseSchema, GetVoteStatusByUserQuerySchema, GetVoteStatusByUserResponseSchema, IntegrationCreateDataSchema, IntegrationCreateResponseSchema, IntegrationCreateWebhookPayloadSchema, IntegrationDeleteDataSchema, IntegrationDeleteWebhookPayloadSchema, IntegrationSupportedWebhookScopesSchema, ProjectPlatformTypeSchema, ProjectTypeSchema, ProjectVoteSchema, UserSchema, UserSourceSchema, VoteCreateDataSchema, VoteCreateWebhookPayloadSchema, VoteSchema, WebhookEventTypeSchema, WebhookPayloadBaseSchema, WebhookTestDataSchema, WebhookTestWebhookPayloadSchema } from "./v1/validators.cjs";
+export { BaseProject, BaseProjectSchema, ErrorResponse, ErrorSchema, GetProjectResponse, GetProjectResponseSchema, GetProjectVotesQuery, GetProjectVotesQuerySchema, GetProjectVotesResponse, GetProjectVotesResponseSchema, GetVoteStatusByUserQuery, GetVoteStatusByUserQuerySchema, GetVoteStatusByUserResponse, GetVoteStatusByUserResponseSchema, IntegrationCreateData, IntegrationCreateDataSchema, IntegrationCreateResponse, IntegrationCreateResponseSchema, IntegrationCreateWebhookPayload, IntegrationCreateWebhookPayloadSchema, IntegrationDeleteData, IntegrationDeleteDataSchema, IntegrationDeleteWebhookPayload, IntegrationDeleteWebhookPayloadSchema, IntegrationSupportedWebhookScopesSchema, IntegrationWebhookEventType, ProjectPlatformType, ProjectPlatformTypeSchema, ProjectType, ProjectTypeSchema, ProjectVote, ProjectVoteSchema, User, UserSchema, UserSource, UserSourceSchema, Vote, VoteCreateData, VoteCreateDataSchema, VoteCreateWebhookPayload, VoteCreateWebhookPayloadSchema, VoteSchema, WebhookEventType, WebhookEventTypeSchema, WebhookEventTypes, WebhookPayloadBase, WebhookPayloadBaseSchema, WebhookTestData, WebhookTestDataSchema, WebhookTestWebhookPayload, WebhookTestWebhookPayloadSchema };

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import { BaseProject, ErrorResponse, GetProjectResponse, GetProjectVotesQuery, GetProjectVotesResponse, GetVoteStatusByUserQuery, GetVoteStatusByUserResponse, IntegrationCreateData, IntegrationCreateResponse, IntegrationCreateWebhookPayload, IntegrationDeleteData, IntegrationDeleteWebhookPayload, IntegrationWebhookEventType, ProjectPlatformType, ProjectType, ProjectVote, User, UserSource, Vote, VoteCreateData, VoteCreateWebhookPayload, WebhookEventType, WebhookEventTypes, WebhookPayloadBase, WebhookTestData, WebhookTestWebhookPayload } from "./v1.js";
+import { BaseProjectSchema, ErrorSchema, GetProjectResponseSchema, GetProjectVotesQuerySchema, GetProjectVotesResponseSchema, GetVoteStatusByUserQuerySchema, GetVoteStatusByUserResponseSchema, IntegrationCreateDataSchema, IntegrationCreateResponseSchema, IntegrationCreateWebhookPayloadSchema, IntegrationDeleteDataSchema, IntegrationDeleteWebhookPayloadSchema, IntegrationSupportedWebhookScopesSchema, ProjectPlatformTypeSchema, ProjectTypeSchema, ProjectVoteSchema, UserSchema, UserSourceSchema, VoteCreateDataSchema, VoteCreateWebhookPayloadSchema, VoteSchema, WebhookEventTypeSchema, WebhookPayloadBaseSchema, WebhookTestDataSchema, WebhookTestWebhookPayloadSchema } from "./v1/validators.js";
+export { BaseProject, BaseProjectSchema, ErrorResponse, ErrorSchema, GetProjectResponse, GetProjectResponseSchema, GetProjectVotesQuery, GetProjectVotesQuerySchema, GetProjectVotesResponse, GetProjectVotesResponseSchema, GetVoteStatusByUserQuery, GetVoteStatusByUserQuerySchema, GetVoteStatusByUserResponse, GetVoteStatusByUserResponseSchema, IntegrationCreateData, IntegrationCreateDataSchema, IntegrationCreateResponse, IntegrationCreateResponseSchema, IntegrationCreateWebhookPayload, IntegrationCreateWebhookPayloadSchema, IntegrationDeleteData, IntegrationDeleteDataSchema, IntegrationDeleteWebhookPayload, IntegrationDeleteWebhookPayloadSchema, IntegrationSupportedWebhookScopesSchema, IntegrationWebhookEventType, ProjectPlatformType, ProjectPlatformTypeSchema, ProjectType, ProjectTypeSchema, ProjectVote, ProjectVoteSchema, User, UserSchema, UserSource, UserSourceSchema, Vote, VoteCreateData, VoteCreateDataSchema, VoteCreateWebhookPayload, VoteCreateWebhookPayloadSchema, VoteSchema, WebhookEventType, WebhookEventTypeSchema, WebhookEventTypes, WebhookPayloadBase, WebhookPayloadBaseSchema, WebhookTestData, WebhookTestDataSchema, WebhookTestWebhookPayload, WebhookTestWebhookPayloadSchema };

package/dist/index.js

@@ -0,0 +1,4 @@
+import "./validators-Mlu16sBg.js";
+import { BaseProjectSchema, ErrorSchema, GetProjectResponseSchema, GetProjectVotesQuerySchema, GetProjectVotesResponseSchema, GetVoteStatusByUserQuerySchema, GetVoteStatusByUserResponseSchema, IntegrationCreateDataSchema, IntegrationCreateResponseSchema, IntegrationCreateWebhookPayloadSchema, IntegrationDeleteDataSchema, IntegrationDeleteWebhookPayloadSchema, IntegrationSupportedWebhookScopesSchema, ProjectPlatformTypeSchema, ProjectTypeSchema, ProjectVoteSchema, UserSchema, UserSourceSchema, VoteCreateDataSchema, VoteCreateWebhookPayloadSchema, VoteSchema, WebhookEventTypeSchema, WebhookPayloadBaseSchema, WebhookTestDataSchema, WebhookTestWebhookPayloadSchema } from "./v1/validators.js";
+
+export { BaseProjectSchema, ErrorSchema, GetProjectResponseSchema, GetProjectVotesQuerySchema, GetProjectVotesResponseSchema, GetVoteStatusByUserQuerySchema, GetVoteStatusByUserResponseSchema, IntegrationCreateDataSchema, IntegrationCreateResponseSchema, IntegrationCreateWebhookPayloadSchema, IntegrationDeleteDataSchema, IntegrationDeleteWebhookPayloadSchema, IntegrationSupportedWebhookScopesSchema, ProjectPlatformTypeSchema, ProjectTypeSchema, ProjectVoteSchema, UserSchema, UserSourceSchema, VoteCreateDataSchema, VoteCreateWebhookPayloadSchema, VoteSchema, WebhookEventTypeSchema, WebhookPayloadBaseSchema, WebhookTestDataSchema, WebhookTestWebhookPayloadSchema };

package/dist/v0/validators.cjs

@@ -0,0 +1,176 @@
+const require_validators = require('../validators-B3dxgWHu.cjs');
+let zod_mini = require("zod/mini");
+zod_mini = require_validators.__toESM(zod_mini);
+
+//#region src/v0/validators.ts
+/**
+* The type of a webhook event.
+*/
+const WebhookEventTypeSchema = zod_mini.enum(["upvote", "test"]);
+/**
+* Webhook payload for bot votes (deprecated).
+*
+* @deprecated Use `v1` types instead.
+*/
+const BotWebhookPayloadSchema = zod_mini.object({
+	bot: require_validators.SnowflakeSchema,
+	user: require_validators.SnowflakeSchema,
+	type: WebhookEventTypeSchema,
+	isWeekend: zod_mini.boolean(),
+	query: zod_mini.optional(zod_mini.string())
+});
+/**
+* Webhook payload for server votes (deprecated).
+*
+* @deprecated Use `v1` types instead.
+*/
+const ServerWebhookPayloadSchema = zod_mini.object({
+	guild: require_validators.SnowflakeSchema,
+	user: require_validators.SnowflakeSchema,
+	type: WebhookEventTypeSchema,
+	query: zod_mini.optional(zod_mini.string())
+});
+/**
+* A bot listed on Top.gg.
+*/
+const BotSchema = zod_mini.object({
+	id: require_validators.SnowflakeSchema,
+	username: zod_mini.string(),
+	discriminator: zod_mini.string(),
+	avatar: zod_mini.optional(zod_mini.string()),
+	defAvatar: zod_mini.optional(zod_mini.string()),
+	prefix: zod_mini.string(),
+	shortdesc: zod_mini.string(),
+	longdesc: zod_mini.optional(zod_mini.string()),
+	tags: zod_mini.array(zod_mini.string()),
+	website: zod_mini.optional(zod_mini.string()),
+	support: zod_mini.optional(zod_mini.string()),
+	github: zod_mini.optional(zod_mini.string()),
+	owners: zod_mini.array(require_validators.SnowflakeSchema),
+	guilds: zod_mini.array(require_validators.SnowflakeSchema),
+	invite: zod_mini.optional(zod_mini.string()),
+	date: require_validators.ISO8601DateSchema,
+	server_count: zod_mini.optional(zod_mini.number()),
+	shard_count: zod_mini.optional(zod_mini.number()),
+	certifiedBot: zod_mini.boolean(),
+	vanity: zod_mini.optional(zod_mini.string()),
+	points: zod_mini.number(),
+	monthlyPoints: zod_mini.number(),
+	donatebotguildid: require_validators.SnowflakeSchema
+});
+/**
+* Query parameters for searching bots on Top.gg.
+*
+* @see https://docs.top.gg/docs/API/v0/bot#search-bots
+*/
+const GetSearchBotsQuerySchema = zod_mini.object({
+	limit: zod_mini.optional(zod_mini.number().check(zod_mini.minimum(1)).check(zod_mini.maximum(500))),
+	offset: zod_mini.optional(zod_mini.number().check(zod_mini.minimum(0))),
+	sort: zod_mini.string(),
+	fields: zod_mini.optional(zod_mini.string())
+});
+/**
+* Response for searching bots on Top.gg.
+*/
+const GetSearchBotsResponseSchema = zod_mini.object({
+	results: zod_mini.array(BotSchema),
+	total: zod_mini.number(),
+	limit: zod_mini.number(),
+	offset: zod_mini.number(),
+	count: zod_mini.number()
+});
+/**
+* Response for getting a bot.
+*
+* - GET `/bots/:bot_id`
+*/
+const GetBotResponseSchema = BotSchema;
+/**
+* A bot voter.
+*/
+const BotVoterSchema = zod_mini.object({
+	id: require_validators.SnowflakeSchema,
+	username: zod_mini.string(),
+	avatar: zod_mini.optional(zod_mini.string())
+});
+/**
+* Gets the last 1000 voters for your bot.
+*
+* - GET `/bots/:bot_id/votes`
+*/
+const GetLast1000BotVotesResponseSchema = zod_mini.array(BotVoterSchema);
+/**
+* Specific stats about a bot.
+*
+* - GET `/bots/:bot_id/stats`
+*/
+const GetBotStatsResponseSchema = zod_mini.object({
+	server_count: zod_mini.optional(zod_mini.number()),
+	shards: zod_mini.array(zod_mini.number()),
+	shard_count: zod_mini.optional(zod_mini.number())
+});
+/**
+* Query parameters for checking whether or not a user has voted for your bot.
+*
+* - GET `/bots/:bot_id/check`
+*/
+const GetUserVoteCheckQuerySchema = zod_mini.object({ userId: require_validators.SnowflakeSchema });
+/**
+* Response for checking whether or not a user has voted for your bot.
+*
+* - GET `/bots/:bot_id/check`
+*/
+const GetUserVoteCheckResponseSchema = zod_mini.object({ voted: zod_mini.xor([zod_mini.literal(0), zod_mini.literal(1)]) });
+/**
+* Request body for posting bot stats.
+*/
+const PostBotStatsBodySchema = zod_mini.object({
+	server_count: zod_mini.xor([zod_mini.number(), zod_mini.array(zod_mini.number())]),
+	shards: zod_mini.optional(zod_mini.array(zod_mini.number())),
+	shard_id: zod_mini.optional(zod_mini.number()),
+	shard_count: zod_mini.optional(zod_mini.number())
+});
+/**
+* A user on Top.gg.
+*
+* - GET `/users/:user_id`
+*/
+const UserSchema = zod_mini.object({
+	id: require_validators.SnowflakeSchema,
+	username: zod_mini.string(),
+	discriminator: zod_mini.string(),
+	avatar: zod_mini.optional(zod_mini.string()),
+	defAvatar: zod_mini.optional(zod_mini.string()),
+	bio: zod_mini.optional(zod_mini.string()),
+	banner: zod_mini.optional(zod_mini.string()),
+	social: zod_mini.object({
+		youtube: zod_mini.optional(zod_mini.string()),
+		reddit: zod_mini.optional(zod_mini.string()),
+		twitter: zod_mini.optional(zod_mini.string()),
+		instagram: zod_mini.optional(zod_mini.string()),
+		github: zod_mini.optional(zod_mini.string())
+	}),
+	color: zod_mini.optional(zod_mini.string()),
+	supporter: zod_mini.boolean(),
+	certifiedDev: zod_mini.boolean(),
+	mod: zod_mini.boolean(),
+	webMod: zod_mini.boolean(),
+	admin: zod_mini.boolean()
+});
+
+//#endregion
+exports.BotSchema = BotSchema;
+exports.BotVoterSchema = BotVoterSchema;
+exports.BotWebhookPayloadSchema = BotWebhookPayloadSchema;
+exports.GetBotResponseSchema = GetBotResponseSchema;
+exports.GetBotStatsResponseSchema = GetBotStatsResponseSchema;
+exports.GetLast1000BotVotesResponseSchema = GetLast1000BotVotesResponseSchema;
+exports.GetSearchBotsQuerySchema = GetSearchBotsQuerySchema;
+exports.GetSearchBotsResponseSchema = GetSearchBotsResponseSchema;
+exports.GetUserVoteCheckQuerySchema = GetUserVoteCheckQuerySchema;
+exports.GetUserVoteCheckResponseSchema = GetUserVoteCheckResponseSchema;
+exports.PostBotStatsBodySchema = PostBotStatsBodySchema;
+exports.ServerWebhookPayloadSchema = ServerWebhookPayloadSchema;
+exports.UserSchema = UserSchema;
+exports.WebhookEventTypeSchema = WebhookEventTypeSchema;
+//# sourceMappingURL=validators.cjs.map

package/dist/v0/validators.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.cjs","names":["z","SnowflakeSchema","ISO8601DateSchema"],"sources":["../../src/v0/validators.ts"],"sourcesContent":["import * as z from \"zod/mini\";\nimport { ISO8601DateSchema, SnowflakeSchema } from \"@utils/validators\";\n\n// # Bases and Constants\n\n/**\n * The type of a webhook event.\n */\nexport const WebhookEventTypeSchema = z.enum([\"upvote\", \"test\"]);\n\n// # Webhooks - deprecated\n\n/**\n * Webhook payload for bot votes (deprecated).\n *\n * @deprecated Use `v1` types instead.\n */\nexport const BotWebhookPayloadSchema = z.object({\n  /**\n   * Discord ID of the bot that received a vote.\n   */\n  bot: SnowflakeSchema,\n  /**\n   * Discord ID of the user that voted.\n   */\n  user: SnowflakeSchema,\n  /**\n   * The type of the vote (should always be \"upvote\" except when using the test button it's \"test\").\n   */\n  type: WebhookEventTypeSchema,\n  /**\n   * Whether the weekend multiplier is in effect, meaning users votes count as two.\n   */\n  isWeekend: z.boolean(),\n  /**\n   * Query string params found on the /bot/:ID/vote page.\n   *\n   * @example\n   * \"?a=1&b=2&c=3\"\n   */\n  query: z.optional(z.string()),\n});\n\n/**\n * Webhook payload for server votes (deprecated).\n *\n * @deprecated Use `v1` types instead.\n */\nexport const ServerWebhookPayloadSchema = z.object({\n  /**\n   * Discord ID of the server that received a vote.\n   */\n  guild: SnowflakeSchema,\n  /**\n   * Discord ID of the user that voted.\n   */\n  user: SnowflakeSchema,\n  /**\n   * The type of the vote (should always be \"upvote\" except when using the test button it's \"test\").\n   */\n  type: WebhookEventTypeSchema,\n  /**\n   * Whether the weekend multiplier is in effect, meaning users votes count as two.\n   */\n  query: z.optional(z.string()),\n});\n\n// # Bots\n\n/**\n * A bot listed on Top.gg.\n */\nexport const BotSchema = z.object({\n  /**\n   * The Discord ID of the bot\n   */\n  id: SnowflakeSchema,\n  /**\n   * The username of the bot\n   */\n  username: z.string(),\n  /**\n   * The discriminator of the bot (legacy Discord feature)\n   */\n  discriminator: z.string(),\n  /**\n   * The avatar hash of the bot's avatar\n   */\n  avatar: z.optional(z.string()),\n  /**\n   * The cdn hash of the bot's avatar if the bot has none\n   */\n  defAvatar: z.optional(z.string()),\n  /**\n   * The command prefix of the bot\n   */\n  prefix: z.string(),\n  /**\n   * The short description of the bot\n   */\n  shortdesc: z.string(),\n  /**\n   * The detailed long description of the bot\n   */\n  longdesc: z.optional(z.string()),\n  /**\n   * Array of tags associated with the bot\n   */\n  tags: z.array(z.string()),\n  /**\n   * The official website URL of the bot\n   */\n  website: z.optional(z.string()),\n  /**\n   * The support server URL for the bot\n   */\n  support: z.optional(z.string()),\n  /**\n   * The GitHub repository URL of the bot\n   */\n  github: z.optional(z.string()),\n  /**\n   * Array of snowflake identifiers of the bot owners\n   */\n  owners: z.array(SnowflakeSchema),\n  /**\n   * Array of guild snowflake identifiers where the bot is present\n   */\n  guilds: z.array(SnowflakeSchema),\n  /**\n   * The OAuth2 invite URL of the bot\n   */\n  invite: z.optional(z.string()),\n  /**\n   * The date when the bot was approved on Top.gg in ISO 8601 format\n   */\n  date: ISO8601DateSchema,\n  /**\n   * The amount of servers the bot has according to posted stats.\n   */\n  server_count: z.optional(z.number()),\n  /**\n   * The amount of shards the bot has according to posted stats.\n   */\n  shard_count: z.optional(z.number()),\n  /**\n   * Whether the bot is certified on Top.gg\n   */\n  certifiedBot: z.boolean(),\n  /**\n   * The vanity URL of the bot on Top.gg\n   */\n  vanity: z.optional(z.string()),\n  /**\n   * The amount of upvotes the bot has\n   */\n  points: z.number(),\n  /**\n   * The amount of upvotes the bot has this month\n   */\n  monthlyPoints: z.number(),\n  /**\n   * The guild id for the donatebot setup\n   */\n  donatebotguildid: SnowflakeSchema,\n});\n\n/**\n * Query parameters for searching bots on Top.gg.\n *\n * @see https://docs.top.gg/docs/API/v0/bot#search-bots\n */\nexport const GetSearchBotsQuerySchema = z.object({\n  /**\n   * The amount of bots to return.\n   *\n   * @minimum 1\n   * @maximum 500\n   * @default 50\n   */\n  limit: z.optional(z.number().check(z.minimum(1)).check(z.maximum(500))),\n  /**\n   * The amount of bots to skip (for pagination).\n   *\n   * @minimum 0\n   * @default 0\n   */\n  offset: z.optional(z.number().check(z.minimum(0))),\n  /**\n   * The field to sort the bots by. Prefix with `-` for descending order.\n   *\n   * There is no documented default.\n   */\n  sort: z.string(),\n  /**\n   * Comma separated list of fields to include in the response. If not provided, all fields will be included.\n   */\n  fields: z.optional(z.string()),\n});\n\n/**\n * Response for searching bots on Top.gg.\n */\nexport const GetSearchBotsResponseSchema = z.object({\n  /**\n   * The array of bots that match the search query.\n   */\n  results: z.array(BotSchema),\n  /**\n   * The total number of bots that match the search query.\n   */\n  total: z.number(),\n  /**\n   * The limit used in the query.\n   */\n  limit: z.number(),\n  /**\n   * The amount of bots skipped (for pagination).\n   */\n  offset: z.number(),\n  /**\n   * The amount of items in the current page of results.\n   */\n  count: z.number(),\n});\n\n/**\n * Response for getting a bot.\n *\n * - GET `/bots/:bot_id`\n */\nexport const GetBotResponseSchema = BotSchema;\n\n/**\n * A bot voter.\n */\nexport const BotVoterSchema = z.object({\n  /**\n   * The Discord ID of the user that voted.\n   */\n  id: SnowflakeSchema,\n  /**\n   * The username of the user that voted, including discriminator (e.g., \"wumpus#0000\").\n   */\n  username: z.string(),\n  /**\n   * The avatar hash of the user that voted.\n   */\n  avatar: z.optional(z.string()),\n});\n\n/**\n * Gets the last 1000 voters for your bot.\n *\n * - GET `/bots/:bot_id/votes`\n */\nexport const GetLast1000BotVotesResponseSchema = z.array(BotVoterSchema);\n\n/**\n * Specific stats about a bot.\n *\n * - GET `/bots/:bot_id/stats`\n */\nexport const GetBotStatsResponseSchema = z.object({\n  /**\n   * The amount of servers the bot is in\n   */\n  server_count: z.optional(z.number()),\n  /**\n   * The amount of servers the bot is in per shard. Always present but can be empty.\n   */\n  shards: z.array(z.number()),\n  /**\n   * The amount of shards a bot has according to posted stats.\n   */\n  shard_count: z.optional(z.number()),\n});\n\n/**\n * Query parameters for checking whether or not a user has voted for your bot.\n *\n * - GET `/bots/:bot_id/check`\n */\nexport const GetUserVoteCheckQuerySchema = z.object({\n  /**\n   * The Discord ID of the user to check for a vote.\n   */\n  userId: SnowflakeSchema,\n});\n\n/**\n * Response for checking whether or not a user has voted for your bot.\n *\n * - GET `/bots/:bot_id/check`\n */\nexport const GetUserVoteCheckResponseSchema = z.object({\n  /**\n   * 0 if the user has not voted for this bot in the last 12 hours, 1 if they have.\n   */\n  voted: z.xor([z.literal(0), z.literal(1)]),\n});\n\n/**\n * Request body for posting bot stats.\n */\nexport const PostBotStatsBodySchema = z.object({\n  /**\n   * The amount of servers the bot is in. Required if the bot has less than 100 servers, otherwise optional but recommended.\n   *\n   * If an Array, it acts like shards.\n   */\n  server_count: z.xor([z.number(), z.array(z.number())]),\n  /**\n   * Amount of servers the bot is in per shard.\n   */\n  shards: z.optional(z.array(z.number())),\n  /**\n   * The zero-indexed id of the shard posting. Makes server_count set the shard specific server count.\n   */\n  shard_id: z.optional(z.number()),\n  /**\n   * The amount of shards the bot has.\n   */\n  shard_count: z.optional(z.number()),\n});\n\n// # Users\n\n/**\n * A user on Top.gg.\n *\n * - GET `/users/:user_id`\n */\nexport const UserSchema = z.object({\n  /**\n   * The Discord ID for this user.\n   */\n  id: SnowflakeSchema,\n  /**\n   * The username of the user, not including discriminator (e.g., \"wumpus\").\n   */\n  username: z.string(),\n  /**\n   * The discriminator of the user (legacy Discord feature, e.g., \"0000\").\n   */\n  discriminator: z.string(),\n  /**\n   * The avatar hash of the user's avatar.\n   */\n  avatar: z.optional(z.string()),\n  /**\n   * The cdn hash of the user's avatar if the user has none.\n   */\n  defAvatar: z.optional(z.string()),\n  /**\n   * The bio of the user. This is a short description that the user can set on their profile. It may be empty or null if the user has not set a bio.\n   *\n   * This is NOT their in-discord bio.\n   */\n  bio: z.optional(z.string()),\n  /**\n   * The banner image URL of the user.\n   */\n  banner: z.optional(z.string()),\n  /**\n   * The social usernames of the user\n   */\n  social: z.object({\n    /**\n     * The YouTube channel ID of the user. This is not the full URL, just the channel ID (e.g., \"UC_x5XG1OV2P6uZZ5FSM9Ttw\").\n     */\n    youtube: z.optional(z.string()),\n    /**\n     * The Reddit username of the user (e.g., \"spez\"). This is not the full URL, just the username.\n     */\n    reddit: z.optional(z.string()),\n    /**\n     * The Twitter username of the user (e.g., \"jack\"). This is not the full URL, just the username.\n     */\n    twitter: z.optional(z.string()),\n    /**\n     * The Instagram username of the user (e.g., \"instagram\"). This is not the full URL, just the username.\n     */\n    instagram: z.optional(z.string()),\n    /**\n     * The GitHub username of the user (e.g., \"torvalds\"). This is not the full URL, just the username.\n     */\n    github: z.optional(z.string()),\n  }),\n  /**\n   * The custom hex color of the user (not guaranteed to be valid hex). This is a color that the user can set on their profile.\n   */\n  color: z.optional(z.string()),\n  /**\n   * The supporter status of the user. This is true if the user has voted for any bot in the last month.\n   */\n  supporter: z.boolean(),\n  /**\n   * The certified status of the user.\n   */\n  certifiedDev: z.boolean(),\n  /**\n   * The mod status of the user. This is true if the user is a moderator on Top.gg.\n   */\n  mod: z.boolean(),\n  /**\n   * The website moderator status of the user. This is true if the user is a website moderator on Top.gg.\n   */\n  webMod: z.boolean(),\n  /**\n   * The admin status of the user.\n   */\n  admin: z.boolean(),\n});\n"],"mappings":";;;;;;;;AAQA,MAAa,yBAAyBA,SAAE,KAAK,CAAC,UAAU,OAAO,CAAC;;;;;;AAShE,MAAa,0BAA0BA,SAAE,OAAO;CAI9C,KAAKC;CAIL,MAAMA;CAIN,MAAM;CAIN,WAAWD,SAAE,SAAS;CAOtB,OAAOA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAC9B,CAAC;;;;;;AAOF,MAAa,6BAA6BA,SAAE,OAAO;CAIjD,OAAOC;CAIP,MAAMA;CAIN,MAAM;CAIN,OAAOD,SAAE,SAASA,SAAE,QAAQ,CAAC;CAC9B,CAAC;;;;AAOF,MAAa,YAAYA,SAAE,OAAO;CAIhC,IAAIC;CAIJ,UAAUD,SAAE,QAAQ;CAIpB,eAAeA,SAAE,QAAQ;CAIzB,QAAQA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAI9B,WAAWA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAIjC,QAAQA,SAAE,QAAQ;CAIlB,WAAWA,SAAE,QAAQ;CAIrB,UAAUA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAIhC,MAAMA,SAAE,MAAMA,SAAE,QAAQ,CAAC;CAIzB,SAASA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAI/B,SAASA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAI/B,QAAQA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAI9B,QAAQA,SAAE,MAAMC,mCAAgB;CAIhC,QAAQD,SAAE,MAAMC,mCAAgB;CAIhC,QAAQD,SAAE,SAASA,SAAE,QAAQ,CAAC;CAI9B,MAAME;CAIN,cAAcF,SAAE,SAASA,SAAE,QAAQ,CAAC;CAIpC,aAAaA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAInC,cAAcA,SAAE,SAAS;CAIzB,QAAQA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAI9B,QAAQA,SAAE,QAAQ;CAIlB,eAAeA,SAAE,QAAQ;CAIzB,kBAAkBC;CACnB,CAAC;;;;;;AAOF,MAAa,2BAA2BD,SAAE,OAAO;CAQ/C,OAAOA,SAAE,SAASA,SAAE,QAAQ,CAAC,MAAMA,SAAE,QAAQ,EAAE,CAAC,CAAC,MAAMA,SAAE,QAAQ,IAAI,CAAC,CAAC;CAOvE,QAAQA,SAAE,SAASA,SAAE,QAAQ,CAAC,MAAMA,SAAE,QAAQ,EAAE,CAAC,CAAC;CAMlD,MAAMA,SAAE,QAAQ;CAIhB,QAAQA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAC/B,CAAC;;;;AAKF,MAAa,8BAA8BA,SAAE,OAAO;CAIlD,SAASA,SAAE,MAAM,UAAU;CAI3B,OAAOA,SAAE,QAAQ;CAIjB,OAAOA,SAAE,QAAQ;CAIjB,QAAQA,SAAE,QAAQ;CAIlB,OAAOA,SAAE,QAAQ;CAClB,CAAC;;;;;;AAOF,MAAa,uBAAuB;;;;AAKpC,MAAa,iBAAiBA,SAAE,OAAO;CAIrC,IAAIC;CAIJ,UAAUD,SAAE,QAAQ;CAIpB,QAAQA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAC/B,CAAC;;;;;;AAOF,MAAa,oCAAoCA,SAAE,MAAM,eAAe;;;;;;AAOxE,MAAa,4BAA4BA,SAAE,OAAO;CAIhD,cAAcA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAIpC,QAAQA,SAAE,MAAMA,SAAE,QAAQ,CAAC;CAI3B,aAAaA,SAAE,SAASA,SAAE,QAAQ,CAAC;CACpC,CAAC;;;;;;AAOF,MAAa,8BAA8BA,SAAE,OAAO,EAIlD,QAAQC,oCACT,CAAC;;;;;;AAOF,MAAa,iCAAiCD,SAAE,OAAO,EAIrD,OAAOA,SAAE,IAAI,CAACA,SAAE,QAAQ,EAAE,EAAEA,SAAE,QAAQ,EAAE,CAAC,CAAC,EAC3C,CAAC;;;;AAKF,MAAa,yBAAyBA,SAAE,OAAO;CAM7C,cAAcA,SAAE,IAAI,CAACA,SAAE,QAAQ,EAAEA,SAAE,MAAMA,SAAE,QAAQ,CAAC,CAAC,CAAC;CAItD,QAAQA,SAAE,SAASA,SAAE,MAAMA,SAAE,QAAQ,CAAC,CAAC;CAIvC,UAAUA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAIhC,aAAaA,SAAE,SAASA,SAAE,QAAQ,CAAC;CACpC,CAAC;;;;;;AASF,MAAa,aAAaA,SAAE,OAAO;CAIjC,IAAIC;CAIJ,UAAUD,SAAE,QAAQ;CAIpB,eAAeA,SAAE,QAAQ;CAIzB,QAAQA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAI9B,WAAWA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAMjC,KAAKA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAI3B,QAAQA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAI9B,QAAQA,SAAE,OAAO;EAIf,SAASA,SAAE,SAASA,SAAE,QAAQ,CAAC;EAI/B,QAAQA,SAAE,SAASA,SAAE,QAAQ,CAAC;EAI9B,SAASA,SAAE,SAASA,SAAE,QAAQ,CAAC;EAI/B,WAAWA,SAAE,SAASA,SAAE,QAAQ,CAAC;EAIjC,QAAQA,SAAE,SAASA,SAAE,QAAQ,CAAC;EAC/B,CAAC;CAIF,OAAOA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAI7B,WAAWA,SAAE,SAAS;CAItB,cAAcA,SAAE,SAAS;CAIzB,KAAKA,SAAE,SAAS;CAIhB,QAAQA,SAAE,SAAS;CAInB,OAAOA,SAAE,SAAS;CACnB,CAAC"}