commandbot/dist/mjs/src/structures/CommandPermissions.js

A framework that helps you create your own Discord bot easier.

import { Permissions } from "discord.js";
/**
 * Object that stores permission resolvables and properties (bouund to a {@link PermissionCommand})
 * @class
 */
export class CommandPermissions {
    /**
     * Command bound to this object
     * @type {PermissionCommand}
     * @public
     * @readonly
     */
    command;
    /**
     * If set to "ALL", the command can only be used when all specified conditions are met. (works only for Discord.js permissions object)
     * @type {PermissionCheckTypes}
     * @public
     * @readonly
     */
    permissions;
    /**
     * Command permissions
     * @type {Permissions | PermissionFunction}
     * @public
     * @readonly
     */
    checkType;
    /**
     * @constructor
     * @param {PermissionCommand} command - command attached to this permissions object
     * @param {?CommandPermissionsInit} [o] - initialization options
     */
    constructor(command, o) {
        this.command = command;
        this.checkType = o?.checkType ?? "ANY";
        this.permissions = o?.resolvable instanceof Function ? o.resolvable : new Permissions(o?.resolvable ?? BigInt(0));
    }
    /**
     * Whether this object uses custom function to check permissions
     * @type {boolean}
     */
    get isCustom() {
        return this.permissions instanceof Function ? true : false;
    }
    /**
     * Permission bitfield
     * @type {BigInt}
     */
    get bitfield() {
        return this.permissions instanceof Function ? BigInt(NaN) : BigInt(this.permissions.bitfield);
    }
    /**
     * Checks if the interaction sender is permitted to use the command attached to this object
     * @param {Interaction | Message} i - command interaction or Discord message
     * @returns {boolean} Whether a sender can use the command bound to this object
     * @public
     */
    check(i) {
        if (this.permissions instanceof Function) {
            return this.permissions(i);
        }
        else {
            if (this.permissions.bitfield === BigInt(0))
                return true;
            const memberPermissions = new Permissions(typeof i.member?.permissions === "string" ? BigInt(0) : i.member?.permissions);
            switch (this.checkType) {
                case "ALL":
                    return memberPermissions.has(this.permissions);
                case "ANY":
                    return memberPermissions.any(this.permissions);
                default:
                    return false;
            }
        }
    }
}