3 Commits

Author	SHA1	Message	Date
Skillz4Killz	bbbe21ebf2	BREAKING: add docs (#2442) ... * refactor(helpers): Organise functions. (#2425) * refactor: Move stage instance helper functions into `/stages` subdirectory. * refactor: Move `followChannel.ts` to `/announcements` subdirectory. * refactor: Move `updateVoiceState.ts` to `/guilds` directory. * refactor: Move `getPins.ts` to `/messages` directory. * refactor: Move voice-related helper functions into `/voice` subdirectory. * refactor: Rename `/scheduledEvents` to `/events`. * refactor: Move widget-related helper functions into `/widgets` subdirectory. * refactor: Make `/integrations` a subdirectory of `/guilds`. * refactor: Move helper functions related to interaction responses into the `/responses` subdirectory. * refactor: Move `verifySignature.ts` to `/util` directory. * refactor: Move `getChannelInvites.ts` to `/channels` directory. * refactor: Make `/invites` a subdirectory of `/guilds`. * refactor: Move reaction-related helper functions into the /reactions subdirectory. * refactor: Move `getApplicationInfo.ts` into the `/misc` directory. * refactor: Move voice-related helper functions from `/voice` to `/guilds/voice`. * fix: Update and simplify type imports. * refactor!(helpers): Rename helpers to match Discord API. Create a 1:1 helper-to-endpoint correspondence. (#2427) * refactor: Move stage instance helper functions into `/stages` subdirectory. * refactor: Move `followChannel.ts` to `/announcements` subdirectory. * refactor: Move `updateVoiceState.ts` to `/guilds` directory. * refactor: Move `getPins.ts` to `/messages` directory. * refactor: Move voice-related helper functions into `/voice` subdirectory. * refactor: Rename `/scheduledEvents` to `/events`. * refactor: Move widget-related helper functions into `/widgets` subdirectory. * refactor: Make `/integrations` a subdirectory of `/guilds`. * refactor: Move helper functions related to interaction responses into the `/responses` subdirectory. * refactor: Move `verifySignature.ts` to `/util` directory. * refactor: Move `getChannelInvites.ts` to `/channels` directory. * refactor: Make `/invites` a subdirectory of `/guilds`. * refactor: Move reaction-related helper functions into the /reactions subdirectory. * refactor: Move `getApplicationInfo.ts` into the `/misc` directory. * refactor: Move voice-related helper functions from `/voice` to `/guilds/voice`. * fix: Update and simplify type imports. * refactor: Rename `followChannel` -> `followAnnouncementChannel`. * refactor: Rename `createForumPost` -> `startForumThread`. * refactor: Normalise keyword `update` -> `edit`. * refactor: Rename `addToThread` -> `addThreadMember`. * refactor: Rename `ChannelOverwrite` -> `ChannelPermissions`. * refactor: Rename `startTyping` -> `triggerTypingIndicator`. * refactor: Rename `swapChannels` -> `editChannelPositions`. * refactor: Rename `getPins` -> `getPinnedMessages`. * refactor: Rename `publish` -> `crosspost`. * refactor: Normalise keyword `modify` -> `edit`. * refactor: Normalise naming. * fix: Imports. * style: Remove empty object. * refactor: Split `getArchivedThreads` into three files for public, private and private joined threads. * refactor: Split `getApplicationCommands` into two files, for guild and global commands respectively. * refactor: Split `getApplicationCommand` into two files, for guild and global commands respectively. * fmt: Organise imports. * misc: Include application command reverse transformer. * misc: Make ordering of fields match up with the Discord API. * fix: Add missing payload properties. * refactor: Split `createApplicationCommand` into two files, for guild and global commands respectively. * refactor: Split `upsertApplicationCommand` into two files, for guild and global commands respectively. * refactor: Split `upsertApplicationCommands` into two files, for guild and global commands respectively. * fix: Update exports. * refactor: Split `deleteApplicationCommand` into two files, for guild and global commands respectively. * fix: Add missing exports. * refactor: Separate file into two to make 1 file correspond to 1 endpoint. * refactor: Separate file into two to make 1 file correspond to 1 endpoint. * feat: Create `getInteractionResponse.ts`. * refactor: Matching API: `InteractionResponse` -> `FollowupMessage`. * refactor: Separate file into two to make 1 file correspond to 1 endpoint. * refactor: Remove `/followups` directory in favour of newly created files in `/responses`. * refactor: Rename `bot`/`self` -> `own`, `others` -> `user`. * refactor: Split function into `deleteOwnReaction` and `deleteUserReaction`. * refactor: Reduce code duplication in processing reaction string. * refactor: Separate file into two to make 1 file correspond to 1 endpoint. * refactor: Rename function name. * misc: Add aliases to functions to reduce breakage. * refactor: Rename `startForumThread` -> `createForumThread`. * misc: Move types from helper file to `/types` and create transformer. * fix: Imports. * style: Rename parameter `command` -> `payload`. * feat: Create interaction response transformer. * misc: Adapt code to use the interaction response transformer. * misc: Adapt code to use interaction response transformer. * refactor: Re-include the keyword `Override` in the file + function names. * refactor: Rename `updateVoiceState` -> `editVoiceState` for consistency reasons. Co-authored-by: Skillz4Killz <23035000+Skillz4Killz@users.noreply.github.com> * BREAKING: docs(helpers): Document helper functions. (#2437) * refactor: Move stage instance helper functions into `/stages` subdirectory. * refactor: Move `followChannel.ts` to `/announcements` subdirectory. * refactor: Move `updateVoiceState.ts` to `/guilds` directory. * refactor: Move `getPins.ts` to `/messages` directory. * refactor: Move voice-related helper functions into `/voice` subdirectory. * refactor: Rename `/scheduledEvents` to `/events`. * refactor: Move widget-related helper functions into `/widgets` subdirectory. * refactor: Make `/integrations` a subdirectory of `/guilds`. * refactor: Move helper functions related to interaction responses into the `/responses` subdirectory. * refactor: Move `verifySignature.ts` to `/util` directory. * refactor: Move `getChannelInvites.ts` to `/channels` directory. * refactor: Make `/invites` a subdirectory of `/guilds`. * refactor: Move reaction-related helper functions into the /reactions subdirectory. * refactor: Move `getApplicationInfo.ts` into the `/misc` directory. * refactor: Move voice-related helper functions from `/voice` to `/guilds/voice`. * fix: Update and simplify type imports. * refactor: Rename `followChannel` -> `followAnnouncementChannel`. * refactor: Rename `createForumPost` -> `startForumThread`. * refactor: Normalise keyword `update` -> `edit`. * refactor: Rename `addToThread` -> `addThreadMember`. * refactor: Rename `ChannelOverwrite` -> `ChannelPermissions`. * refactor: Rename `startTyping` -> `triggerTypingIndicator`. * refactor: Rename `swapChannels` -> `editChannelPositions`. * refactor: Rename `getPins` -> `getPinnedMessages`. * refactor: Rename `publish` -> `crosspost`. * refactor: Normalise keyword `modify` -> `edit`. * refactor: Normalise naming. * fix: Imports. * style: Remove empty object. * refactor: Split `getArchivedThreads` into three files for public, private and private joined threads. * refactor: Split `getApplicationCommands` into two files, for guild and global commands respectively. * refactor: Split `getApplicationCommand` into two files, for guild and global commands respectively. * fmt: Organise imports. * misc: Include application command reverse transformer. * misc: Make ordering of fields match up with the Discord API. * fix: Add missing payload properties. * refactor: Split `createApplicationCommand` into two files, for guild and global commands respectively. * refactor: Split `upsertApplicationCommand` into two files, for guild and global commands respectively. * refactor: Split `upsertApplicationCommands` into two files, for guild and global commands respectively. * fix: Update exports. * refactor: Split `deleteApplicationCommand` into two files, for guild and global commands respectively. * fix: Add missing exports. * refactor: Separate file into two to make 1 file correspond to 1 endpoint. * refactor: Separate file into two to make 1 file correspond to 1 endpoint. * feat: Create `getInteractionResponse.ts`. * refactor: Matching API: `InteractionResponse` -> `FollowupMessage`. * refactor: Separate file into two to make 1 file correspond to 1 endpoint. * refactor: Remove `/followups` directory in favour of newly created files in `/responses`. * refactor: Rename `bot`/`self` -> `own`, `others` -> `user`. * refactor: Split function into `deleteOwnReaction` and `deleteUserReaction`. * refactor: Reduce code duplication in processing reaction string. * refactor: Separate file into two to make 1 file correspond to 1 endpoint. * refactor: Rename function name. * misc: Add aliases to functions to reduce breakage. * refactor: Rename `startForumThread` -> `createForumThread`. * misc: Move types from helper file to `/types` and create transformer. * fix: Imports. * style: Rename parameter `command` -> `payload`. * feat: Create interaction response transformer. * misc: Adapt code to use the interaction response transformer. * misc: Adapt code to use interaction response transformer. * docs: Document announcement channel helpers. * docs: Document forum channel helpers. * docs: Document stage instance helpers. * misc: Update wording. * docs: Document thread channel helpers. * refactor: Re-include the keyword `Override` in the file + function names. * refactor: Rename `updateVoiceState` -> `editVoiceState` for consistency reasons. * docs: Document channel helpers. * docs: Use `parameters` instead of `options` for descriptions. * docs: Document guild discovery helpers. * docs: Document emoji helpers. * docs: Add missing information about which gateway events are fired. * docs: Document auto moderation helpers. * docs: Document scheduled event helpers. * docs: Document integration helpers. * docs: Document invite helpers. * refactor: Rename `editWidget` -> `editWidgetSettings`. * docs: Document guild widget helpers. * docs: 'event' -> 'gateway event'. * refactor: Rename `getAuditLogs` -> `getAuditLog`. * docs: Document guild helpers. * refactor: Rename `upsert*ApplicationCommand` -> `edit*ApplicationCommand`. * docs: Document application command helpers. * docs: Improve consistency in indentation. * docs: Document interaction response + follow-up message helpers. * docs: Document gateway event firings for endpoints. * refactor: Delete `editBotNickname` due to being a subset of `editMember`. * docs: Fix inconsistency. * docs: Document member helpers. * docs: Document reaction helpers. * docs: Improve consistency. * docs: Document message helpers. * docs: Document role helpers. * docs: Document guild template helpers. * docs: Fix incorrect gateway event. * refactor: Rename `sendWebhookMessage` -> `executeWebhook`. * docs: Document webhook helpers. * docs: Document voice helpers. * fmt: Run Deno formatter. * docs: Improve consistency. * refactor: Rename the `/widgets` directory to `/widget`. * fmt: Run Deno formatter. * misc: Re-add the deleted `editBotNickname()` helper. (#2443) * refactor: Move stage instance helper functions into `/stages` subdirectory. * refactor: Move `followChannel.ts` to `/announcements` subdirectory. * refactor: Move `updateVoiceState.ts` to `/guilds` directory. * refactor: Move `getPins.ts` to `/messages` directory. * refactor: Move voice-related helper functions into `/voice` subdirectory. * refactor: Rename `/scheduledEvents` to `/events`. * refactor: Move widget-related helper functions into `/widgets` subdirectory. * refactor: Make `/integrations` a subdirectory of `/guilds`. * refactor: Move helper functions related to interaction responses into the `/responses` subdirectory. * refactor: Move `verifySignature.ts` to `/util` directory. * refactor: Move `getChannelInvites.ts` to `/channels` directory. * refactor: Make `/invites` a subdirectory of `/guilds`. * refactor: Move reaction-related helper functions into the /reactions subdirectory. * refactor: Move `getApplicationInfo.ts` into the `/misc` directory. * refactor: Move voice-related helper functions from `/voice` to `/guilds/voice`. * fix: Update and simplify type imports. * refactor: Rename `followChannel` -> `followAnnouncementChannel`. * refactor: Rename `createForumPost` -> `startForumThread`. * refactor: Normalise keyword `update` -> `edit`. * refactor: Rename `addToThread` -> `addThreadMember`. * refactor: Rename `ChannelOverwrite` -> `ChannelPermissions`. * refactor: Rename `startTyping` -> `triggerTypingIndicator`. * refactor: Rename `swapChannels` -> `editChannelPositions`. * refactor: Rename `getPins` -> `getPinnedMessages`. * refactor: Rename `publish` -> `crosspost`. * refactor: Normalise keyword `modify` -> `edit`. * refactor: Normalise naming. * fix: Imports. * style: Remove empty object. * refactor: Split `getArchivedThreads` into three files for public, private and private joined threads. * refactor: Split `getApplicationCommands` into two files, for guild and global commands respectively. * refactor: Split `getApplicationCommand` into two files, for guild and global commands respectively. * fmt: Organise imports. * misc: Include application command reverse transformer. * misc: Make ordering of fields match up with the Discord API. * fix: Add missing payload properties. * refactor: Split `createApplicationCommand` into two files, for guild and global commands respectively. * refactor: Split `upsertApplicationCommand` into two files, for guild and global commands respectively. * refactor: Split `upsertApplicationCommands` into two files, for guild and global commands respectively. * fix: Update exports. * refactor: Split `deleteApplicationCommand` into two files, for guild and global commands respectively. * fix: Add missing exports. * refactor: Separate file into two to make 1 file correspond to 1 endpoint. * refactor: Separate file into two to make 1 file correspond to 1 endpoint. * feat: Create `getInteractionResponse.ts`. * refactor: Matching API: `InteractionResponse` -> `FollowupMessage`. * refactor: Separate file into two to make 1 file correspond to 1 endpoint. * refactor: Remove `/followups` directory in favour of newly created files in `/responses`. * refactor: Rename `bot`/`self` -> `own`, `others` -> `user`. * refactor: Split function into `deleteOwnReaction` and `deleteUserReaction`. * refactor: Reduce code duplication in processing reaction string. * refactor: Separate file into two to make 1 file correspond to 1 endpoint. * refactor: Rename function name. * misc: Add aliases to functions to reduce breakage. * refactor: Rename `startForumThread` -> `createForumThread`. * misc: Move types from helper file to `/types` and create transformer. * fix: Imports. * style: Rename parameter `command` -> `payload`. * feat: Create interaction response transformer. * misc: Adapt code to use the interaction response transformer. * misc: Adapt code to use interaction response transformer. * docs: Document announcement channel helpers. * docs: Document forum channel helpers. * docs: Document stage instance helpers. * misc: Update wording. * docs: Document thread channel helpers. * refactor: Re-include the keyword `Override` in the file + function names. * refactor: Rename `updateVoiceState` -> `editVoiceState` for consistency reasons. * docs: Document channel helpers. * docs: Use `parameters` instead of `options` for descriptions. * docs: Document guild discovery helpers. * docs: Document emoji helpers. * docs: Add missing information about which gateway events are fired. * docs: Document auto moderation helpers. * docs: Document scheduled event helpers. * docs: Document integration helpers. * docs: Document invite helpers. * refactor: Rename `editWidget` -> `editWidgetSettings`. * docs: Document guild widget helpers. * docs: 'event' -> 'gateway event'. * refactor: Rename `getAuditLogs` -> `getAuditLog`. * docs: Document guild helpers. * refactor: Rename `upsert*ApplicationCommand` -> `edit*ApplicationCommand`. * docs: Document application command helpers. * docs: Improve consistency in indentation. * docs: Document interaction response + follow-up message helpers. * docs: Document gateway event firings for endpoints. * refactor: Delete `editBotNickname` due to being a subset of `editMember`. * docs: Fix inconsistency. * docs: Document member helpers. * docs: Document reaction helpers. * docs: Improve consistency. * docs: Document message helpers. * docs: Document role helpers. * docs: Document guild template helpers. * docs: Fix incorrect gateway event. * refactor: Rename `sendWebhookMessage` -> `executeWebhook`. * docs: Document webhook helpers. * docs: Document voice helpers. * fmt: Run Deno formatter. * docs: Improve consistency. * refactor: Rename the `/widgets` directory to `/widget`. * fmt: Run Deno formatter. * feat: Re-add `editBotNickname.ts`. * Update helpers/members/editBotNickname.ts Co-authored-by: Skillz4Killz <23035000+Skillz4Killz@users.noreply.github.com> * fix: tests * fix: bot member tests * fix: remove submode * fix: edit bot member returns full member Co-authored-by: Dorian Oszczęda <vxern@wordcollector.co.uk>	2022-09-08 20:12:34 -05:00
Skillz4Killz	e843b72edb	fix: type errors	2022-08-23 14:56:48 +00:00
Jonathan Ho	34d7a47f24	feat: reverse transformers (#2387) ... * merged change * deno fmt	2022-08-23 10:18:30 -04:00