topgg-api-types 0.0.1

package/dist/v0.d.ts

@@ -0,0 +1,407 @@
+import { n as Snowflake, t as ISO8601Date } from "./index-BzCAuhll.js";
+
+//#region src/v0/index.d.ts
+type WebhookEventType = "upvote" | "test";
+/**
+ * @see https://docs.top.gg/docs/Resources/webhooks#bot-webhooks
+ * @deprecated Use `v1` types instead.
+ */
+interface BotWebhookPayload {
+  /**
+   * Discord ID of the bot that received a vote.
+   */
+  bot: Snowflake;
+  /**
+   * Discord ID of the user that voted.
+   */
+  user: Snowflake;
+  /**
+   * The type of the vote (should always be "upvote" except when using the test button it's "test").
+   */
+  type: WebhookEventType;
+  /**
+   * Whether the weekend multiplier is in effect, meaning users votes count as two.
+   */
+  isWeekend: boolean;
+  /**
+   * Query string params found on the /bot/:ID/vote page.
+   *
+   * @example
+   * "?a=1&b=2&c=3"
+   */
+  query?: string;
+}
+/**
+ * @see https://docs.top.gg/docs/Resources/webhooks#server-webhooks
+ * @deprecated Use `v1` types instead.
+ */
+interface ServerWebhookPayload {
+  /**
+   * Discord ID of the server that received a vote.
+   */
+  guild: Snowflake;
+  /**
+   * Discord ID of the user that voted.
+   */
+  user: Snowflake;
+  /**
+   * The type of the vote (should always be "upvote" except when using the test button it's "test").
+   */
+  type: WebhookEventType;
+  /**
+   * Whether the weekend multiplier is in effect, meaning users votes count as two.
+   */
+  query?: string;
+}
+/**
+ * A bot listed on Top.gg.
+ */
+interface Bot {
+  /**
+   * The Discord ID of the bot
+   */
+  id: Snowflake;
+  /**
+   * The username of the bot
+   */
+  username: string;
+  /**
+   * The discriminator of the bot (legacy Discord feature)
+   */
+  discriminator: string;
+  /**
+   * The avatar hash of the bot's avatar
+   */
+  avatar?: string;
+  /**
+   * The cdn hash of the bot's avatar if the bot has none
+   */
+  defAvatar?: string;
+  /**
+   * The command prefix of the bot
+   */
+  prefix: string;
+  /**
+   * The short description of the bot
+   */
+  shortdesc: string;
+  /**
+   * The detailed long description of the bot
+   */
+  longdesc?: string;
+  /**
+   * Array of tags associated with the bot
+   */
+  tags: string[];
+  /**
+   * The official website URL of the bot
+   */
+  website?: string;
+  /**
+   * The support server URL for the bot
+   */
+  support?: string;
+  /**
+   * The GitHub repository URL of the bot
+   */
+  github?: string;
+  /**
+   * Array of snowflake identifiers of the bot owners
+   */
+  owners: Snowflake[];
+  /**
+   * Array of guild snowflake identifiers where the bot is present
+   */
+  guilds: Snowflake[];
+  /**
+   * The OAuth2 invite URL of the bot
+   */
+  invite?: string;
+  /**
+   * The date when the bot was approved on Top.gg in ISO 8601 format
+   */
+  date: ISO8601Date;
+  /**
+   * The amount of servers the bot has according to posted stats.
+   */
+  server_count?: number;
+  /**
+   * The amount of shards the bot has according to posted stats.
+   */
+  shard_count?: number;
+  /**
+   * Whether the bot is certified on Top.gg
+   */
+  certifiedBot: boolean;
+  /**
+   * The vanity URL of the bot on Top.gg
+   */
+  vanity?: string;
+  /**
+   * The amount of upvotes the bot has
+   */
+  points: number;
+  /**
+   * The amount of upvotes the bot has this month
+   */
+  monthlyPoints: number;
+  /**
+   * The guild id for the donatebot setup
+   */
+  donatebotguildid: Snowflake;
+}
+/**
+ * Query parameters for searching bots on Top.gg.
+ *
+ * TODO: there is no documentation on a "search" parameter, but the endpoint is called "search bots" and it would make sense for there to be a search parameter. Need to confirm if this is the case and if so, add it to the types.
+ *
+ * @see https://docs.top.gg/docs/API/v0/bot#search-bots
+ */
+interface GetSearchBotsQuery {
+  /**
+   * The amount of bots to return.
+   *
+   * @minimum 1
+   * @maximum 500
+   * @default 50
+   */
+  limit?: number;
+  /**
+   * The amount of bots to skip (for pagination).
+   *
+   * @minimum 0
+   * @default 0
+   */
+  offset?: number;
+  /**
+   * The field to sort the bots by. Prefix with `-` for descending order.
+   *
+   * There is no documented default.
+   */
+  sort: keyof Bot | `-${keyof Bot}`;
+  /**
+   * Comma separated list of fields to include in the response. If not provided, all fields will be included.
+   */
+  fields?: string;
+}
+interface GetSearchBotsResponse {
+  /**
+   * The array of bots that match the search query.
+   */
+  results: Bot[];
+  /**
+   * The total number of bots that match the search query.
+   */
+  total: number;
+  /**
+   * The limit used in the query.
+   */
+  limit: number;
+  /**
+   * The amount of bots skipped (for pagination).
+   */
+  offset: number;
+  /**
+   * The amount of items in the current page of results.
+   */
+  count: number;
+}
+/**
+ * ### Routes
+ *
+ * - GET `/bots/:bot_id`
+ */
+type GetBotResponse = Bot;
+/**
+ * Gets the last 1000 voters for your bot.
+ *
+ * If your bot receives more than 1000 votes monthly you cannot use this endpoints and must use webhooks and implement your own caching instead.
+ *
+ * This endpoint only returns unique votes, it does not include double votes (weekend votes).
+ *
+ * ### Routes
+ *
+ * - GET `/bots/:bot_id/votes`
+ */
+type GetLast1000BotVotesResponse = {
+  /**
+   * The Discord ID of the user that voted.
+   */
+  id: Snowflake;
+  /**
+   * The username of the user that voted, including discriminator (e.g., "wumpus#0000").
+   *
+   * TODO: It's called "username" but can be uppsercase?? It would be the global_name then.
+   */
+  username: string;
+  /**
+   * The avatar hash of the user that voted.
+   *
+   * TODO: Can be null? Can be undefined? Is it always present? Need to confirm.
+   */
+  avatar?: string;
+}[];
+/**
+ * Specific stats about a bot.
+ *
+ * ### Routes
+ *
+ * - GET `/bots/:bot_id/stats`
+ */
+interface GetBotStatsResponse {
+  /**
+   * The amount of servers the bot is in
+   */
+  server_count?: number;
+  /**
+   * The amount of servers the bot is in per shard. Always present but can be empty.
+   */
+  shards: number[];
+  /**
+   * The amount of shards a bot has according to posted stats.
+   */
+  shard_count?: number;
+}
+/**
+ * Checking whether or not a user has voted for your bot. Safe to use even if you have over 1k monthly votes.
+ *
+ * ### Routes
+ *
+ * - GET `/bots/:bot_id/check`
+ */
+interface GetUserVoteCheckQuery {
+  /**
+   * The Discord ID of the user to check for a vote.
+   */
+  userId: Snowflake;
+}
+/**
+ * The response from checking whether or not a user has voted for your bot.
+ *
+ * ### Routes
+ *
+ * - GET `/bots/:bot_id/check`
+ */
+interface GetUserVoteCheckResponse {
+  /**
+   * 0 if the user has not voted for this bot in the last 12 hours, 1 if they have.
+   */
+  voted: 0 | 1;
+}
+interface PostBotStatsBody {
+  /**
+   * The amount of servers the bot is in. Required if the bot has less than 100 servers, otherwise optional but recommended.
+   *
+   * If an Array, it acts like shards.
+   */
+  server_count: number | number[];
+  /**
+   * Amount of servers the bot is in per shard.
+   */
+  shards?: number[];
+  /**
+   * The zero-indexed id of the shard posting. Makes server_count set the shard specific server count.
+   */
+  shard_id?: number;
+  /**
+   * The amount of shards the bot has.
+   */
+  shard_count?: number;
+}
+/**
+ * A user on Top.gg
+ *
+ * ### Routes
+ *
+ * - GET `/users/:user_id`
+ */
+interface User {
+  /**
+   * The Discord ID for this user.
+   */
+  id: Snowflake;
+  /**
+   * The username of the user, not including discriminator (e.g., "wumpus").
+   */
+  username: string;
+  /**
+   * The discriminator of the user (legacy Discord feature, e.g., "0000").
+   */
+  discriminator: string;
+  /**
+   * The avatar hash of the user's avatar.
+   */
+  avatar?: string;
+  /**
+   * The cdn hash of the user's avatar if the user has none.
+   */
+  defAvatar?: string;
+  /**
+   * 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.
+   *
+   * This is NOT their in-discord bio.
+   */
+  bio?: string;
+  /**
+   * The banner image URL of the user.
+   */
+  banner?: string;
+  /**
+   * The social usernames of the user
+   */
+  social: {
+    /**
+     * The YouTube channel ID of the user. This is not the full URL, just the channel ID (e.g., "UC_x5XG1OV2P6uZZ5FSM9Ttw").
+     */
+    youtube?: string;
+    /**
+     * The Reddit username of the user (e.g., "spez"). This is not the full URL, just the username.
+     */
+    reddit?: string;
+    /**
+     * The Twitter username of the user (e.g., "jack"). This is not the full URL, just the username.
+     */
+    twitter?: string;
+    /**
+     * The Instagram username of the user (e.g., "instagram"). This is not the full URL, just the username.
+     */
+    instagram?: string;
+    /**
+     * The GitHub username of the user (e.g., "torvalds"). This is not the full URL, just the username.
+     */
+    github?: string;
+  };
+  /**
+   * 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.
+   */
+  color?: string;
+  /**
+   * The supporter status of the user. This is true if the user has voted for any bot in the last month.
+   *
+   * TODO: Clarify what "supporter" means in this context. It may refer to users who have voted for any bot in the last month, but this is not explicitly stated in the documentation.
+   */
+  supporter: boolean;
+  /**
+   * The certified status of the user.
+   *
+   * TODO: Clarify what "certified" means in this context. It may refer to users who are certified bot developers or top.gg staff, but this is not explicitly stated in the documentation.
+   */
+  certifiedDev: boolean;
+  /**
+   * The mod status of the user. This is true if the user is a moderator on Top.gg.
+   */
+  mod: boolean;
+  /**
+   * The website moderator status of the user. This is true if the user is a website moderator on Top.gg.
+   */
+  webMod: boolean;
+  /**
+   * The admin status of the user.
+   *
+   * TODO: Clarify what "admin" means in this context. It may refer to users who are administrators on Top.gg, but this is not explicitly stated in the documentation.
+   */
+  admin: boolean;
+}
+//#endregion
+export { Bot, BotWebhookPayload, GetBotResponse, GetBotStatsResponse, GetLast1000BotVotesResponse, GetSearchBotsQuery, GetSearchBotsResponse, GetUserVoteCheckQuery, GetUserVoteCheckResponse, PostBotStatsBody, ServerWebhookPayload, User, WebhookEventType };
+//# sourceMappingURL=v0.d.ts.map

package/dist/v1/validators.cjs

@@ -0,0 +1,231 @@
+const require_validators = require('../validators-B3dxgWHu.cjs');
+let zod_mini = require("zod/mini");
+zod_mini = require_validators.__toESM(zod_mini);
+
+//#region src/v1/validators.ts
+/**
+* The type of a webhook event. This is used to identify the type of the event that is being delivered to your webhook endpoint.
+*
+* Not all webhook events are allowed to be set by an integration - use the `IntegrationSupportedWebhookScopesSchema` to find out which events you can subscribe to as an integration.
+*/
+const WebhookEventTypeSchema = zod_mini.enum([
+	"webhook.test",
+	"integration.create",
+	"integration.delete",
+	"vote.create"
+]);
+/**
+* The type of a project helps top.gg synchronize features.
+* For example, a discord bot may have a support server, but this would not make any sense for a discord server.
+*
+* You can use this to further find out the specificity of the project.
+*/
+const ProjectTypeSchema = zod_mini.enum([
+	"bot",
+	"server",
+	"game"
+]);
+/**
+* A Platform is used to identify where the corresponding ID links towards.
+*/
+const ProjectPlatformTypeSchema = zod_mini.enum(["discord", "roblox"]);
+/**
+* A User Source is an enum that represents a user account from an external platform that is linked to a Top.gg user account.
+* Each source has a unique identifer type that we might validate against.
+*
+* If none is passed to any endpoint that accepts a source parameter, it will default to topgg.
+*/
+const UserSourceSchema = zod_mini.enum(["discord", "topgg"]);
+/**
+* Webhook scopes that are supported for integrations.
+*/
+const IntegrationSupportedWebhookScopesSchema = zod_mini.enum(["webhook.test", "vote.create"]);
+/**
+* All error responses follow the [`application/problem+json`](https://datatracker.ietf.org/doc/html/rfc7807) specification.
+*/
+const ErrorSchema = zod_mini.object({
+	type: zod_mini.string(),
+	title: zod_mini.string(),
+	status: zod_mini.number(),
+	detail: zod_mini.string()
+});
+/**
+* Represents a user on Top.gg.
+*/
+const UserSchema = zod_mini.object({
+	id: require_validators.SnowflakeSchema,
+	platform_id: require_validators.SnowflakeSchema,
+	name: zod_mini.string(),
+	avatar_url: zod_mini.url()
+});
+/**
+* Base project information shared across all project-related responses.
+*/
+const BaseProjectSchema = zod_mini.object({
+	id: require_validators.SnowflakeSchema,
+	platform: ProjectPlatformTypeSchema,
+	platform_id: require_validators.SnowflakeSchema,
+	type: ProjectTypeSchema
+});
+/**
+* Represents a vote on Top.gg.
+*/
+const VoteSchema = zod_mini.object({
+	user_id: require_validators.SnowflakeSchema,
+	platform_id: require_validators.SnowflakeSchema,
+	weight: zod_mini.number(),
+	created_at: require_validators.ISO8601DateSchema,
+	expires_at: require_validators.ISO8601DateSchema
+});
+/**
+* Represents a vote for a specific project.
+*/
+const ProjectVoteSchema = zod_mini.clone(VoteSchema);
+const WebhookPayloadBaseSchema = (type, data) => zod_mini.object({
+	type: zod_mini.literal(type),
+	data
+});
+/**
+* Data included when an integration connection is created.
+*/
+const IntegrationCreateDataSchema = zod_mini.object({
+	connection_id: require_validators.SnowflakeSchema,
+	webhook_secret: zod_mini.string().check(zod_mini.regex(/^whs_[a-zA-Z0-9]+$/, "Invalid webhook secret")),
+	project: BaseProjectSchema,
+	user: UserSchema
+});
+/**
+* The payload delivered to your webhook endpoint when an integration connection is created.
+* This will be sent if a user clicks "Connect" for your integration on the dashboard.
+*
+* @see https://docs.top.gg/docs/API/v1/integrations#2-topgg-sends-integrationcreate
+*/
+const IntegrationCreateWebhookPayloadSchema = WebhookPayloadBaseSchema("integration.create", IntegrationCreateDataSchema);
+/**
+* The response you must return from your webhook endpoint when you receive an `integration.create` event.
+* This tells Top.gg where to deliver webhook events for this integration connection and which events to deliver.
+*
+* @see https://docs.top.gg/docs/API/v1/integrations#3-respond-with-configuration
+*/
+const IntegrationCreateResponseSchema = zod_mini.object({
+	webhook_url: zod_mini.url(),
+	routes: zod_mini.array(IntegrationSupportedWebhookScopesSchema).check(zod_mini.refine((arr) => arr.length === new Set(arr).size, "Duplicate webhook scopes are not allowed"))
+});
+/**
+* Data included when an integration connection is deleted.
+*/
+const IntegrationDeleteDataSchema = zod_mini.object({ connection_id: require_validators.SnowflakeSchema });
+/**
+* The payload delivered to your webhook endpoint when an integration connection is deleted.
+*/
+const IntegrationDeleteWebhookPayloadSchema = WebhookPayloadBaseSchema("integration.delete", IntegrationDeleteDataSchema);
+/**
+* Data included when a vote is created.
+*/
+const VoteCreateDataSchema = zod_mini.extend(VoteSchema, {
+	project: BaseProjectSchema,
+	user: UserSchema
+});
+/**
+* The payload delivered to your webhook endpoint when a user votes for your project and you have subscribed to the `vote.create` event.
+*/
+const VoteCreateWebhookPayloadSchema = WebhookPayloadBaseSchema("vote.create", VoteCreateDataSchema);
+/**
+* Data included in a webhook test event.
+*/
+const WebhookTestDataSchema = zod_mini.object({
+	user: UserSchema,
+	project: BaseProjectSchema
+});
+/**
+* The payload delivered to your webhook endpoint when you send a test webhook from the dashboard or via the API.
+*/
+const WebhookTestWebhookPayloadSchema = WebhookPayloadBaseSchema("webhook.test", WebhookTestDataSchema);
+/**
+* Response schema for getting the authenticated project.
+*
+* - GET `/v1/projects/@me`
+*
+* @see https://docs.top.gg/docs/API/v1/projects#get-current-project
+*/
+const GetProjectResponseSchema = zod_mini.extend(BaseProjectSchema, {
+	name: zod_mini.string(),
+	headline: zod_mini.string(),
+	tags: zod_mini.array(zod_mini.string()),
+	votes: zod_mini.number(),
+	votes_total: zod_mini.number(),
+	review_score: zod_mini.number(),
+	review_count: zod_mini.number()
+});
+/**
+* Query parameters for getting project votes.
+*
+* - GET `/v1/projects/@me/votes`
+*
+* Either `cursor` or `startDate` must be provided.
+*
+* @see https://docs.top.gg/docs/API/v1/projects/#get-votes
+*/
+const GetProjectVotesQuerySchema = zod_mini.object({
+	cursor: zod_mini.optional(zod_mini.string()),
+	startDate: zod_mini.optional(require_validators.ISO8601DateSchema)
+}).check(zod_mini.refine((data) => data.cursor || data.startDate, "Either cursor or startDate must be provided"));
+/**
+* Response schema for the Get Project Votes endpoint.
+*
+* - GET `/v1/projects/@me/votes`
+*
+* @see https://docs.top.gg/docs/API/v1/projects/#get-votes
+*/
+const GetProjectVotesResponseSchema = zod_mini.object({
+	cursor: zod_mini.string(),
+	data: zod_mini.array(ProjectVoteSchema)
+});
+/**
+* Query parameters for getting vote status by user.
+*
+* - GET `/v1/projects/@me/votes/:user_id`
+*
+* @see https://docs.top.gg/docs/API/v1/projects/#get-vote-status-by-user
+*/
+const GetVoteStatusByUserQuerySchema = zod_mini.object({ source: zod_mini.optional(UserSourceSchema) });
+/**
+* Response schema for the Get Vote Status By User endpoint.
+*
+* - GET `/v1/projects/@me/votes/:user_id`
+*
+* @see https://docs.top.gg/docs/API/v1/projects/#get-vote-status-by-user
+*/
+const GetVoteStatusByUserResponseSchema = zod_mini.object({
+	created_at: require_validators.ISO8601DateSchema,
+	expires_at: require_validators.ISO8601DateSchema,
+	weight: zod_mini.number()
+});
+
+//#endregion
+exports.BaseProjectSchema = BaseProjectSchema;
+exports.ErrorSchema = ErrorSchema;
+exports.GetProjectResponseSchema = GetProjectResponseSchema;
+exports.GetProjectVotesQuerySchema = GetProjectVotesQuerySchema;
+exports.GetProjectVotesResponseSchema = GetProjectVotesResponseSchema;
+exports.GetVoteStatusByUserQuerySchema = GetVoteStatusByUserQuerySchema;
+exports.GetVoteStatusByUserResponseSchema = GetVoteStatusByUserResponseSchema;
+exports.IntegrationCreateDataSchema = IntegrationCreateDataSchema;
+exports.IntegrationCreateResponseSchema = IntegrationCreateResponseSchema;
+exports.IntegrationCreateWebhookPayloadSchema = IntegrationCreateWebhookPayloadSchema;
+exports.IntegrationDeleteDataSchema = IntegrationDeleteDataSchema;
+exports.IntegrationDeleteWebhookPayloadSchema = IntegrationDeleteWebhookPayloadSchema;
+exports.IntegrationSupportedWebhookScopesSchema = IntegrationSupportedWebhookScopesSchema;
+exports.ProjectPlatformTypeSchema = ProjectPlatformTypeSchema;
+exports.ProjectTypeSchema = ProjectTypeSchema;
+exports.ProjectVoteSchema = ProjectVoteSchema;
+exports.UserSchema = UserSchema;
+exports.UserSourceSchema = UserSourceSchema;
+exports.VoteCreateDataSchema = VoteCreateDataSchema;
+exports.VoteCreateWebhookPayloadSchema = VoteCreateWebhookPayloadSchema;
+exports.VoteSchema = VoteSchema;
+exports.WebhookEventTypeSchema = WebhookEventTypeSchema;
+exports.WebhookPayloadBaseSchema = WebhookPayloadBaseSchema;
+exports.WebhookTestDataSchema = WebhookTestDataSchema;
+exports.WebhookTestWebhookPayloadSchema = WebhookTestWebhookPayloadSchema;
+//# sourceMappingURL=validators.cjs.map

package/dist/v1/validators.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.cjs","names":["z","SnowflakeSchema","ISO8601DateSchema"],"sources":["../../src/v1/validators.ts"],"sourcesContent":["import * as z from \"zod/mini\";\nimport { ISO8601DateSchema, SnowflakeSchema } from \"@utils/validators\";\n\n// # General and Base Schemas\n\n// ## Enums and Constants\n\n/**\n * The type of a webhook event. This is used to identify the type of the event that is being delivered to your webhook endpoint.\n *\n * Not all webhook events are allowed to be set by an integration - use the `IntegrationSupportedWebhookScopesSchema` to find out which events you can subscribe to as an integration.\n */\nexport const WebhookEventTypeSchema = z.enum([\n  \"webhook.test\",\n  \"integration.create\",\n  \"integration.delete\",\n  \"vote.create\",\n]);\n\n/**\n * The type of a project helps top.gg synchronize features.\n * For example, a discord bot may have a support server, but this would not make any sense for a discord server.\n *\n * You can use this to further find out the specificity of the project.\n */\nexport const ProjectTypeSchema = z.enum([\"bot\", \"server\", \"game\"]);\n\n/**\n * A Platform is used to identify where the corresponding ID links towards.\n */\nexport const ProjectPlatformTypeSchema = z.enum([\"discord\", \"roblox\"]);\n\n/**\n * A User Source is an enum that represents a user account from an external platform that is linked to a Top.gg user account.\n * Each source has a unique identifer type that we might validate against.\n *\n * If none is passed to any endpoint that accepts a source parameter, it will default to topgg.\n */\nexport const UserSourceSchema = z.enum([\"discord\", \"topgg\"]);\n\n/**\n * Webhook scopes that are supported for integrations.\n */\nexport const IntegrationSupportedWebhookScopesSchema = z.enum([\"webhook.test\", \"vote.create\"]);\n\n/**\n * All error responses follow the [`application/problem+json`](https://datatracker.ietf.org/doc/html/rfc7807) specification.\n */\nexport const ErrorSchema = z.object({\n  type: z.string(),\n  title: z.string(),\n  status: z.number(),\n  detail: z.string(),\n});\n\n/**\n * Represents a user on Top.gg.\n */\nexport const UserSchema = z.object({\n  /**\n   * The user's Top.gg ID.\n   */\n  id: SnowflakeSchema,\n  /**\n   * The user's platform ID (e.g., Discord ID).\n   */\n  platform_id: SnowflakeSchema,\n  /**\n   * The user's username.\n   */\n  name: z.string(),\n  /**\n   * The URL of the user's avatar.\n   */\n  avatar_url: z.url(),\n});\n\n/**\n * Base project information shared across all project-related responses.\n */\nexport const BaseProjectSchema = z.object({\n  /**\n   * The project's Top.gg ID.\n   */\n  id: SnowflakeSchema,\n  /**\n   * The platform the project is on (e.g., \"discord\").\n   */\n  platform: ProjectPlatformTypeSchema,\n  /**\n   * The platform-specific ID of the project (e.g., Discord Bot ID).\n   */\n  platform_id: SnowflakeSchema,\n  /**\n   * The type of project (e.g., \"bot\").\n   */\n  type: ProjectTypeSchema,\n});\n\n/**\n * Represents a vote on Top.gg.\n */\nexport const VoteSchema = z.object({\n  /**\n   * The Top.gg ID of the user who voted.\n   */\n  user_id: SnowflakeSchema,\n  /**\n   * The user's ID on the project's platform (e.g., Discord ID).\n   */\n  platform_id: SnowflakeSchema,\n  /**\n   * The amount of votes this vote counted for.\n   */\n  weight: z.number(),\n  /**\n   * The timestamp of when the user voted.\n   */\n  created_at: ISO8601DateSchema,\n  /**\n   * The timestamp of when the vote expires (i.e., when the user can vote again).\n   * This is typically 12 hours after the `created_at` timestamp, but may vary based on the user's voting history and other factors.\n   */\n  expires_at: ISO8601DateSchema,\n});\n\n/**\n * Represents a vote for a specific project.\n */\nexport const ProjectVoteSchema = z.clone(VoteSchema);\n\nexport const WebhookPayloadBaseSchema = <\n  T extends z.infer<typeof WebhookEventTypeSchema>,\n  Data extends z.ZodMiniObject,\n>(\n  type: T,\n  data: Data\n) =>\n  z.object({\n    type: z.literal(type),\n    data: data,\n  });\n\n// # Specific Schemas\n\n// ## Integration Schemas\n\n/**\n * Data included when an integration connection is created.\n */\nexport const IntegrationCreateDataSchema = z.object({\n  /**\n   * The unique identifier for this integration connection.\n   */\n  connection_id: SnowflakeSchema,\n  /**\n   * The webhook secret used to verify webhook requests from Top.gg for this connection.\n   */\n  webhook_secret: z.string().check(z.regex(/^whs_[a-zA-Z0-9]+$/, \"Invalid webhook secret\")),\n  /**\n   * The project this integration is connected to.\n   */\n  project: BaseProjectSchema,\n  /**\n   * The user who created this integration connection.\n   */\n  user: UserSchema,\n});\n\n/**\n * The payload delivered to your webhook endpoint when an integration connection is created.\n * This will be sent if a user clicks \"Connect\" for your integration on the dashboard.\n *\n * @see https://docs.top.gg/docs/API/v1/integrations#2-topgg-sends-integrationcreate\n */\nexport const IntegrationCreateWebhookPayloadSchema = WebhookPayloadBaseSchema(\n  \"integration.create\",\n  IntegrationCreateDataSchema\n);\n\n/**\n * The response you must return from your webhook endpoint when you receive an `integration.create` event.\n * This tells Top.gg where to deliver webhook events for this integration connection and which events to deliver.\n *\n * @see https://docs.top.gg/docs/API/v1/integrations#3-respond-with-configuration\n */\nexport const IntegrationCreateResponseSchema = z.object({\n  /**\n   * The URL where Top.gg should deliver webhook events for this connection.\n   */\n  webhook_url: z.url(),\n  /**\n   * An array of webhook scopes to subscribe to.\n   *\n   * @see https://docs.top.gg/docs/API/v1/webhooks#supported-scopes\n   */\n  routes: z\n    .array(IntegrationSupportedWebhookScopesSchema)\n    .check(\n      z.refine(\n        (arr) => arr.length === new Set(arr).size,\n        \"Duplicate webhook scopes are not allowed\"\n      )\n    ),\n});\n\n/**\n * Data included when an integration connection is deleted.\n */\nexport const IntegrationDeleteDataSchema = z.object({\n  /**\n   * The unique identifier for the integration connection that was deleted.\n   */\n  connection_id: SnowflakeSchema,\n});\n\n/**\n * The payload delivered to your webhook endpoint when an integration connection is deleted.\n */\nexport const IntegrationDeleteWebhookPayloadSchema = WebhookPayloadBaseSchema(\n  \"integration.delete\",\n  IntegrationDeleteDataSchema\n);\n\n// ## Vote Schemas\n\n/**\n * Data included when a vote is created.\n */\nexport const VoteCreateDataSchema = z.extend(VoteSchema, {\n  /**\n   * The project that was voted for.\n   */\n  project: BaseProjectSchema,\n  /**\n   * The user who voted.\n   */\n  user: UserSchema,\n});\n\n/**\n * The payload delivered to your webhook endpoint when a user votes for your project and you have subscribed to the `vote.create` event.\n */\nexport const VoteCreateWebhookPayloadSchema = WebhookPayloadBaseSchema(\n  \"vote.create\",\n  VoteCreateDataSchema\n);\n\n// ## Webhook Test Schemas\n\n/**\n * Data included in a webhook test event.\n */\nexport const WebhookTestDataSchema = z.object({\n  /**\n   * A test user.\n   */\n  user: UserSchema,\n  /**\n   * A test project.\n   */\n  project: BaseProjectSchema,\n});\n\n/**\n * The payload delivered to your webhook endpoint when you send a test webhook from the dashboard or via the API.\n */\nexport const WebhookTestWebhookPayloadSchema = WebhookPayloadBaseSchema(\n  \"webhook.test\",\n  WebhookTestDataSchema\n);\n\n// ## Project Schemas\n\n/**\n * Response schema for getting the authenticated project.\n *\n * - GET `/v1/projects/@me`\n *\n * @see https://docs.top.gg/docs/API/v1/projects#get-current-project\n */\nexport const GetProjectResponseSchema = z.extend(BaseProjectSchema, {\n  /**\n   * The project's name.\n   */\n  name: z.string(),\n  /**\n   * The project's headline/tagline.\n   */\n  headline: z.string(),\n  /**\n   * Tags associated with the project.\n   */\n  tags: z.array(z.string()),\n  /**\n   * The number of votes this month.\n   */\n  votes: z.number(),\n  /**\n   * The total number of votes all time.\n   */\n  votes_total: z.number(),\n  /**\n   * The average review score.\n   */\n  review_score: z.number(),\n  /**\n   * The number of reviews.\n   */\n  review_count: z.number(),\n});\n\n/**\n * Query parameters for getting project votes.\n *\n * - GET `/v1/projects/@me/votes`\n *\n * Either `cursor` or `startDate` must be provided.\n *\n * @see https://docs.top.gg/docs/API/v1/projects/#get-votes\n */\nexport const GetProjectVotesQuerySchema = z\n  .object({\n    /**\n     * Pagination cursor for fetching the next page of votes. if provided, `startDate` is ignored.\n     *\n     * From the previous response.\n     */\n    cursor: z.optional(z.string()),\n    /**\n     * The start date for fetching votes. Only votes created after this date will be returned. Required if `cursor` is not provided.\n     *\n     * Maximum 1 year in the past.\n     *\n     * ISO 8601 date string.\n     */\n    startDate: z.optional(ISO8601DateSchema),\n  })\n  .check(\n    z.refine((data) => data.cursor || data.startDate, \"Either cursor or startDate must be provided\")\n  );\n\n/**\n * Response schema for the Get Project Votes endpoint.\n *\n * - GET `/v1/projects/@me/votes`\n *\n * @see https://docs.top.gg/docs/API/v1/projects/#get-votes\n */\nexport const GetProjectVotesResponseSchema = z.object({\n  /**\n   * Cursor for fetching the next page of votes.\n   */\n  cursor: z.string(),\n  /**\n   * An array of votes for the project.\n   */\n  data: z.array(ProjectVoteSchema),\n});\n\n/**\n * Query parameters for getting vote status by user.\n *\n * - GET `/v1/projects/@me/votes/:user_id`\n *\n * @see https://docs.top.gg/docs/API/v1/projects/#get-vote-status-by-user\n */\nexport const GetVoteStatusByUserQuerySchema = z.object({\n  /**\n   * The source of the user ID. Defaults to \"topgg\".\n   */\n  source: z.optional(UserSourceSchema),\n});\n\n/**\n * Response schema for the Get Vote Status By User endpoint.\n *\n * - GET `/v1/projects/@me/votes/:user_id`\n *\n * @see https://docs.top.gg/docs/API/v1/projects/#get-vote-status-by-user\n */\nexport const GetVoteStatusByUserResponseSchema = z.object({\n  /**\n   * The timestamp of when the user last voted.\n   */\n  created_at: ISO8601DateSchema,\n  /**\n   * The timestamp of when the user's vote expires (i.e., when they can vote again).\n   */\n  expires_at: ISO8601DateSchema,\n  /**\n   * The amount of votes this vote counted for.\n   */\n  weight: z.number(),\n});\n"],"mappings":";;;;;;;;;;AAYA,MAAa,yBAAyBA,SAAE,KAAK;CAC3C;CACA;CACA;CACA;CACD,CAAC;;;;;;;AAQF,MAAa,oBAAoBA,SAAE,KAAK;CAAC;CAAO;CAAU;CAAO,CAAC;;;;AAKlE,MAAa,4BAA4BA,SAAE,KAAK,CAAC,WAAW,SAAS,CAAC;;;;;;;AAQtE,MAAa,mBAAmBA,SAAE,KAAK,CAAC,WAAW,QAAQ,CAAC;;;;AAK5D,MAAa,0CAA0CA,SAAE,KAAK,CAAC,gBAAgB,cAAc,CAAC;;;;AAK9F,MAAa,cAAcA,SAAE,OAAO;CAClC,MAAMA,SAAE,QAAQ;CAChB,OAAOA,SAAE,QAAQ;CACjB,QAAQA,SAAE,QAAQ;CAClB,QAAQA,SAAE,QAAQ;CACnB,CAAC;;;;AAKF,MAAa,aAAaA,SAAE,OAAO;CAIjC,IAAIC;CAIJ,aAAaA;CAIb,MAAMD,SAAE,QAAQ;CAIhB,YAAYA,SAAE,KAAK;CACpB,CAAC;;;;AAKF,MAAa,oBAAoBA,SAAE,OAAO;CAIxC,IAAIC;CAIJ,UAAU;CAIV,aAAaA;CAIb,MAAM;CACP,CAAC;;;;AAKF,MAAa,aAAaD,SAAE,OAAO;CAIjC,SAASC;CAIT,aAAaA;CAIb,QAAQD,SAAE,QAAQ;CAIlB,YAAYE;CAKZ,YAAYA;CACb,CAAC;;;;AAKF,MAAa,oBAAoBF,SAAE,MAAM,WAAW;AAEpD,MAAa,4BAIX,MACA,SAEAA,SAAE,OAAO;CACP,MAAMA,SAAE,QAAQ,KAAK;CACf;CACP,CAAC;;;;AASJ,MAAa,8BAA8BA,SAAE,OAAO;CAIlD,eAAeC;CAIf,gBAAgBD,SAAE,QAAQ,CAAC,MAAMA,SAAE,MAAM,sBAAsB,yBAAyB,CAAC;CAIzF,SAAS;CAIT,MAAM;CACP,CAAC;;;;;;;AAQF,MAAa,wCAAwC,yBACnD,sBACA,4BACD;;;;;;;AAQD,MAAa,kCAAkCA,SAAE,OAAO;CAItD,aAAaA,SAAE,KAAK;CAMpB,QAAQA,SACL,MAAM,wCAAwC,CAC9C,MACCA,SAAE,QACC,QAAQ,IAAI,WAAW,IAAI,IAAI,IAAI,CAAC,MACrC,2CACD,CACF;CACJ,CAAC;;;;AAKF,MAAa,8BAA8BA,SAAE,OAAO,EAIlD,eAAeC,oCAChB,CAAC;;;;AAKF,MAAa,wCAAwC,yBACnD,sBACA,4BACD;;;;AAOD,MAAa,uBAAuBD,SAAE,OAAO,YAAY;CAIvD,SAAS;CAIT,MAAM;CACP,CAAC;;;;AAKF,MAAa,iCAAiC,yBAC5C,eACA,qBACD;;;;AAOD,MAAa,wBAAwBA,SAAE,OAAO;CAI5C,MAAM;CAIN,SAAS;CACV,CAAC;;;;AAKF,MAAa,kCAAkC,yBAC7C,gBACA,sBACD;;;;;;;;AAWD,MAAa,2BAA2BA,SAAE,OAAO,mBAAmB;CAIlE,MAAMA,SAAE,QAAQ;CAIhB,UAAUA,SAAE,QAAQ;CAIpB,MAAMA,SAAE,MAAMA,SAAE,QAAQ,CAAC;CAIzB,OAAOA,SAAE,QAAQ;CAIjB,aAAaA,SAAE,QAAQ;CAIvB,cAAcA,SAAE,QAAQ;CAIxB,cAAcA,SAAE,QAAQ;CACzB,CAAC;;;;;;;;;;AAWF,MAAa,6BAA6BA,SACvC,OAAO;CAMN,QAAQA,SAAE,SAASA,SAAE,QAAQ,CAAC;CAQ9B,WAAWA,SAAE,SAASE,qCAAkB;CACzC,CAAC,CACD,MACCF,SAAE,QAAQ,SAAS,KAAK,UAAU,KAAK,WAAW,8CAA8C,CACjG;;;;;;;;AASH,MAAa,gCAAgCA,SAAE,OAAO;CAIpD,QAAQA,SAAE,QAAQ;CAIlB,MAAMA,SAAE,MAAM,kBAAkB;CACjC,CAAC;;;;;;;;AASF,MAAa,iCAAiCA,SAAE,OAAO,EAIrD,QAAQA,SAAE,SAAS,iBAAiB,EACrC,CAAC;;;;;;;;AASF,MAAa,oCAAoCA,SAAE,OAAO;CAIxD,YAAYE;CAIZ,YAAYA;CAIZ,QAAQF,SAAE,QAAQ;CACnB,CAAC"}