@pikokr/command.ts 4.0.7 → 5.0.0-dev.44dc47f

package/src/core/structures/CommandClient.ts

@@ -0,0 +1,78 @@
+/*
+* File: CommandClient.ts
+* 
+* Copyright (c) 2022-2022 pikokr
+* 
+* Licensed under MIT License. Please see more defails in LICENSE file.
+*/
+
+import chalk from 'chalk'
+import { Client, Snowflake, Team, User } from 'discord.js'
+import EventEmitter from 'events'
+import { Logger } from 'tslog'
+import { ApplicationCommandExtension, ApplicationCommandExtensionConfig } from '../../applicationCommand/ApplicationCommandExtension'
+import { TextCommandConfig } from '../../textCommand'
+import { TextCommandExtension } from '../../textCommand/TextCommandExtension'
+import { CommandClientSymbol } from '../symbols'
+import { Registry } from './Registry'
+export class CommandClient extends EventEmitter {
+  ctsLogger: Logger
+  registry: Registry
+
+  owners: Set<Snowflake> = new Set()
+
+  constructor(public discord: Client, public logger: Logger = new Logger({ dateTimeTimezone: Intl.DateTimeFormat().resolvedOptions().timeZone })) {
+    super()
+
+    this.ctsLogger = logger.getChildLogger({ prefix: [chalk.blue('[command.ts]')], displayFilePath: 'hidden', displayFunctionName: false })
+
+    this.registry = new Registry(this.ctsLogger, this)
+
+    this.registry.registerEventEmitter('cts', this)
+    this.registry.registerEventEmitter('discord', this.discord)
+  }
+
+  async fetchOwners() {
+    if (!this.discord.application) throw new Error('The client is not logged in.')
+
+    this.ctsLogger.info('Fetching owners...')
+
+    await this.discord.application.fetch()
+
+    const owner = this.discord.application.owner
+
+    if (!owner) throw new Error('Cannot find application owner')
+
+    const owners: string[] = []
+
+    if (owner instanceof User) {
+      this.owners.add(owner.id)
+      owners.push(owner.tag)
+    } else if (owner instanceof Team) {
+      for (const [id, member] of owner.members) {
+        this.owners.add(id)
+        owners.push(member.user.tag)
+      }
+    }
+
+    this.ctsLogger.info(`Fetched ${chalk.green(owners.length)} owners(${owners.map((x) => chalk.blue(x)).join(', ')})`)
+  }
+
+  async enableApplicationCommandsExtension(config: ApplicationCommandExtensionConfig) {
+    await this.registry.registerModule(new ApplicationCommandExtension(config))
+    this.ctsLogger.info('Application command extension enabled.')
+  }
+
+  async enableTextCommandsExtension(config: TextCommandConfig) {
+    await this.registry.registerModule(new TextCommandExtension(config))
+    this.ctsLogger.info('Text command extension enabled.')
+  }
+
+  getApplicationCommandsExtension() {
+    return this.registry.extensions.find((x) => x.constructor === ApplicationCommandExtension) as ApplicationCommandExtension | undefined
+  }
+
+  static getFromModule(ext: object): CommandClient {
+    return Reflect.getMetadata(CommandClientSymbol, ext)
+  }
+}

package/src/core/structures/Registry.ts

@@ -0,0 +1,110 @@
+/*
+* File: Registry.ts
+* 
+* Copyright (c) 2022-2022 pikokr
+* 
+* Licensed under MIT License. Please see more defails in LICENSE file.
+*/
+
+import chalk from 'chalk'
+import { Collection } from 'discord.js'
+import EventEmitter from 'events'
+import _ from 'lodash'
+import { Logger } from 'tslog'
+import { getComponentStore } from '../components'
+import type { BaseComponent } from '../components'
+import { getModuleHookStore } from '../hooks'
+import { ListenerComponent } from '../listener'
+import { CommandClientSymbol } from '../symbols'
+import { CommandClient } from './CommandClient'
+
+export class Registry {
+  extensions: object[] = []
+
+  emitters: Collection<string, EventEmitter> = new Collection()
+
+  logger: Logger
+
+  constructor(logger: Logger, public client: CommandClient) {
+    this.logger = logger.getChildLogger({
+      prefix: [chalk.green('[Registry]')],
+    })
+  }
+
+  getComponentsWithTypeGlobal<T extends typeof BaseComponent<Config>, Config>(type: T): InstanceType<T>[] {
+    const result: InstanceType<T>[] = []
+
+    for (const ext of this.extensions) {
+      result.push(...this.getComponentsWithType(ext, type))
+    }
+
+    return result
+  }
+
+  getComponentsWithType<T extends typeof BaseComponent<Config>, Config>(ext: object, type: T): InstanceType<T>[] {
+    const componentStore = getComponentStore(ext)
+
+    return Array.from(componentStore.filter((x) => (x.constructor as unknown) === type).values() as Iterable<InstanceType<T>>)
+  }
+
+  registerEventListeners(ext: object) {
+    const listeners = this.getComponentsWithType(ext, ListenerComponent)
+
+    for (const listener of listeners) {
+      const emitter = this.emitters.get(listener.options.emitter)
+
+      if (emitter) {
+        const bound = listener.method.bind(ext)
+
+        Reflect.defineMetadata('bound', bound, listener)
+
+        emitter.addListener(listener.options.event, bound)
+      }
+    }
+  }
+
+  unregisterEventListeners(ext: object) {
+    const listeners = this.getComponentsWithType(ext, ListenerComponent)
+
+    for (const listener of listeners) {
+      const emitter = this.emitters.get(listener.options.emitter)
+      const bound = Reflect.getMetadata('bound', listener)
+
+      if (emitter && bound) {
+        emitter.removeListener(listener.options.event, bound)
+      }
+    }
+  }
+
+  async registerModule(ext: object) {
+    Reflect.defineMetadata(CommandClientSymbol, this.client, ext)
+
+    this.registerEventListeners(ext)
+    await this.runModuleHook(ext, 'load')
+    this.extensions.push(ext)
+    this.logger.info(`Module registered: ${chalk.green(ext.constructor.name)}`)
+  }
+
+  async unregisterModule(ext: object) {
+    this.unregisterEventListeners(ext)
+    await this.runModuleHook(ext, 'unload')
+    _.remove(this.extensions, (x) => x === ext)
+    this.logger.info(`Module unregistered: ${chalk.green(ext.constructor.name)}`)
+  }
+
+  runModuleHook(ext: object, hookName: string, ...args: unknown[]) {
+    const hooks = getModuleHookStore(ext)
+
+    const functions = hooks.get(hookName)
+
+    if (functions) {
+      for (const fn of functions) {
+        fn.call(ext, ...args)
+      }
+    }
+  }
+
+  registerEventEmitter(name: string, emitter: EventEmitter) {
+    this.emitters.set(name, emitter)
+  }
+}

package/src/core/structures/index.ts

@@ -0,0 +1,10 @@
+/*
+* File: index.ts
+* 
+* Copyright (c) 2022-2022 pikokr
+* 
+* Licensed under MIT License. Please see more defails in LICENSE file.
+*/
+
+export * from './Registry'
+export * from './CommandClient'

package/src/core/symbols.ts

@@ -0,0 +1,13 @@
+/*
+* File: symbols.ts
+* 
+* Copyright (c) 2022-2022 pikokr
+* 
+* Licensed under MIT License. Please see more defails in LICENSE file.
+*/
+
+export const ComponentStoreSymbol = Symbol()
+export const ComponentArgStoreSymbol = Symbol()
+export const ModuleHookStoreSymbol = Symbol()
+export const CommandClientSymbol = Symbol()
+export const ComponentHookSymbol = Symbol()

package/src/core/utils/checks.ts

@@ -0,0 +1,27 @@
+/*
+* File: checks.ts
+* 
+* Copyright (c) 2022-2022 pikokr
+* 
+* Licensed under MIT License. Please see more defails in LICENSE file.
+*/
+
+import { BaseInteraction, Interaction, Message } from 'discord.js'
+import { createComponentHook } from '../hooks'
+import { ComponentHookFn } from '../hooks/componentHook'
+import { CommandClient } from '../structures'
+import { OwnerOnlyError } from './errors'
+
+export const createCheckDecorator = (fn: ComponentHookFn) => createComponentHook('beforeCall', fn)
+
+export const ownerOnly = createCheckDecorator(async (client: CommandClient, i: Interaction | Message) => {
+  let isOwner = false
+
+  if (i instanceof BaseInteraction) {
+    isOwner = client.owners.has(i.user.id)
+  } else if (i instanceof Message) {
+    isOwner = client.owners.has(i.author.id)
+  }
+
+  if (!isOwner) throw new OwnerOnlyError()
+})

package/src/core/utils/errors.ts

@@ -0,0 +1,9 @@
+/*
+* File: errors.ts
+* 
+* Copyright (c) 2022-2022 pikokr
+* 
+* Licensed under MIT License. Please see more defails in LICENSE file.
+*/
+
+export class OwnerOnlyError {}

package/src/core/utils/index.ts

@@ -0,0 +1,10 @@
+/*
+* File: index.ts
+* 
+* Copyright (c) 2022-2022 pikokr
+* 
+* Licensed under MIT License. Please see more defails in LICENSE file.
+*/
+
+export * from './checks'
+export * from './errors'

package/src/index.ts

@@ -1,16 +1,11 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-import 'reflect-metadata'
-import './typings'
-
-export * from './interface'
-export * from './structures'
-export * from './error'
-export * from './command'
-export * from './listener'
-export * from './builtinModules/BuiltInModule'
-export * from './applicationCommand'
-export * from './messageComponents'
-export * from './error'
+/*
+* File: index.ts
+* 
+* Copyright (c) 2022-2022 pikokr
+* 
+* Licensed under MIT License. Please see more defails in LICENSE file.
+*/
+
+export * from './core'
+export * from './applicationCommand'
+export * from './textCommand'

package/src/textCommand/TextCommand.ts

@@ -0,0 +1,20 @@
+/*
+* File: TextCommand.ts
+* 
+* Copyright (c) 2022-2022 pikokr
+* 
+* Licensed under MIT License. Please see more defails in LICENSE file.
+*/
+
+import { createComponentDecorator } from '../core/components/decoratorCreator'
+import { BaseComponent } from '../core/components/BaseComponent'
+
+type TextCommandOptions = {
+  name: string
+  aliases?: string
+  description?: string
+}
+
+export class TextCommandComponent extends BaseComponent<TextCommandOptions> {}
+
+export const command = createComponentDecorator(TextCommandComponent)

package/src/textCommand/TextCommandExtension.ts

@@ -0,0 +1,128 @@
+/*
+* File: TextCommandExtension.ts
+* 
+* Copyright (c) 2022-2022 pikokr
+* 
+* Licensed under MIT License. Please see more defails in LICENSE file.
+*/
+
+import { listener } from '../core/listener'
+import { Message } from 'discord.js'
+import { CTSExtension } from '../core/extensions/CTSExtension'
+import { TextCommandComponent } from './TextCommand'
+import { TextCommandRestOption } from './parameters'
+import { argConverter } from '../core'
+
+export type TextCommandConfig = {
+  prefix: string | string[] | ((msg: Message) => Promise<string | string[]> | string | string[])
+}
+
+export class TextCommandExtension extends CTSExtension {
+  constructor(private config: TextCommandConfig) {
+    super()
+  }
+
+  private async processPrefix(msg: Message): Promise<number | null> {
+    const content = msg.content
+    let prefix = this.config.prefix
+
+    if (typeof prefix === 'function') {
+      prefix = await prefix(msg)
+    }
+
+    if (typeof prefix === 'string') {
+      if (content.startsWith(prefix)) return prefix.length
+      return null
+    }
+
+    if (prefix instanceof Array) {
+      const p = prefix.find((x) => content.startsWith(x))
+
+      if (p) return p.length
+      return null
+    }
+
+    return null
+  }
+
+  @listener({ event: 'messageCreate', emitter: 'discord' })
+  private async messageCreate(msg: Message) {
+    const startIndex = await this.processPrefix(msg)
+
+    if (!startIndex) return
+
+    const content = msg.content.slice(startIndex)
+
+    const commands: TextCommandComponent[] = []
+
+    const extensions = new Map<TextCommandComponent, object>()
+
+    for (const ext of this.commandClient.registry.extensions) {
+      for (const cmd of this.commandClient.registry.getComponentsWithType(ext, TextCommandComponent)) {
+        commands.push(cmd)
+        extensions.set(cmd, ext)
+      }
+    }
+
+    let commandNameLength = 0
+
+    const command = commands.find((x) => {
+      const names = [x.options.name]
+
+      if (x.options.aliases) {
+        names.push(...x.options.aliases)
+      }
+
+      for (const name of names) {
+        if (content.startsWith(name)) {
+          if (content.length === name.length) {
+            commandNameLength = name.length
+            return true
+          }
+          commandNameLength = name.length
+          return content.startsWith(name + ' ')
+        }
+      }
+
+      return false
+    })
+
+    if (!command) return
+
+    const ext = extensions.get(command)
+
+    if (!ext) return
+
+    const args: unknown[] = []
+
+    let argStrings = content.slice(commandNameLength + 1).split(/ /g)
+
+    await this.convertArguments(TextCommandComponent, args, command.argTypes, async (arg, i, converter) => {
+      if (converter.options.parameterless) return [msg]
+
+      if (arg.decorators.find((x) => x.constructor === TextCommandRestOption)) {
+        const text = argStrings.join(' ')
+        argStrings = []
+        return [text, msg]
+      }
+      return [argStrings.shift(), msg]
+    })
+
+    await command.execute(ext, args, [msg])
+  }
+
+  @argConverter({ component: TextCommandComponent, type: Message, parameterless: true })
+  async mesage(msg: Message) {
+    return msg
+  }
+
+  @argConverter({ component: TextCommandComponent, type: String })
+  async str(value: string) {
+    return value
+  }
+
+  @argConverter({ component: TextCommandComponent, type: Number })
+  async num(value: string) {
+    return Number(value)
+  }
+}

package/src/textCommand/index.ts

@@ -0,0 +1,11 @@
+/*
+* File: index.ts
+* 
+* Copyright (c) 2022-2022 pikokr
+* 
+* Licensed under MIT License. Please see more defails in LICENSE file.
+*/
+
+export * from './TextCommand'
+export type { TextCommandConfig } from './TextCommandExtension'
+export * from './parameters'

package/src/textCommand/parameters.ts

@@ -0,0 +1,14 @@
+/*
+ * File: parameters.ts
+ *
+ * Copyright (c) 2022-2022 pikokr
+ *
+ * Licensed under MIT License. Please see more defails in LICENSE file.
+ */
+
+import { ComponentArgumentDecorator } from '../core'
+import { createArgumentDecorator } from '../core'
+
+export class TextCommandRestOption extends ComponentArgumentDecorator<void> {}
+
+export const rest = createArgumentDecorator(TextCommandRestOption)

package/test/index.ts

@@ -1,28 +1,93 @@
 /*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
+ * File: index.ts
+ *
+ * Copyright (c) 2022-2022 pikokr
+ *
+ * Licensed under MIT License. Please see more defails in LICENSE file.
  */
 
-import { Client, Intents, IntentsString } from 'discord.js'
-import { CommandClient } from '../dist'
+import { ApplicationCommandOptionType, ApplicationCommandType, ChatInputCommandInteraction, Client, Message } from 'discord.js'
+import { applicationCommand, CommandClient, moduleHook, option, ownerOnly, listener, Extension, command, rest } from '../src'
+import 'dotenv/config'
+import { Logger } from 'tslog'
+import chalk from 'chalk'
 
-const config = require('./config.json')
+class Test extends Extension {
+  @applicationCommand({
+    type: ApplicationCommandType.ChatInput,
+    name: 'test',
+    description: 'wow this is test',
+  })
+  async testCommand(i: ChatInputCommandInteraction) {
+    i.reply('Wow')
+  }
 
-const client = new Client({
-  intents: ['GUILD_MESSAGES','GUILDS','DIRECT_MESSAGES'],
-})
+  @ownerOnly
+  @applicationCommand({
+    type: ApplicationCommandType.ChatInput,
+    name: 'test2',
+    description: 'wow this is test wow',
+  })
+  async test2(
+    @option({
+      name: 'sans',
+      description: '와',
+      type: ApplicationCommandOptionType.String,
+      required: true,
+    })
+    wa: string,
+    i: ChatInputCommandInteraction,
+  ) {
+    i.reply(wa)
+  }
 
-const cts = new CommandClient({
-  owners: 'auto',
-  client,
-  command: {
-    prefix: '!',
-  },
-  applicationCommands: {
-    autoSync: true,
-    guild: '969907569592250449',
-  },
-})
+  @moduleHook('load')
+  load() {
+    this.logger.info('Load')
+  }
 
-cts.registry.loadModulesIn('modules')
+  @moduleHook('unload')
+  unload() {
+    this.logger.info('Unload')
+  }
 
-client.login(config.token)
+  @listener({ event: 'ready' })
+  async testEvent() {
+    this.logger.info(`Login: ${chalk.green(client.user!.tag)}`)
+    await this.commandClient.fetchOwners()
+  }
+
+  @command({ name: 'test' })
+  async test(msg: Message, @rest() sans: string) {
+    console.log(sans)
+    await msg.reply('Wow')
+  }
+}
+
+const ext = new Test()
+
+const client = new Client({ intents: ['GuildMessages', 'MessageContent', 'DirectMessages', 'Guilds'] })
+
+const logger = new Logger({ dateTimeTimezone: Intl.DateTimeFormat().resolvedOptions().timeZone })
+
+const cc = new CommandClient(client, logger)
+
+const registry = cc.registry
+
+const run = async () => {
+  await cc.enableApplicationCommandsExtension({
+    guilds: ['832938554438844438'],
+  })
+
+  await cc.enableTextCommandsExtension({
+    prefix: '.',
+  })
+
+  await registry.registerModule(ext)
+
+  await client.login(process.env.TOKEN)
+
+  await cc.getApplicationCommandsExtension()!.sync()
+}
+
+run()

package/tsconfig.json

@@ -15,11 +15,10 @@
     "declaration": true,
     /* Generates corresponding '.d.ts' file. */
     // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
-     "sourceMap": true,                           /* Generates corresponding '.map' file. */
+    "sourceMap": true /* Generates corresponding '.map' file. */,
     // "outFile": "./",                             /* Concatenate and emit output to single file. */
     "outDir": "./dist",
     /* Redirect output structure to the directory. */
-    "rootDir": "./src",
     /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
     // "composite": true,                           /* Enable project compilation */
     // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
@@ -31,6 +30,7 @@
 
     /* Strict Type-Checking Options */
     "strict": true,
+
     /* Enable all strict type-checking options. */
     // "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
     // "strictNullChecks": true,                    /* Enable strict null checks. */
@@ -79,5 +79,5 @@
     "forceConsistentCasingInFileNames": true
     /* Disallow inconsistently-cased references to the same file. */
   },
-  "exclude": ["test", "node_modules", "dist", "tsup.config.ts", "scripts"]
+  "exclude": ["node_modules"]
 }

package/tsconfig.prod.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "scripts", "test", "tsup.config.ts"],
+  "include": ["src"],
+  "compilerOptions": {
+    "rootDir": "./src",
+  }
+}

package/tsup.config.ts

@@ -1,7 +1,11 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
+/*
+* File: tsup.config.ts
+* 
+* Copyright (c) 2022-2022 pikokr
+* 
+* Licensed under MIT License. Please see more defails in LICENSE file.
+*/
+
 import { defineConfig } from 'tsup'
 
 export default defineConfig({
@@ -11,4 +15,5 @@ export default defineConfig({
   clean: true,
   dts: true,
   minify: true,
+  tsconfig: 'tsconfig.prod.json',
 })

package/src/applicationCommand/AppCommand.ts

@@ -1,32 +0,0 @@
-/*
- * Copyright (c) 2022 pikokr. Licensed under the MIT license
- */
-
-import { Module } from '../structures'
-import { ApplicationCommandDataResolvable, Snowflake } from 'discord.js'
-import { KApplicationCommandChecks } from '../constants'
-import { ApplicationCommandCheckFunction } from '../command'
-
-export type AppCommandArgument = {
-  type: any
-  name?: string
-}
-
-export class AppCommand {
-  get checks(): ApplicationCommandCheckFunction[] {
-    return Reflect.getMetadata(KApplicationCommandChecks, this.module, this.key) || []
-  }
-
-  execute(module: Module, args: any[]) {
-    return this.run.apply(module, args)
-  }
-
-  constructor(
-    public command: ApplicationCommandDataResolvable,
-    private run: Function,
-    public module: Module,
-    public params: AppCommandArgument[],
-    public guild: Snowflake | Snowflake[] | undefined,
-    private key: string | symbol,
-  ) {}
-}