@pikokr/command.ts 4.0.6 → 5.0.0-dev.84d717c

package/src/command/ArgumentConverter.ts

@@ -1,22 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-import { Module } from '../structures'
-import { CommandInteraction, ContextMenuInteraction, Message } from 'discord.js'
-
-export class ArgumentConverter {
-  execute(module: Module, msg: Message, arg?: string) {
-    return this.run.apply(module, [msg, arg])
-  }
-
-  constructor(public type: object, private run: Function, public withoutParameter: boolean) {}
-}
-
-export class ApplicationCommandArgumentConverter {
-  execute(module: Module, interaction: CommandInteraction | ContextMenuInteraction) {
-    return this.run.apply(module, [interaction])
-  }
-
-  constructor(public type: object, private run: Function) {}
-}

package/src/command/Command.ts

@@ -1,35 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-import { Module } from '../structures'
-import { CommandInteraction, ContextMenuInteraction, Message, MessageComponentInteraction } from 'discord.js'
-import { KCommandChecks } from '../constants'
-
-export type Argument = {
-  optional: boolean
-  type: any
-  rest: boolean
-}
-
-export type CheckFunction = (msg: Message) => boolean | Promise<boolean>
-export type ApplicationCommandCheckFunction = (i: CommandInteraction | MessageComponentInteraction | ContextMenuInteraction) => boolean | Promise<boolean>
-
-export class Command {
-  execute(module: Module, args: any[]) {
-    return this.run.apply(module, args)
-  }
-
-  get checks(): CheckFunction[] {
-    return Reflect.getMetadata(KCommandChecks, this.module, this.key) || []
-  }
-
-  constructor(
-    private run: Function,
-    public argTypes: Argument[],
-    public name: string,
-    public aliases: string[] | ((msg: Message) => string[] | Promise<string[]>),
-    public module: Module,
-    public key: symbol | string,
-  ) {}
-}

package/src/command/cooldown/adapter.ts

@@ -1,22 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-import { Collection } from 'discord.js'
-
-export interface CoolDownAdapter {
-  get(id: string): Promise<number | undefined>
-  set(id: string, value: number): Promise<void>
-}
-
-export class DefaultCoolDownAdapter implements CoolDownAdapter {
-  map = new Collection<string, number>()
-  async get(id: string): Promise<number | undefined> {
-    return this.map.get(id)
-  }
-
-  async set(id: string, value: number) {
-    this.map.set(id, value)
-    return
-  }
-}

package/src/command/cooldown/decorator.ts

@@ -1,67 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-import { createCheckDecorator } from '../utils'
-import { CoolDownType } from './type'
-import { DMChannel, GuildMember, TextChannel } from 'discord.js'
-import { CoolDownError } from './error'
-
-export const coolDown = (type: CoolDownType, seconds: number) =>
-  createCheckDecorator(
-    async (msg) => {
-      const a = msg.data.cts.coolDownAdapter
-      const getKey = (): string => {
-        switch (type) {
-          case CoolDownType.USER:
-            return msg.author.id
-          case CoolDownType.GUILD:
-            return (msg.guild || msg.author).id
-          case CoolDownType.CHANNEL:
-            return msg.channel.id
-          case CoolDownType.MEMBER:
-            return `${msg.guild?.id}.${msg.author.id}`
-          case CoolDownType.ROLE:
-            return (msg.channel instanceof DMChannel ? msg.channel : msg.member!.roles.highest).id
-          case CoolDownType.CATEGORY:
-            return ((msg.channel as TextChannel).parent || msg.channel).id
-        }
-      }
-      const key = getKey() + '-command-' + msg.data.command?.name
-      const data = await a.get(key)
-      const now = Date.now()
-      if (!data || !(now - data < seconds * 1000)) {
-        await a.set(key, now)
-        return true
-      }
-      throw new CoolDownError(new Date(data + seconds * 1000))
-    },
-    async (i) => {
-      if (i.isMessageComponent()) return true
-      const a = i.data.cts.coolDownAdapter
-      const getKey = (): string => {
-        switch (type) {
-          case CoolDownType.USER:
-            return i.user.id + '.user'
-          case CoolDownType.GUILD:
-            return (i.guild || i.user).id + '.guild'
-          case CoolDownType.CHANNEL:
-            return i.channel!.id + '.channel'
-          case CoolDownType.MEMBER:
-            return `${i.guild?.id}.${i.user.id}`
-          case CoolDownType.ROLE:
-            return (i.channel instanceof DMChannel ? i.channel : (i.member as GuildMember)!.roles.highest).id + '.role'
-          case CoolDownType.CATEGORY:
-            return ((i.channel as TextChannel).parent || i.channel!).id + '.category'
-        }
-      }
-      const key = getKey() + '-appCommand-' + i.commandName
-      const data = await a.get(key)
-      const now = Date.now()
-      if (!data || !(now - data < seconds * 1000)) {
-        await a.set(key, now)
-        return true
-      }
-      throw new CoolDownError(new Date(data + seconds * 1000))
-    },
-  )

package/src/command/cooldown/error.ts

@@ -1,9 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-export class CoolDownError extends Error {
-  constructor(public endsAt: Date) {
-    super()
-  }
-}

package/src/command/cooldown/index.ts

@@ -1,9 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-export * from './decorator'
-export * from './adapter'
-export * from './decorator'
-export * from './error'
-export * from './type'

package/src/command/cooldown/type.ts

@@ -1,12 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-export enum CoolDownType {
-  USER,
-  CHANNEL,
-  GUILD,
-  ROLE,
-  CATEGORY,
-  MEMBER,
-}

package/src/command/decorator.ts

@@ -1,185 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-import { KArgumentConverters, KCommands, KOptionals, KRest, KSlashArgumentConverters } from '../constants'
-import { Command } from './Command'
-import { checkTarget } from '../utils'
-import { ArgumentConverter, ApplicationCommandArgumentConverter } from './ArgumentConverter'
-import { Module } from '../structures'
-import { createCheckDecorator } from './utils'
-import { GuildMember, Message, PermissionResolvable, Permissions, TextChannel } from 'discord.js'
-import { ClientPermissionRequired, DMOnlyCommandError, GuildOnlyCommandError, OwnerOnlyCommandError, UserPermissionRequired } from '../error'
-
-type CommandOptions = {
-  name: string
-  aliases: string[] | ((msg: Message) => string[])
-  optionTypes?: any[]
-}
-
-export const command = (options: Partial<CommandOptions> = {}) => {
-  return (
-    target: Object,
-    propertyKey: string,
-    // descriptor: TypedPropertyDescriptor<any>,
-  ) => {
-    checkTarget(target)
-
-    let properties: Command[] = Reflect.getMetadata(KCommands, target)
-
-    const params: any[] = options.optionTypes ?? Reflect.getMetadata('design:paramtypes', target, propertyKey)
-
-    const optionals: number = Reflect.getMetadata(KOptionals, target, propertyKey) || -1
-
-    const rest = Reflect.getMetadata(KRest, target, propertyKey) || -1
-
-    const command = new Command(
-      Reflect.get(target, propertyKey),
-      params.map((x, i) => ({
-        type: x,
-        optional: optionals === -1 ? false : optionals <= i,
-        rest: rest === -1 ? false : rest === i,
-      })),
-      options.name || propertyKey,
-      options.aliases || [],
-      target as Module,
-      propertyKey,
-    )
-
-    if (properties) {
-      properties.push(command)
-    } else {
-      properties = [command]
-      Reflect.defineMetadata(KCommands, properties, target)
-    }
-  }
-}
-
-export const argumentConverter = (type: object, requireParameter = true) => {
-  return (
-    target: Object,
-    propertyKey: string,
-    // descriptor: TypedPropertyDescriptor<any>,
-  ) => {
-    checkTarget(target)
-
-    let properties: ArgumentConverter[] = Reflect.getMetadata(KArgumentConverters, target)
-
-    const converter = new ArgumentConverter(type, Reflect.get(target, propertyKey), !requireParameter)
-
-    if (properties) {
-      properties.push(converter)
-    } else {
-      properties = [converter]
-      Reflect.defineMetadata(KArgumentConverters, properties, target)
-    }
-  }
-}
-
-export const applicationCommandArgumentConverter = (type: object) => {
-  return (
-    target: Object,
-    propertyKey: string,
-    // descriptor: TypedPropertyDescriptor<any>,
-  ) => {
-    checkTarget(target)
-
-    let properties: ApplicationCommandArgumentConverter[] = Reflect.getMetadata(KSlashArgumentConverters, target)
-
-    const converter = new ApplicationCommandArgumentConverter(type, Reflect.get(target, propertyKey))
-
-    if (properties) {
-      properties.push(converter)
-    } else {
-      properties = [converter]
-      Reflect.defineMetadata(KSlashArgumentConverters, properties, target)
-    }
-  }
-}
-
-export const optional: ParameterDecorator = (target, propertyKey, parameterIndex) => {
-  checkTarget(target)
-
-  Reflect.defineMetadata(KOptionals, parameterIndex, target, propertyKey)
-}
-
-export const rest: ParameterDecorator = (target, propertyKey, parameterIndex) => {
-  checkTarget(target)
-
-  const params: any[] = Reflect.getMetadata('design:paramtypes', target, propertyKey)
-
-  if (params.length - 1 !== parameterIndex) throw new Error('Rest decorator must be used at last argument.')
-
-  if (params[parameterIndex] !== String) throw new Error('Rest argument type must be "String"')
-
-  Reflect.defineMetadata(KRest, parameterIndex, target, propertyKey)
-}
-
-export const ownerOnly = createCheckDecorator(
-  (msg) => {
-    if (msg.data.cts.owners.includes(msg.author.id)) return true
-    throw new OwnerOnlyCommandError()
-  },
-  (i) => {
-    if (i.data.cts.owners.includes(i.user.id)) return true
-    throw new OwnerOnlyCommandError()
-  },
-)
-
-export const guildOnly = createCheckDecorator(
-  (msg) => {
-    if (!!msg.guild) return true
-    throw new GuildOnlyCommandError()
-  },
-  (i) => {
-    if (!!i.guildId) return true
-    throw new GuildOnlyCommandError()
-  },
-)
-
-export const dmOnly = createCheckDecorator(
-  (msg) => {
-    if (!msg.guild) return true
-    throw new DMOnlyCommandError()
-  },
-  (i) => {
-    if (!i.guildId) return true
-    throw new DMOnlyCommandError()
-  },
-)
-
-export const requireUserPermissions = (permission: PermissionResolvable) =>
-  createCheckDecorator(
-    (msg) => {
-      if (!msg.guild || !msg.member) throw new Error('This command must be used in guild.')
-      if (msg.member.permissionsIn(msg.channel as TextChannel).has(permission)) {
-        return true
-      }
-      throw new UserPermissionRequired(msg.member, new Permissions(permission))
-    },
-    (i) => {
-      if (!i.guild || !i.member) throw new Error('This command must be used in guild.')
-      if (!(i.member instanceof GuildMember) || i.member.permissionsIn(i.channel as TextChannel).has(permission)) {
-        return true
-      }
-      throw new UserPermissionRequired(i.member, new Permissions(permission))
-    },
-  )
-
-export const requireClientPermissions = (permission: PermissionResolvable) =>
-  createCheckDecorator(
-    (msg) => {
-      if (!msg.guild) throw new Error('This command must be used in guild.')
-      if (msg.guild.me!.permissionsIn(msg.channel as TextChannel).has(permission)) {
-        return true
-      }
-      throw new ClientPermissionRequired(new Permissions(permission))
-    },
-    (i) => {
-      if (!i.guild) throw new Error('This command must be used in guild.')
-      if (i.guild.me!.permissionsIn(i.channel as TextChannel).has(permission)) {
-        return true
-      }
-      throw new ClientPermissionRequired(new Permissions(permission))
-    },
-  )

package/src/command/index.ts

@@ -1,9 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-export * from './Command'
-export * from './decorator'
-export * from './ArgumentConverter'
-export * from './utils'
-export * from './cooldown'

package/src/command/utils.ts

@@ -1,33 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-import { CommandInteraction, ContextMenuInteraction, Message, MessageComponentInteraction } from 'discord.js'
-import type { CheckFunction, ApplicationCommandCheckFunction } from './Command'
-import { KCommandChecks, KApplicationCommandChecks } from '../constants'
-
-export const createCheckDecorator = (
-  execute: ((msg: Message) => boolean | Promise<boolean>) | null,
-  executeApplicationCommand?: (i: CommandInteraction | MessageComponentInteraction | ContextMenuInteraction) => boolean | Promise<boolean>,
-): MethodDecorator => {
-  return (target, propertyKey) => {
-    if (execute) {
-      let properties: CheckFunction[] = Reflect.getMetadata(KCommandChecks, target, propertyKey)
-      if (properties) {
-        properties.push(execute)
-      } else {
-        properties = [execute]
-        Reflect.defineMetadata(KCommandChecks, properties, target, propertyKey)
-      }
-    }
-    if (executeApplicationCommand) {
-      let properties: ApplicationCommandCheckFunction[] = Reflect.getMetadata(KApplicationCommandChecks, target, propertyKey)
-      if (properties) {
-        properties.push(executeApplicationCommand)
-      } else {
-        properties = [executeApplicationCommand]
-        Reflect.defineMetadata(KApplicationCommandChecks, properties, target, propertyKey)
-      }
-    }
-  }
-}

package/src/constants.ts

@@ -1,31 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-export const KCommands = Symbol('Command.TS Commands')
-
-export const KApplicationCommands = Symbol('Command.TS Slash Commands')
-
-export const KSlashCommandOptions = Symbol('Command.TS Slash Command Options')
-
-export const KListeners = Symbol('Command.TS Listeners')
-
-export const KModulePath = Symbol('Command.TS Module Path')
-
-export const KListenerExecuteCache = Symbol('Command.TS Module Identifier')
-
-export const KBuiltInModule = Symbol('Command.TS Built-In Module')
-
-export const KOptionals = Symbol('Command.TS Optional Parameters')
-
-export const KRest = Symbol('Command.TS Rest Parameter')
-
-export const KArgumentConverters = Symbol('Command.TS Argument Converter')
-
-export const KSlashArgumentConverters = Symbol('Command.TS Slash Argument Converter')
-
-export const KCommandChecks = Symbol('Command.TS Command Checks')
-
-export const KApplicationCommandChecks = Symbol('Command.TS Slash Command Checks')
-
-export const KMessageComponentHandlers = Symbol('Command.TS Message Component Handlers')

package/src/error/ArgumentConverterNotFound.ts

@@ -1,18 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-import { CommandInteraction, ContextMenuInteraction, Message } from 'discord.js'
-import type { Argument } from '../command'
-import type { AppCommandArgument } from '../applicationCommand'
-
-export class ArgumentConverterNotFound extends Error {
-  constructor(public type: Argument, public msg: Message) {
-    super(`Argument converter ${type.type.name} not found.`)
-  }
-}
-export class ApplicationCommandArgumentConverterNotFound extends Error {
-  constructor(public type: AppCommandArgument, public interaction: CommandInteraction | ContextMenuInteraction) {
-    super(`Argument converter ${type.type.name} not found.`)
-  }
-}

package/src/error/ArgumentNotProvided.ts

@@ -1,12 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-import { Message } from 'discord.js'
-import { Command } from '../command'
-
-export class ArgumentNotProvided extends Error {
-  constructor(public index: number, public command: Command, public msg: Message) {
-    super(`Required argument #${index} not provided.`)
-  }
-}

package/src/error/CommandCheckFailed.ts

@@ -1,19 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-import { CommandInteraction, ContextMenuInteraction, Message, MessageComponentInteraction } from 'discord.js'
-import { Command } from '../command'
-import { AppCommand } from '../applicationCommand'
-
-export class CommandCheckFailed extends Error {
-  constructor(public msg: Message, public command: Command) {
-    super()
-  }
-}
-
-export class ApplicationCommandCheckFailed extends Error {
-  constructor(public interaction: CommandInteraction | MessageComponentInteraction | ContextMenuInteraction, public command: AppCommand) {
-    super()
-  }
-}

package/src/error/CommandNotFound.ts

@@ -1,11 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-import { Message } from 'discord.js'
-
-export class CommandNotFound extends Error {
-  constructor(public commandName: string, public msg: Message, public args: string[]) {
-    super(`Command ${commandName} not found.`)
-  }
-}

package/src/error/InvalidTargetError.ts

@@ -1,9 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-export class InvalidTargetError extends Error {
-  constructor() {
-    super('Class does not extend "Module" class.')
-  }
-}

package/src/error/ModuleError.ts

@@ -1,11 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-export class ModuleLoadError extends Error {
-  constructor(file: string, public error: Error) {
-    super('Failed to load module ' + file)
-  }
-}
-
-export class InvalidModuleError extends Error {}

package/src/error/PermissionRequired.ts

@@ -1,17 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-import { GuildMember, Permissions } from 'discord.js'
-
-export class UserPermissionRequired extends Error {
-  constructor(public user: GuildMember, public permissions: Permissions) {
-    super()
-  }
-}
-
-export class ClientPermissionRequired extends Error {
-  constructor(public permissions: Permissions) {
-    super()
-  }
-}

package/src/error/checks/DMOnlyCommand.ts

@@ -1,9 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-export class DMOnlyCommandError extends Error {
-  constructor() {
-    super()
-  }
-}

package/src/error/checks/GuildOnlyCommand.ts

@@ -1,9 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-export class GuildOnlyCommandError extends Error {
-  constructor() {
-    super()
-  }
-}

package/src/error/checks/OwnerOnlyCommand.ts

@@ -1,9 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-export class OwnerOnlyCommandError extends Error {
-  constructor() {
-    super()
-  }
-}

package/src/error/checks/SlashCommandGlobalCheckError.ts

@@ -1,11 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-import { CommandInteraction } from 'discord.js'
-
-export class SlashCommandGlobalCheckError extends Error {
-  constructor(public i: CommandInteraction) {
-    super('Slash command before-run check failed.')
-  }
-}

package/src/error/checks/index.ts

@@ -1,8 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-export * from './OwnerOnlyCommand'
-export * from './GuildOnlyCommand'
-export * from './DMOnlyCommand'
-export * from './SlashCommandGlobalCheckError'

package/src/error/index.ts

@@ -1,12 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-export * from './InvalidTargetError'
-export * from './ModuleError'
-export * from './ArgumentNotProvided'
-export * from './ArgumentConverterNotFound'
-export * from './CommandCheckFailed'
-export * from './PermissionRequired'
-export * from './checks'
-export * from './CommandNotFound'

package/src/interface/index.ts

@@ -1,7 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-// export type { HandlerAdapter } from './HandlerAdapter'
-
-export {}

package/src/listener/Listener.ts

@@ -1,7 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-export class Listener {
-  constructor(public name: string, public execute: Function) {}
-}

package/src/listener/decorator.ts

@@ -1,29 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-import { checkTarget } from '../utils'
-import { KListeners } from '../constants'
-import { Listener } from './Listener'
-import { Module } from '../structures'
-
-export const listener = (event: string) => {
-  return (
-    target: Module,
-    propertyKey: string,
-    // descriptor: TypedPropertyDescriptor<any>,
-  ) => {
-    checkTarget(target)
-
-    let properties: Listener[] = Reflect.getMetadata(KListeners, target)
-
-    const listener = new Listener(event, Reflect.get(target, propertyKey))
-
-    if (properties) {
-      properties.push(listener)
-    } else {
-      properties = [listener]
-      Reflect.defineMetadata(KListeners, properties, target)
-    }
-  }
-}

package/src/listener/index.ts

@@ -1,6 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-export * from './Listener'
-export * from './decorator'