seyfert/src/structures/GuildMember.ts
Marcos Susaña cd445b19b2
chore: remove ts-mixer dependency (#223)
* feat: mixer

* feat(api): allow token in proxy options

* feat(member): timeout's

* chore: apply formatting

* fix: xd?

* fix: timeout reason

* fix: hasTimeout getter

* feat: mixer...

* fix: setter

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2024-07-24 21:41:24 -04:00

267 lines
8.2 KiB
TypeScript

import { DiscordBase } from './extra/DiscordBase';
export type GuildMemberData =
| APIGuildMember
| Omit<APIGuildMember, 'user'>
| GatewayGuildMemberUpdateDispatchData
| GatewayGuildMemberAddDispatchData
| APIInteractionDataResolvedGuildMember;
import type {
APIGuildMember,
GatewayGuildMemberUpdateDispatchData,
GatewayGuildMemberAddDispatchData,
APIInteractionDataResolvedGuildMember,
RESTPutAPIGuildBanJSONBody,
RESTPatchAPIGuildMemberJSONBody,
RESTGetAPIGuildMembersSearchQuery,
RESTPutAPIGuildMemberJSONBody,
RESTGetAPIGuildMembersQuery,
APIUser,
} from '../types';
import type { UsingClient } from '../commands';
import { PermissionsBitField } from './extra/Permissions';
import {
Formatter,
type MessageCreateBodyRequest,
type ObjectToLower,
type ToClass,
type ImageOptions,
type MethodContext,
type GuildMemberResolvable,
} from '../common';
import { Transformers, type UserStructure } from '../client/transformers';
export interface BaseGuildMember extends DiscordBase, ObjectToLower<Omit<APIGuildMember, 'user' | 'roles'>> {}
export class BaseGuildMember extends DiscordBase {
private _roles: string[];
joinedTimestamp?: number;
communicationDisabledUntilTimestamp?: number | null;
constructor(
client: UsingClient,
data: GuildMemberData,
id: string,
/** the choosen guild id */
readonly guildId: string,
) {
const { roles, ...dataN } = data;
super(client, { ...dataN, id });
this._roles = data.roles;
this.patch(data);
}
guild(force = false) {
return this.client.guilds.fetch(this.id, force);
}
fetch(force = false) {
return this.client.members.fetch(this.guildId, this.id, force);
}
ban(body?: RESTPutAPIGuildBanJSONBody, reason?: string) {
return this.client.members.ban(this.guildId, this.id, body, reason);
}
kick(reason?: string) {
return this.client.members.kick(this.guildId, this.id, reason);
}
edit(body: RESTPatchAPIGuildMemberJSONBody, reason?: string) {
return this.client.members.edit(this.guildId, this.id, body, reason);
}
presence() {
return this.client.members.presence(this.id);
}
voice() {
return this.client.members.voice(this.guildId, this.id);
}
toString() {
return Formatter.userMention(this.id);
}
timeout(time: null | number, reason?: string) {
return this.client.members.timeout(this.guildId, this.id, time, reason);
}
get hasTimeout(): false | number {
return this.client.members.hasTimeout(this);
}
private patch(data: GuildMemberData) {
if ('joined_at' in data && data.joined_at) {
this.joinedTimestamp = Date.parse(data.joined_at);
}
if ('communication_disabled_until' in data) {
this.communicationDisabledUntilTimestamp = data.communication_disabled_until?.length
? Date.parse(data.communication_disabled_until)
: null;
}
}
get roles() {
return {
keys: Object.freeze(this._roles.concat(this.guildId)) as string[],
list: (force = false) =>
this.client.roles
.list(this.guildId, force)
.then(roles => roles.filter(role => this.roles.keys.includes(role.id))),
add: (id: string) => this.client.members.addRole(this.guildId, this.id, id),
remove: (id: string) => this.client.members.removeRole(this.guildId, this.id, id),
permissions: (force = false) =>
this.roles.list(force).then(roles => new PermissionsBitField(roles.map(x => BigInt(x.permissions.bits)))),
sorted: (force = false) => this.roles.list(force).then(roles => roles.sort((a, b) => b.position - a.position)),
highest: (force = false) => this.roles.sorted(force).then(roles => roles[0]),
};
}
static methods({ client, guildId }: MethodContext<{ guildId: string }>) {
return {
resolve: (resolve: GuildMemberResolvable) => client.members.resolve(guildId, resolve),
search: (query?: RESTGetAPIGuildMembersSearchQuery) => client.members.search(guildId, query),
unban: (id: string, body?: RESTPutAPIGuildBanJSONBody, reason?: string) =>
client.members.unban(guildId, id, body, reason),
ban: (id: string, body?: RESTPutAPIGuildBanJSONBody, reason?: string) =>
client.members.ban(guildId, id, body, reason),
kick: (id: string, reason?: string) => client.members.kick(guildId, id, reason),
edit: (id: string, body: RESTPatchAPIGuildMemberJSONBody, reason?: string) =>
client.members.edit(guildId, id, body, reason),
add: (id: string, body: RESTPutAPIGuildMemberJSONBody) => client.members.add(guildId, id, body),
fetch: (memberId: string, force = false) => client.members.fetch(guildId, memberId, force),
list: (query?: RESTGetAPIGuildMembersQuery, force = false) => client.members.list(guildId, query, force),
};
}
}
export interface GuildMember extends ObjectToLower<Omit<APIGuildMember, 'user' | 'roles'>> {}
/**
* Represents a guild member
* @link https://discord.com/developers/docs/resources/guild#guild-member-object
*/
export class GuildMember extends BaseGuildMember {
user: UserStructure;
private __me?: GuildMember;
constructor(
client: UsingClient,
data: GuildMemberData,
user: APIUser,
/** the choosen guild id */
readonly guildId: string,
) {
super(client, data, user.id, guildId);
this.user = Transformers.User(client, user);
}
get tag() {
return this.user.tag;
}
get bot() {
return this.user.bot;
}
get name() {
return this.user.name;
}
get username() {
return this.user.username;
}
get globalName() {
return this.user.globalName;
}
/** gets the nickname or the username */
get displayName() {
return this.nick ?? this.globalName ?? this.username;
}
dm(force = false) {
return this.user.dm(force);
}
write(body: MessageCreateBodyRequest) {
return this.user.write(body);
}
defaultAvatarURL() {
return this.user.defaultAvatarURL();
}
avatarURL(options: ImageOptions & { exclude: true }): string | null;
avatarURL(options?: ImageOptions & { exclude?: false }): string;
avatarURL(options?: ImageOptions & { exclude?: boolean }): string | null {
if (!this.avatar) {
return options?.exclude ? null : this.user.avatarURL();
}
return this.rest.cdn.guilds(this.guildId).users(this.id).avatars(this.avatar).get(options);
}
bannerURL(options?: ImageOptions) {
return this.user.bannerURL(options);
}
async fetchPermissions(force = false) {
if ('permissions' in this) return this.permissions as PermissionsBitField;
return this.roles.permissions(force);
}
async manageable(force = false) {
this.__me = await this.client.guilds.fetchSelf(this.guildId, force);
const ownerId = (await this.client.guilds.fetch(this.guildId, force)).ownerId;
if (this.user.id === ownerId) return false;
if (this.user.id === this.client.botId) return false;
if (this.client.botId === ownerId) return true;
return (await this.__me!.roles.highest()).position > (await this.roles.highest(force)).position;
}
async bannable(force = false) {
return (await this.manageable(force)) && (await this.__me!.fetchPermissions(force)).has('BanMembers');
}
async kickable(force = false) {
return (await this.manageable(force)) && (await this.__me!.fetchPermissions(force)).has('KickMembers');
}
async moderatable(force = false) {
return (
!(await this.roles.permissions(force)).has('Administrator') &&
(await this.manageable(force)) &&
(await this.__me!.fetchPermissions(force)).has('KickMembers')
);
}
}
export interface UnavailableMember {
pending: true;
}
export class UnavailableMember extends BaseGuildMember {}
export interface InteractionGuildMember
extends ObjectToLower<Omit<APIInteractionDataResolvedGuildMember, 'roles' | 'deaf' | 'mute' | 'permissions'>> {}
/**
* Represents a guild member
* @link https://discord.com/developers/docs/resources/guild#guild-member-object
*/
export class InteractionGuildMember extends (GuildMember as unknown as ToClass<
Omit<GuildMember, 'deaf' | 'mute'>,
InteractionGuildMember
>) {
permissions: PermissionsBitField;
constructor(
client: UsingClient,
data: APIInteractionDataResolvedGuildMember,
user: APIUser,
/** the choosen guild id */
guildId: string,
) {
super(client, data, user, guildId);
this.permissions = new PermissionsBitField(Number(data.permissions));
}
}