chore(release): 0.33.1 🎉 (#451)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-06-03 17:30:10 +00:00 · 2022-05-26 14:26:26 +02:00
parent 5108d3dcca
commit 4083a32340
10 changed files with 275561 additions and 4 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,14 @@
+## [0.33.1](https://github.com/discordjs/discord-api-types/compare/0.33.0...0.33.1) (2022-05-26)
+
+### Bug Fixes
+
+- **RESTPostAPIApplicationGuildCommands:** correct types due to unions ([#447](https://github.com/discordjs/discord-api-types/issues/447)) ([6d85ad6](https://github.com/discordjs/discord-api-types/commit/6d85ad6b1d707b980f9897ea68dd4b7573b3a770))
+
+### Features
+
+- **RESTJSONErrorCodes:** add error `50600` ([#444](https://github.com/discordjs/discord-api-types/issues/444)) ([5ef49f4](https://github.com/discordjs/discord-api-types/commit/5ef49f41cecaa1d5937428a5c58f1d88bfc61266))
+- **RESTPostAPIGuildChannels:** update post body fields ([#419](https://github.com/discordjs/discord-api-types/issues/419)) ([748db34](https://github.com/discordjs/discord-api-types/commit/748db34e30338cf4a9fd8ce7b86d1d5c7dde63b1))
+
 # [0.33.0](https://github.com/discordjs/discord-api-types/compare/0.32.1...0.33.0) (2022-05-16)

 ### Code Refactoring
--- a/deno/CHANGELOG.md
+++ b/deno/CHANGELOG.md
@@ -1,3 +1,14 @@
+## [0.33.1](https://github.com/discordjs/discord-api-types/compare/0.33.0...0.33.1) (2022-05-26)
+
+### Bug Fixes
+
+- **RESTPostAPIApplicationGuildCommands:** correct types due to unions ([#447](https://github.com/discordjs/discord-api-types/issues/447)) ([6d85ad6](https://github.com/discordjs/discord-api-types/commit/6d85ad6b1d707b980f9897ea68dd4b7573b3a770))
+
+### Features
+
+- **RESTJSONErrorCodes:** add error `50600` ([#444](https://github.com/discordjs/discord-api-types/issues/444)) ([5ef49f4](https://github.com/discordjs/discord-api-types/commit/5ef49f41cecaa1d5937428a5c58f1d88bfc61266))
+- **RESTPostAPIGuildChannels:** update post body fields ([#419](https://github.com/discordjs/discord-api-types/issues/419)) ([748db34](https://github.com/discordjs/discord-api-types/commit/748db34e30338cf4a9fd8ce7b86d1d5c7dde63b1))
+
 # [0.33.0](https://github.com/discordjs/discord-api-types/compare/0.32.1...0.33.0) (2022-05-16)

 ### Code Refactoring
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
 {
 	"name": "discord-api-types",
-	"version": "0.33.0",
+	"version": "0.33.1",
 	"lockfileVersion": 2,
 	"requires": true,
 	"packages": {
 		"": {
 			"name": "discord-api-types",
-			"version": "0.33.0",
+			"version": "0.33.1",
 			"license": "MIT",
 			"devDependencies": {
 				"@babel/runtime-corejs3": "^7.18.0",
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "discord-api-types",
-	"version": "0.33.0",
+	"version": "0.33.1",
 	"description": "Discord API typings that are kept up to date for use in bot library creation.",
 	"exports": {
 		"./globals": {
--- a/website/versioned_docs/version-0.33.1/Contributing.mdx
+++ b/website/versioned_docs/version-0.33.1/Contributing.mdx
@@ -0,0 +1,11 @@
+---
+id: contributing_to_discord-api-types
+title: How to Contribute
+sidebar_position: 1
+---
+
+:::caution Keep in mind!
+
+This page is WIP. It will be built up to explain how you can contribute to Discord API Types, and what to keep in mind!
+
+:::
--- a/website/versioned_docs/version-0.33.1/Introduction.mdx
+++ b/website/versioned_docs/version-0.33.1/Introduction.mdx
@@ -0,0 +1,167 @@
+---
+id: introduction_to_discord-api-types
+title: Introduction
+sidebar_position: 0
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<div align="center">
+
+<img src="/svgs/logo_long_blurple.svg" className="markdown__logo" />
+
+[![Discord server](https://img.shields.io/discord/222078108977594368?color=5865F2&logo=discord&logoColor=white)](https://discord-api-types.dev/discord)
+[![Patreon Donate](https://img.shields.io/badge/patreon-donate-brightgreen.svg?label=Donate%20with%20Patreon&logo=patreon&colorB=F96854&link=https://www.patreon.com/vladfrangu)](https://www.patreon.com/vladfrangu)
+[![Ko-fi Donate](https://img.shields.io/badge/kofi-donate-brightgreen.svg?label=Donate%20with%20Ko-fi&logo=ko-fi&colorB=F16061&link=https://ko-fi.com/wolfgalvlad&logoColor=FFFFFF)](https://ko-fi.com/wolfgalvlad)
+[![GitHub Sponsors](https://img.shields.io/badge/patreon-donate-brightgreen.svg?label=Sponsor%20through%20GitHub&logo=github&colorB=F96854&link=https://github.com/sponsors/vladfrangu)](https://github.com/sponsors/vladfrangu)
+
+[![npm version](https://img.shields.io/npm/v/discord-api-types?color=crimson&label=NPM%20Version&logo=npm)](https://www.npmjs.com/package/discord-api-types)
+[![npm downloads](https://img.shields.io/npm/dt/discord-api-types.svg?label=NPM%20Downloads&logo=npm)](https://www.npmjs.com/package/discord-api-types)
+[![deno](https://img.shields.io/npm/v/discord-api-types?color=blue&label=deno&logo=deno)](https://deno.land/x/discord_api_types)
+
+</div>
+
+## About
+
+Discord API Types is a community-maintained project that brings API types for Discord's REST, Gateway and Voice APIs.
+
+## Installation
+
+Install with [npm](https://www.npmjs.com/) / [yarn](https://yarnpkg.com) / [pnpm](https://pnpm.js.org/):
+
+```bash npm2yarn2pnpm
+npm install discord-api-types
+```
+
+### Usage
+
+You can only import this module by specifying the API version you want to target. Append `/v*` to the import path, where
+the `*` represents the API version. Below are some examples
+
+<Tabs groupId="ts2esm2cjs">
+<TabItem value="javascript" label="JavaScript">
+
+```javascript
+/**
+ * @type {import('discord-api-types/v10').APIUser}
+ */
+```
+
+</TabItem>
+
+<TabItem value="esm" label="ESM">
+
+```javascript
+/**
+ * @type {import('discord-api-types/v10').APIUser}
+ */
+```
+
+</TabItem>
+
+<TabItem value="typescript" label="TypeScript">
+
+```typescript
+import { type APIUser } from 'discord-api-types/v10';
+```
+
+</TabItem>
+
+</Tabs>
+
+:::info
+
+You may also import just certain parts of the module that you need. The possible values are: `globals`, `gateway`,
+`gateway/v*`, `payloads`, `payloads/v*`, `rest`, `rest/v*`, `rpc`, `rpc/v*`, `utils`, `utils/v*`, `voice`, and
+`voice/v*`. Below is an example of importing directly from the gateway submodule
+
+```typescript ts2esm2cjs
+import { GatewayVersion } from 'discord-api-types/gateway/v10';
+
+console.log(`Let's connect to wss://gateway.discord.gg/?v=${GatewayVersion}`);
+```
+
+> _**Note:** The `v*` exports (`discord-api-types/v*`) include the appropriate version of `gateway`, `payloads`, `rest`,
+> `rpc`, and `utils` you specified, alongside the `globals` exports_
+
+:::
+
+### Deno
+
+We also provide typings compatible with the [deno](https://deno.land/) runtime. Here are 3 examples of how you can
+import them:
+
+<Tabs>
+<TabItem value="github" label="From GitHub">
+
+```typescript
+// Importing a specific API version
+import { APIUser } from 'https://raw.githubusercontent.com/discordjs/discord-api-types/main/deno/v10.ts';
+```
+
+</TabItem>
+
+<TabItem value="deno" label="From deno.land/x" default>
+
+```typescript
+// Importing a specific API version
+import { APIUser } from 'https://deno.land/x/discord_api_types/v10.ts';
+```
+
+</TabItem>
+
+<TabItem value="skypack" label="From skypack.dev">
+
+```typescript
+// Importing a specific API version
+import { APIUser } from 'https://cdn.skypack.dev/discord-api-types/v10?dts';
+```
+
+</TabItem>
+
+</Tabs>
+
+## Project Structure
+
+The exports of each API version is split into three main parts:
+
+- Everything exported with the `API` prefix represents a payload you may get from the REST API _or_ the Gateway.
+
+- Everything exported with the `Gateway` prefix represents data that ONLY comes from or is directly related to the
+  Gateway.
+
+- Everything exported with the `REST` prefix represents data that ONLY comes from or is directly related to the REST
+  API.
+
+  - For endpoint options, they will follow the following structure:
+    `REST<HTTP Method><Type><Query|(JSON|FormData)Body|Result>` where the type represents what it will return.
+
+    - For example, `RESTPostAPIChannelMessageJSONBody` or `RESTGetAPIGatewayBotInfoResult`.
+
+    - Some exported types (specifically OAuth2 related ones) may not respect this entire structure due to the nature of
+      the fields. They will start with either `RESTOAuth2` or with something similar to `REST<HTTP Method>OAuth2`
+
+  - If a type ends with `Result`, then it represents the expected result by calling its accompanying route.
+
+    - Types that are exported as `never` usually mean the result will be a `204 No Content`, so you can safely ignore
+      it. This does **not** account for errors.
+
+- Anything else that is miscellaneous will be exported based on what it represents (for example the `REST` route
+  object).
+
+- There may be types exported that are identical for all versions. These will be exported as is and can be found in the
+  `globals` file. They will still be prefixed accordingly as described above.
+
+:::danger A note about how types are documented
+
+This package will add types only for known and documented properties that are present in Discord's
+[API Documentation repository](https://github.com/discord/discord-api-docs), that are mentioned in an open pull request,
+or known through other means _and have received the green light to be used_. Anything else will not be documented (for
+example client only types).
+
+With that aside, we may allow certain types that are not documented in the
+[API Documentation repository](https://github.com/discord/discord-api-docs) on a case by case basis. They will be
+documented with an `@unstable` tag and are not subject with the same versioning rules.
+
+:::
--- a/website/versioned_docs/version-0.33.1/api-packages.json
+++ b/website/versioned_docs/version-0.33.1/api-packages.json
@@ -0,0 +1 @@
+[{"entryPoints":{"globals":{"path":"globals.ts","label":"Global Types"},"gateway/common":{"path":"gateway/common.ts","label":"Gateway - Common Types"},"payloads/common":{"path":"payloads/common.ts","label":"Payloads - Common Types"},"rest/common":{"path":"rest/common.ts","label":"REST - Common Types"},"rpc/common":{"path":"rpc/common.ts","label":"RPC - Common Types"},"v6":{"path":"v6.ts","label":"API v6 - Deprecated"},"v8":{"path":"v8.ts","label":"API v8 - Deprecated"},"v9":{"path":"v9.ts","label":"API v9"},"v10":{"path":"v10.ts","label":"API v10"},"rpc/v8":{"path":"rpc/v8.ts","label":"RPC v8"},"rpc/v9":{"path":"rpc/v9.ts","label":"RPC v9"},"rpc/v10":{"path":"rpc/v10.ts","label":"RPC v10"},"voice/v4":{"path":"voice/v4.ts","label":"Voice v4"},"utils/v8":{"path":"utils/v8.ts","label":"Utils v8"},"utils/v9":{"path":"utils/v9.ts","label":"Utils v9"},"utils/v10":{"path":"utils/v10.ts","label":"Utils v10"}},"packagePath":"./","packageSlug":"discord-api-types","packageName":"discord-api-types","packageVersion":"0.33.1"}]
--- a/website/versioned_docs/version-0.33.1/api-typedoc.json
+++ b/website/versioned_docs/version-0.33.1/api-typedoc.json
--- a/website/versioned_sidebars/version-0.33.1-sidebars.json
+++ b/website/versioned_sidebars/version-0.33.1-sidebars.json
@@ -0,0 +1,8 @@
+{
+  "sidebar": [
+    {
+      "type": "autogenerated",
+      "dirName": "."
+    }
+  ]
+}
--- a/website/versions.json
+++ b/website/versions.json
@@ -1 +1,4 @@
-["0.33.0"]
+[
+  "0.33.1",
+  "0.33.0"
+]
				`@@ -0,0 +1 @@`
				[{"entryPoints":{"globals":{"path":"globals.ts","label":"Global Types"},"gateway/common":{"path":"gateway/common.ts","label":"Gateway - Common Types"},"payloads/common":{"path":"payloads/common.ts","label":"Payloads - Common Types"},"rest/common":{"path":"rest/common.ts","label":"REST - Common Types"},"rpc/common":{"path":"rpc/common.ts","label":"RPC - Common Types"},"v6":{"path":"v6.ts","label":"API v6 - Deprecated"},"v8":{"path":"v8.ts","label":"API v8 - Deprecated"},"v9":{"path":"v9.ts","label":"API v9"},"v10":{"path":"v10.ts","label":"API v10"},"rpc/v8":{"path":"rpc/v8.ts","label":"RPC v8"},"rpc/v9":{"path":"rpc/v9.ts","label":"RPC v9"},"rpc/v10":{"path":"rpc/v10.ts","label":"RPC v10"},"voice/v4":{"path":"voice/v4.ts","label":"Voice v4"},"utils/v8":{"path":"utils/v8.ts","label":"Utils v8"},"utils/v9":{"path":"utils/v9.ts","label":"Utils v9"},"utils/v10":{"path":"utils/v10.ts","label":"Utils v10"}},"packagePath":"./","packageSlug":"discord-api-types","packageName":"discord-api-types","packageVersion":"0.33.1"}]