Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(GuildChannel): make createOverwrite and updateOverwrite not dependent on cache #5489

Merged
merged 10 commits into from May 11, 2021
Merged

feat(GuildChannel): make createOverwrite and updateOverwrite not dependent on cache #5489

Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
7f3495c
feat(GuildChannel): make createOverwrite and updateOverwrite not depe…
iShibi Apr 6, 2021
319c312
refactor: remove redundant check for type parameter
iShibi Apr 6, 2021
0bacaa8
refactor: use a single object for optional parameters
iShibi Apr 7, 2021
15179ca
refactor: use number instead of string for type field
iShibi Apr 14, 2021
1fad7e4
docs: add suggested change in description to pass the ci
iShibi Apr 15, 2021
500f1e6
feat: add typings for ExtraOverwriteInfo and some minor fixes
iShibi Apr 15, 2021
e9e2867
fix: check value of type correctly
iShibi Apr 15, 2021
51355e9
refactor: allow any number for the type field
iShibi Apr 16, 2021
deeb961
refactor(ExtraOverwriteInfo): rename the typdef as suggested
iShibi May 10, 2021
6f9be1c
refactor: add the suggested change in more places
iShibi May 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
41 changes: 26 additions & 15 deletions src/structures/GuildChannel.js
View file
Open in desktop
Expand Up @@ -213,11 +213,19 @@ class GuildChannel extends Channel {
return this;
}

/**
* Extra information about the overwrite
* @typedef {Object} ExtraOverwriteInfo
iShibi marked this conversation as resolved.
Show resolved Hide resolved
* @property {string} [reason] Reason for creating/editing this overwrite
* @property {string} [type] The type of overwrite, either `member` or `role`. Use this to bypass automatic
iShibi marked this conversation as resolved.
Show resolved Hide resolved
* resolution of type that results in an error for uncached structure
*/

/**
* Updates permission overwrites for a user or role in this channel, or creates an entry if not already present.
* @param {RoleResolvable|UserResolvable} userOrRole The user or role to update
* @param {PermissionOverwriteOptions} options The options for the update
* @param {string} [reason] Reason for creating/editing this overwrite
* @param {ExtraOverwriteInfo} [extraInfo] The extra information for the update
iShibi marked this conversation as resolved.
Show resolved Hide resolved
* @returns {Promise<GuildChannel>}
* @example
* // Update or Create permission overwrites for a message author
Expand All @@ -227,15 +235,14 @@ class GuildChannel extends Channel {
* .then(channel => console.log(channel.permissionOverwrites.get(message.author.id)))
* .catch(console.error);
*/
async updateOverwrite(userOrRole, options, reason) {
userOrRole = this.guild.roles.resolve(userOrRole) || this.client.users.resolve(userOrRole);
if (!userOrRole) return Promise.reject(new TypeError('INVALID_TYPE', 'parameter', 'User nor a Role'));

const existing = this.permissionOverwrites.get(userOrRole.id);
async updateOverwrite(userOrRole, options, extraInfo) {
const userOrRoleID = this.guild.roles.resolveID(userOrRole) || this.client.users.resolveID(userOrRole);
let { reason } = extraInfo;
const existing = this.permissionOverwrites.get(userOrRoleID);
if (existing) {
await existing.update(options, reason);
} else {
await this.createOverwrite(userOrRole, options, reason);
await this.createOverwrite(userOrRole, options, extraInfo);
}
return this;
}
Expand All @@ -244,7 +251,7 @@ class GuildChannel extends Channel {
* Creates permission overwrites for a user or role in this channel, or replaces them if already present.
* @param {RoleResolvable|UserResolvable} userOrRole The user or role to update
* @param {PermissionOverwriteOptions} options The options for the update
* @param {string} [reason] Reason for creating/editing this overwrite
* @param {ExtraOverwriteInfo} [extraInfo] The extra information for the update
* @returns {Promise<GuildChannel>}
* @example
* // Create or Replace permission overwrites for a message author
Expand All @@ -254,19 +261,23 @@ class GuildChannel extends Channel {
* .then(channel => console.log(channel.permissionOverwrites.get(message.author.id)))
* .catch(console.error);
*/
createOverwrite(userOrRole, options, reason) {
userOrRole = this.guild.roles.resolve(userOrRole) || this.client.users.resolve(userOrRole);
if (!userOrRole) return Promise.reject(new TypeError('INVALID_TYPE', 'parameter', 'User nor a Role'));

const type = userOrRole instanceof Role ? OverwriteTypes.role : OverwriteTypes.member;
createOverwrite(userOrRole, options, extraInfo) {
let userOrRoleID = this.guild.roles.resolveID(userOrRole) || this.client.users.resolveID(userOrRole);
let { type, reason } = extraInfo;
if (!type) {
iShibi marked this conversation as resolved.
Show resolved Hide resolved
userOrRole = this.guild.roles.resolve(userOrRole) || this.client.users.resolve(userOrRole);
if (!userOrRole) return Promise.reject(new TypeError('INVALID_TYPE', 'parameter', 'User nor a Role'));
userOrRoleID = userOrRole.id;
type = userOrRole instanceof Role ? OverwriteTypes.role : OverwriteTypes.member;
}
const { allow, deny } = PermissionOverwrites.resolveOverwriteOptions(options);

return this.client.api
.channels(this.id)
.permissions(userOrRole.id)
.permissions(userOrRoleID)
.put({
data: {
id: userOrRole.id,
id: userOrRoleID,
type,
allow,
deny,
Expand Down