@theholocron/discord-client 1.44.0 → 1.45.0

package/README.md

@@ -99,12 +99,13 @@ the resource, look it up by name before creating it again. A webhook created
 that way cannot have its URL read back, since Discord returns the token only on
 the create response.
 
-| Resource          | Methods                                                                                                                                                     |
-| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `client.users`    | `me()` — `GET /users/@me`, a cheap token check                                                                                                              |
-| `client.guilds`   | `get`, `modify`, `channels`, `createChannel`, `roles`, `createRole`, `modifyRole`, `welcomeScreen`, `modifyWelcomeScreen`, `onboarding`, `modifyOnboarding` |
-| `client.channels` | `modify`, `webhooks`, `createWebhook`, `createMessage`                                                                                                      |
-| `client.webhooks` | `modify` (name, avatar), `delete`                                                                                                                           |
+| Resource             | Methods                                                                                                                                                     |
+| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `client.users`       | `me()` — `GET /users/@me`, a cheap token check                                                                                                              |
+| `client.application` | `get`, `modify` (the bot's own application: description, tags, install settings, URLs)                                                                      |
+| `client.guilds`      | `get`, `modify`, `channels`, `createChannel`, `roles`, `createRole`, `modifyRole`, `welcomeScreen`, `modifyWelcomeScreen`, `onboarding`, `modifyOnboarding` |
+| `client.channels`    | `modify`, `webhooks`, `createWebhook`, `createMessage`                                                                                                      |
+| `client.webhooks`    | `modify` (name, avatar), `delete`                                                                                                                           |
 
 `permissions([...names])` builds the decimal-string bitfield Discord expects, and
 `permissionNames(bitfield)` reads one back; `Permission` holds the bits themselves.

package/dist/index.d.mts

@@ -219,6 +219,44 @@ interface DiscordMessage {
   channel_id: string;
   content: string;
 }
+/** How the bot is added to a server or an account. */
+interface DiscordInstallParams {
+  /** OAuth scopes, e.g. `bot`, `applications.commands`. */
+  scopes: string[];
+  /** Permission bitfield the default install link asks for, as a string. */
+  permissions: string;
+}
+/** The bot's own application, as `GET /applications/@me` returns it. Fields Discord leaves out are absent or null. */
+interface DiscordApplication {
+  id: string;
+  name: string;
+  description?: string | null;
+  /** Up to five short labels shown on the application's page. */
+  tags?: string[];
+  /** The default install link's scopes and permissions. */
+  install_params?: DiscordInstallParams;
+  /** Used instead of the default install link when set. */
+  custom_install_url?: string | null;
+  role_connections_verification_url?: string | null;
+  terms_of_service_url?: string | null;
+  privacy_policy_url?: string | null;
+  interactions_endpoint_url?: string | null;
+  /** Whether anyone can add the bot (`true`) or only its owner. */
+  bot_public?: boolean;
+  bot_require_code_grant?: boolean;
+  flags?: number;
+}
+/** What `PATCH /applications/@me` takes; a field left out is left alone, and `null` clears the ones that can be cleared. */
+interface ModifyApplicationInput {
+  description?: string;
+  tags?: string[];
+  install_params?: DiscordInstallParams;
+  custom_install_url?: string | null;
+  role_connections_verification_url?: string | null;
+  terms_of_service_url?: string | null;
+  privacy_policy_url?: string | null;
+  interactions_endpoint_url?: string | null;
+}
 interface ModifyWebhookInput {
   name?: string;
   /** A data URI (`data:image/png;base64,...`); `null` clears it. */
@@ -270,6 +308,12 @@ declare function createDiscordBotClient(opts: DiscordBotClientOptions): {
       name: string;
     }) => Promise<DiscordChannelWebhook>;
   };
+  application: {
+    /** `GET /applications/@me` — the bot's own application: description, tags, install settings, URLs. */
+    get: () => Promise<DiscordApplication>;
+    /** `PATCH /applications/@me` — only what is in the body changes. */
+    modify: (body: ModifyApplicationInput) => Promise<DiscordApplication>;
+  };
   webhooks: {
     /** `PATCH /webhooks/:id` — name and avatar of a webhook this bot manages. */
     modify: (webhookId: string, body: ModifyWebhookInput) => Promise<DiscordChannelWebhook>;
@@ -353,4 +397,4 @@ declare function createDiscordClient(opts?: DiscordClientOptions): {
 };
 type DiscordClient = ReturnType<typeof createDiscordClient>;
 //#endregion
-export { ChannelType, CreateChannelInput, CreateMessageInput, CreateRoleInput, DiscordBotClient, DiscordBotClientOptions, DiscordChannel, DiscordChannelWebhook, DiscordClient, type DiscordClientOptions, DiscordEmoji, DiscordGuild, DiscordMessage, DiscordOnboarding, DiscordOnboardingOption, DiscordOnboardingPrompt, DiscordPermissionOverwrite, DiscordRole, DiscordUser, type DiscordWebhookInfo, DiscordWelcomeChannel, DiscordWelcomeScreen, ModifyChannelInput, ModifyGuildInput, ModifyRoleInput, ModifyWebhookInput, ModifyWelcomeScreenInput, Permission, PermissionName, createDiscordBotClient, createDiscordClient, parseWebhookUrl, permissionNames, permissions };
+export { ChannelType, CreateChannelInput, CreateMessageInput, CreateRoleInput, DiscordApplication, DiscordBotClient, DiscordBotClientOptions, DiscordChannel, DiscordChannelWebhook, DiscordClient, type DiscordClientOptions, DiscordEmoji, DiscordGuild, DiscordInstallParams, DiscordMessage, DiscordOnboarding, DiscordOnboardingOption, DiscordOnboardingPrompt, DiscordPermissionOverwrite, DiscordRole, DiscordUser, type DiscordWebhookInfo, DiscordWelcomeChannel, DiscordWelcomeScreen, ModifyApplicationInput, ModifyChannelInput, ModifyGuildInput, ModifyRoleInput, ModifyWebhookInput, ModifyWelcomeScreenInput, Permission, PermissionName, createDiscordBotClient, createDiscordClient, parseWebhookUrl, permissionNames, permissions };

package/dist/index.mjs

@@ -193,6 +193,15 @@ me: () => rest.request("/users/@me") },
 				body
 			}))
 		},
+		application: {
+			/** `GET /applications/@me` — the bot's own application: description, tags, install settings, URLs. */
+			get: () => rest.request("/applications/@me"),
+			/** `PATCH /applications/@me` — only what is in the body changes. */
+			modify: (body) => rest.request("/applications/@me", {
+				method: "PATCH",
+				body
+			})
+		},
 		webhooks: {
 			/** `PATCH /webhooks/:id` — name and avatar of a webhook this bot manages. */
 			modify: async (webhookId, body) => withUrl(await rest.request(`/webhooks/${id(webhookId)}`, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/discord-client",
-  "version": "1.44.0",
+  "version": "1.45.0",
   "description": "A TypeScript client for the Discord webhooks API",
   "keywords": [
     "discord",
@@ -32,7 +32,7 @@
     "dist"
   ],
   "dependencies": {
-    "@theholocron/http-client": "^1.44.0"
+    "@theholocron/http-client": "^1.45.0"
   },
   "devDependencies": {
     "@theholocron/cli": "5.0.0-alpha.79",