Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-13 01:53:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat: stage channels (#5456)

Browse Source 
* feat: add stage channel type

* feat: initialise stage channel structure

* feat: add STAGE_MODERATOR permissions bitfield

* fix: typo in permissions

* fix(Channel): type selection logic

* feat: add rtcRegion to StageChannel and VoiceChannel

* feat: rtc region editing for stage and voice channels

* feat: stage channel userLimit

* feat: add stage channels to exports

* feat: add computed properties to stage channel

* feat(VoiceState): include stage channel in docs

* feat: allow ability to join stage channels

* feat(StageChannel): join and leave methods

* docs: add StageChannel link in GuildChannel docs

* feat(VoiceState): suppress and requestToSpeakTimestamp

* feat(StageChannel): setRequestToSpeak

* refactor(StageChannel): update setRequestToSpeak

* feat(VoiceState): add moveToSpeakers and moveToAudience

* feat(VoiceState): add methods to move in/out of speakers

* feat(VoiceState): add stage channel sanity checks

* feat(Permissions): add REQUEST_TO_SPEAK

* feat(VoiceState): simpler methods

* docs(VoiceState): add documentation for new methods

* refactor: remove unused error message

* chore: remove debug statements

* chore: revert changes to package-lock.json

* docs(VoiceState): clarify suppress

* docs(VoiceState): add missing @type param

* feat(StageChannel): remove nsfw property

* fix(VoiceState): check permissions in channel

Co-authored-by: Advaith <advaithj1@gmail.com>

* fix(VoiceState): instantiate error with new

Co-authored-by: BannerBomb <BannerBomb55@gmail.com>

* refactor(VoiceState): more readable API route builder

Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com>

* style(VoiceState): fix lint errors

* docs(VoiceState): add example usage for new methods

* docs: setRTCRegion examples

* chore: update typings

* fix(VoiceState): calculate permissions for self

* refactor(VoiceState): tidy up implementation

* Update src/structures/VoiceState.js

Co-authored-by: Jan <66554238+vaporox@users.noreply.github.com>

* refactor: vaporox's suggestions

* style(VoiceState): fix linter errors

* chore: update typings

* chore: remove unused error message

* refactor(VoiceState): use optional chaining

Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com>

* chore: move getters below constructor in typings

* refactor(StageChannel): optional chaining

Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com>

* style(VoiceState): fix lint errors

* docs: fix incorrect types

Co-authored-by: izexi <43889168+izexi@users.noreply.github.com>

* Update src/structures/VoiceChannel.js

Co-authored-by: izexi <43889168+izexi@users.noreply.github.com>

* Update src/structures/VoiceChannel.js

Co-authored-by: izexi <43889168+izexi@users.noreply.github.com>

* refactor(VoiceState): use optional chaining

Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com>

* refactor(StageChannel): remove permission override check in joinable

* refactor: make ChannelTypes a proper enum

* Use createEnum

Co-authored-by: izexi <43889168+izexi@users.noreply.github.com>

* chore: remove unused code from Constants

* refactor(StageChannel): remove unnecessary getters

* chore: update typings

* refactor: introduce BaseGuildVoiceChannel class

* refactor(VoiceChannel): reduce code duplication

* feat: export BaseGuildVoiceChannel

* chore: update typings

* docs: fix typos

* refactor: move setRTCRegion to BaseGuildVoiceChannel

* feat(VoiceState): remove permission checks

* chore: update typings

* Apply suggestions from code review

Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com>
Co-authored-by: Jan <66554238+vaporox@users.noreply.github.com>

* chore: update esm exports and typings

* Update src/structures/VoiceState.js

Co-authored-by: Vlad Frangu <kingdgrizzle@gmail.com>

Co-authored-by: Advaith <advaithj1@gmail.com>
Co-authored-by: BannerBomb <BannerBomb55@gmail.com>
Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com>
Co-authored-by: Jan <66554238+vaporox@users.noreply.github.com>
Co-authored-by: izexi <43889168+izexi@users.noreply.github.com>
Co-authored-by: Vlad Frangu <kingdgrizzle@gmail.com>
This commit is contained in:
Amish Shah
2021-04-14 13:35:55 +01:00
committed by GitHub
parent 63ff6a07eb
commit eec7cf7634
15 changed files with 320 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
typings/index.d.ts vendored
View File

@@ -7,6 +7,18 @@ declare enum ChannelType {
news = 5,
store = 6,
unknown = 7,
stage = 13,
}
declare enum ChannelTypes {
TEXT = 0,
DM = 1,
VOICE = 2,
GROUP = 3,
CATEGORY = 4,
NEWS = 5,
STORE = 6,
STAGE = 13,
}
declare enum OverwriteTypes {
@@ -166,6 +178,19 @@ declare module 'discord.js' {
public requiresColons: boolean | null;
}
export class BaseGuildVoiceChannel extends GuildChannel {
constructor(guild: Guild, data?: object);
public readonly members: Collection<Snowflake, GuildMember>;
public readonly full: boolean;
public readonly joinable: boolean;
public rtcRegion: string | null;
public bitrate: number;
public userLimit: number;
public join(): Promise<VoiceConnection>;
public leave(): void;
public setRTCRegion(region: string | null): Promise<this>;
}
class BroadcastDispatcher extends VolumeMixin(StreamDispatcher) {
public broadcast: VoiceBroadcast;
}
@@ -293,7 +318,7 @@ declare module 'discord.js' {
public connections: Collection<Snowflake, VoiceConnection>;
public broadcasts: VoiceBroadcast[];
private joinChannel(channel: VoiceChannel): Promise<VoiceConnection>;
private joinChannel(channel: VoiceChannel | StageChannel): Promise<VoiceConnection>;
public createBroadcast(): VoiceBroadcast;
}
@@ -520,15 +545,7 @@ declare module 'discord.js' {
CLIENT_CONNECT: 12;
CLIENT_DISCONNECT: 13;
};
ChannelTypes: {
TEXT: 0;
DM: 1;
VOICE: 2;
GROUP: 3;
CATEGORY: 4;
NEWS: 5;
STORE: 6;
};
ChannelTypes: typeof ChannelTypes;
ClientApplicationAssetTypes: {
SMALL: 1;
BIG: 2;
@@ -1213,6 +1230,7 @@ declare module 'discord.js' {
public static ALL: bigint;
public static DEFAULT: bigint;
public static STAGE_MODERATOR: bigint;
public static FLAGS: PermissionFlags;
public static resolve(permission?: PermissionResolvable): bigint;
}
@@ -1428,6 +1446,11 @@ declare module 'discord.js' {
public static resolve(bit?: BitFieldResolvable<SpeakingString, number>): number;
}
export class StageChannel extends BaseGuildVoiceChannel {
public topic: string | null;
public type: 'stage';
}
export class StoreChannel extends GuildChannel {
constructor(guild: Guild, data?: object);
public nsfw: boolean;
@@ -1623,17 +1646,10 @@ declare module 'discord.js' {
public once(event: string, listener: (...args: any[]) => void): this;
}
export class VoiceChannel extends GuildChannel {
constructor(guild: Guild, data?: object);
public bitrate: number;
export class VoiceChannel extends BaseGuildVoiceChannel {
public readonly editable: boolean;
public readonly full: boolean;
public readonly joinable: boolean;
public readonly speakable: boolean;
public type: 'voice';
public userLimit: number;
public join(): Promise<VoiceConnection>;
public leave(): void;
public setBitrate(bitrate: number, reason?: string): Promise<VoiceChannel>;
public setUserLimit(userLimit: number, reason?: string): Promise<VoiceChannel>;
}
@@ -1657,9 +1673,9 @@ declare module 'discord.js' {
private sendVoiceStateUpdate(options: object): Promise<Shard>;
private setSessionID(sessionID: string): void;
private setTokenAndEndpoint(token: string, endpoint: string): void;
private updateChannel(channel: VoiceChannel): void;
private updateChannel(channel: VoiceChannel | StageChannel): void;
public channel: VoiceChannel;
public channel: VoiceChannel | StageChannel;
public readonly client: Client;
public readonly dispatcher: StreamDispatcher | null;
public player: object;
@@ -1717,7 +1733,7 @@ declare module 'discord.js' {
export class VoiceState extends Base {
constructor(guild: Guild, data: object);
public readonly channel: VoiceChannel | null;
public readonly channel: VoiceChannel | StageChannel | null;
public channelID: Snowflake | null;
public readonly connection: VoiceConnection | null;
public readonly deaf: boolean | null;
@@ -1732,6 +1748,8 @@ declare module 'discord.js' {
public sessionID: string | null;
public streaming: boolean;
public selfVideo: boolean;
public suppress: boolean;
public requestToSpeakTimestamp: number | null;
public readonly speaking: boolean | null;
public setDeaf(deaf: boolean, reason?: string): Promise<GuildMember>;
@@ -1740,6 +1758,8 @@ declare module 'discord.js' {
public setChannel(channel: ChannelResolvable | null, reason?: string): Promise<GuildMember>;
public setSelfDeaf(deaf: boolean): Promise<boolean>;
public setSelfMute(mute: boolean): Promise<boolean>;
public setRequestToSpeak(request: boolean): Promise<void>;
public setSuppressed(suppressed: boolean): Promise<void>;
}
class VolumeInterface extends EventEmitter {
@@ -2411,6 +2431,7 @@ declare module 'discord.js' {
rateLimitPerUser?: number;
lockPermissions?: boolean;
permissionOverwrites?: readonly OverwriteResolvable[] | Collection<Snowflake, OverwriteResolvable>;
rtcRegion?: string | null;
}
interface ChannelLogsQueryOptions {
@@ -3104,7 +3125,8 @@ declare module 'discord.js' {
| 'MANAGE_NICKNAMES'
| 'MANAGE_ROLES'
| 'MANAGE_WEBHOOKS'
| 'MANAGE_EMOJIS';
| 'MANAGE_EMOJIS'
| 'REQUEST_TO_SPEAK';
interface RecursiveArray<T> extends ReadonlyArray<T | RecursiveArray<T>> {}