commandkit 0.1.6-dev.20231006183935 → 0.1.6-dev.20231112142249

package/bin/build.mjs

@@ -0,0 +1,44 @@
+// @ts-check
+
+import { build } from 'tsup';
+import ora from 'ora';
+import { Colors, erase, findCommandKitJSON, panic, write } from './common.mjs';
+
+export async function bootstrapProductionBuild(config) {
+    const {
+        minify = false,
+        outDir = 'dist',
+        main,
+        src,
+    } = findCommandKitJSON(config);
+
+    const status = ora('Creating optimized production build...\n').start();
+    const start = performance.now();
+
+    erase(outDir);
+
+    try {
+        await build({
+            clean: true,
+            format: ['esm'],
+            dts: false,
+            skipNodeModulesBundle: true,
+            minify,
+            shims: true,
+            banner: {
+                js: '/* Optimized production build of your project, generated by CommandKit */'
+            },
+            sourcemap: false,
+            keepNames: true,
+            outDir,
+            silent: true,
+            entry: [src, '!dist', '!.commandkit'],
+        });
+
+        status.succeed(Colors.green(`Build completed in ${(performance.now() - start).toFixed(2)}ms!`));
+        write(Colors.green(`\nRun ${Colors.magenta(`node ${outDir}/${main}`)} ${Colors.green('to start your bot.')}`))
+    } catch (e) {
+        status.fail(`Build failed after ${(performance.now() - start).toFixed(2)}ms!`)
+        panic(e);
+    }
+}

package/bin/common.mjs

@@ -0,0 +1,74 @@
+// @ts-check
+
+import { join } from 'node:path'
+import fs from 'node:fs';
+import { rimrafSync } from 'rimraf'
+
+const resetColor = '\x1b[0m';
+
+export const Colors = {
+    reset: (text) => `${text}${resetColor}`,
+    bright: (text) => `\x1b[1m${text}${resetColor}`,
+    dim: (text) => `\x1b[2m${text}${resetColor}`,
+    underscore: (text) => `\x1b[4m${text}${resetColor}`,
+    blink: (text) => `\x1b[5m${text}${resetColor}`,
+    reverse: (text) => `\x1b[7m${text}${resetColor}`,
+    hidden: (text) => `\x1b[8m${text}${resetColor}`,
+
+    black: (text) => `\x1b[30m${text}${resetColor}`,
+    red: (text) => `\x1b[31m${text}${resetColor}`,
+    green: (text) => `\x1b[32m${text}${resetColor}`,
+    yellow: (text) => `\x1b[33m${text}${resetColor}`,
+    blue: (text) => `\x1b[34m${text}${resetColor}`,
+    magenta: (text) => `\x1b[35m${text}${resetColor}`,
+    cyan: (text) => `\x1b[36m${text}${resetColor}`,
+    white: (text) => `\x1b[37m${text}${resetColor}`,
+
+    bgBlack: (text) => `\x1b[40m${text}${resetColor}`,
+    bgRed: (text) => `\x1b[41m${text}${resetColor}`,
+    bgGreen: (text) => `\x1b[42m${text}${resetColor}`,
+    bgYellow: (text) => `\x1b[43m${text}${resetColor}`,
+    bgBlue: (text) => `\x1b[44m${text}${resetColor}`,
+    bgMagenta: (text) => `\x1b[45m${text}${resetColor}`,
+    bgCyan: (text) => `\x1b[46m${text}${resetColor}`,
+    bgWhite: (text) => `\x1b[47m${text}${resetColor}`,
+};
+
+export function write(message) {
+    process.stdout.write(message);
+    process.stdout.write('\n');
+}
+
+/**
+ * @returns {never}
+ */
+export function panic(message) {
+    write(Colors.red(`Error: ${message}`));
+    process.exit(1);
+}
+
+export function findPackageJSON() {
+    const cwd = process.cwd();
+    const target = join(cwd, 'package.json');
+
+    if (!fs.existsSync(target)) {
+        panic('Could not find package.json in current directory.');
+    }
+
+    return JSON.parse(fs.readFileSync(target, 'utf8'));
+}
+
+export function findCommandKitJSON(src) {
+    const cwd = process.cwd();
+    const target = src || join(cwd, 'commandkit.json');
+
+    if (!fs.existsSync(target)) {
+        panic('Could not find commandkit.json in current directory.');
+    }
+
+    return JSON.parse(fs.readFileSync(target, 'utf8'));
+}
+
+export function erase(dir) {
+    rimrafSync(dir);
+}

package/bin/dev-server.mjs

@@ -0,0 +1,89 @@
+// @ts-check
+import { config as dotenv } from 'dotenv'
+import { build } from 'tsup';
+import child_process from 'node:child_process'
+import ora from 'ora';
+import { join } from 'node:path';
+import { Colors, erase, findCommandKitJSON, panic, write } from './common.mjs';
+
+export async function bootstrapDevelopmentServer(config) {
+    const {
+        src,
+        main = 'index.mjs',
+        nodeOptions = ['--watch']
+    } = findCommandKitJSON(config);
+
+    if (!src) {
+        panic('Could not find src in commandkit.json');
+    }
+
+    const status = ora(Colors.green('Starting a development server...\n')).start();
+    const start = performance.now();
+
+    erase('.commandkit');
+
+    try {
+        await build({
+            clean: true,
+            format: ['esm'],
+            dts: false,
+            skipNodeModulesBundle: true,
+            minify: false,
+            shims: true,
+            sourcemap: false,
+            keepNames: true,
+            outDir: '.commandkit',
+            silent: true,
+            entry: [src, '!dist', '!.commandkit'],
+            watch: nodeOptions.includes('--watch'),
+        });
+
+        status.succeed(Colors.green(`Server started in ${(performance.now() - start).toFixed(2)}ms!\n`));
+
+        const processEnv = {};
+
+        const env = dotenv({
+            path: join(process.cwd(), '.env'),
+            // @ts-expect-error
+            processEnv
+        });
+
+        if (env.error) {
+            write(Colors.yellow(`[DOTENV] Warning: ${env.error.message}`));
+        }
+
+        if (env.parsed) {
+            write(Colors.blue('[DOTENV] Loaded .env file!'));
+        }
+
+        const ps = child_process.spawn('node', [...nodeOptions, join(process.cwd(), '.commandkit', main)], {
+            env: {
+                ...process.env,
+                ...processEnv,
+                NODE_ENV: 'development',
+                COMMANDKIT_DEV: 'true'
+            },
+            cwd: process.cwd(),
+        });
+
+        ps.stdout.on('data', (data) => {
+            write(data.toString());
+        });
+
+        ps.stderr.on('data', (data) => {
+            write(Colors.red(data.toString()));
+        });
+
+        ps.on('close', (code) => {
+            write('\n');
+            process.exit(code ?? 0);
+        });
+
+        ps.on('error', (err) => {
+            panic(err);
+        });
+    } catch (e) {
+        status.fail(`Error occurred after ${(performance.now() - start).toFixed(2)}ms!\n`)
+        panic(e);
+    }
+}

package/bin/index.mjs

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+
+// @ts-check
+
+import { Command } from 'commander';
+import { bootstrapDevelopmentServer } from './dev-server.mjs';
+import { bootstrapProductionBuild } from './build.mjs';
+
+const program = new Command('commandkit');
+
+program.command('dev')
+    .description('Start your bot in development mode.')
+    .option('-c, --config <path>', 'Path to your commandkit.json file.', './commandkit.json')
+    .action(() => {
+        const options = program.opts();
+        bootstrapDevelopmentServer(options.config)
+    });
+
+program.command('build')
+    .description('Build your project for production usage.')
+    .option('-c, --config <path>', 'Path to your commandkit.json file.', './commandkit.json')
+    .action(() => {
+        const options = program.opts();
+        bootstrapProductionBuild(options.config)
+    });
+
+program.parse();

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { CommandInteraction, Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, PermissionResolvable, APIApplicationCommandOption } from 'discord.js';
+import { CommandInteraction, Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, PermissionResolvable, APIApplicationCommandOption, ButtonInteraction, Awaitable, Message, InteractionCollectorOptions, ButtonBuilder } from 'discord.js';
 
 interface CommandProps {
     interaction: CommandInteraction;
@@ -150,4 +150,55 @@ declare class CommandKit {
     get devRoleIds(): string[];
 }
 
-export { CommandData, CommandKit, CommandObject, CommandOptions, CommandProps, CommandType, ContextMenuCommandProps, ReloadType, SlashCommandProps, ValidationFunctionProps };
+type CommandKitButtonBuilderInteractionCollectorDispatch = (interaction: ButtonInteraction) => Awaitable<void>;
+type CommandKitButtonBuilderInteractionCollectorDispatchContextData = {
+    /**
+     * The message to listen for button interactions on.
+     */
+    message: Message;
+    /**
+     * If the collector should automatically reset the timer when a button is clicked.
+     */
+    autoReset?: boolean;
+} & Omit<InteractionCollectorOptions<ButtonInteraction>, 'filter' | 'componentType'>;
+declare class ButtonKit extends ButtonBuilder {
+    #private;
+    /**
+     * Sets up an inline interaction collector for this button. This collector by default allows as many interactions as possible if it is actively used.
+     * If unused, this expires after 24 hours or custom time if specified.
+     * @param handler The handler to run when the button is clicked
+     * @param data The context data to use for the interaction collector
+     * @returns This button
+     * @example
+     * ```ts
+     * const button = new ButtonKit()
+     *   .setLabel('Click me')
+     *   .setStyle(ButtonStyle.Primary)
+     *   .setCustomId('click_me');
+     *
+     * const message = await channel.send({ content: 'Click the button', components: [new MessageActionRow().addComponents(button)] });
+     *
+     * button.onClick(async (interaction) => {
+     *   await interaction.reply('You clicked me!');
+     * }, { message });
+     *
+     * // remove onClick handler and destroy the interaction collector
+     * button.onClick(null);
+     * ```
+     */
+    onClick(handler: null): this;
+    onClick(handler: CommandKitButtonBuilderInteractionCollectorDispatch, data: CommandKitButtonBuilderInteractionCollectorDispatchContextData): this;
+}
+
+type CommandKitEffectCallback = () => void;
+type CommandKitSignalInitializer<T> = T | (() => T);
+type CommandKitSignalUpdater<T> = T | ((prev: T) => T);
+type CommandKitSignal<T> = readonly [
+    () => T,
+    (value: CommandKitSignalUpdater<T>) => void,
+    () => void
+];
+declare function createSignal<T = unknown>(value?: CommandKitSignalInitializer<T>): CommandKitSignal<T>;
+declare function createEffect(callback: CommandKitEffectCallback): void;
+
+export { ButtonKit, CommandData, CommandKit, CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitEffectCallback, CommandKitSignal, CommandKitSignalInitializer, CommandKitSignalUpdater, CommandObject, CommandOptions, CommandProps, CommandType, ContextMenuCommandProps, ReloadType, SlashCommandProps, ValidationFunctionProps, createEffect, createSignal };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { CommandInteraction, Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, PermissionResolvable, APIApplicationCommandOption } from 'discord.js';
+import { CommandInteraction, Client, ChatInputCommandInteraction, ContextMenuCommandInteraction, PermissionResolvable, APIApplicationCommandOption, ButtonInteraction, Awaitable, Message, InteractionCollectorOptions, ButtonBuilder } from 'discord.js';
 
 interface CommandProps {
     interaction: CommandInteraction;
@@ -150,4 +150,55 @@ declare class CommandKit {
     get devRoleIds(): string[];
 }
 
-export { CommandData, CommandKit, CommandObject, CommandOptions, CommandProps, CommandType, ContextMenuCommandProps, ReloadType, SlashCommandProps, ValidationFunctionProps };
+type CommandKitButtonBuilderInteractionCollectorDispatch = (interaction: ButtonInteraction) => Awaitable<void>;
+type CommandKitButtonBuilderInteractionCollectorDispatchContextData = {
+    /**
+     * The message to listen for button interactions on.
+     */
+    message: Message;
+    /**
+     * If the collector should automatically reset the timer when a button is clicked.
+     */
+    autoReset?: boolean;
+} & Omit<InteractionCollectorOptions<ButtonInteraction>, 'filter' | 'componentType'>;
+declare class ButtonKit extends ButtonBuilder {
+    #private;
+    /**
+     * Sets up an inline interaction collector for this button. This collector by default allows as many interactions as possible if it is actively used.
+     * If unused, this expires after 24 hours or custom time if specified.
+     * @param handler The handler to run when the button is clicked
+     * @param data The context data to use for the interaction collector
+     * @returns This button
+     * @example
+     * ```ts
+     * const button = new ButtonKit()
+     *   .setLabel('Click me')
+     *   .setStyle(ButtonStyle.Primary)
+     *   .setCustomId('click_me');
+     *
+     * const message = await channel.send({ content: 'Click the button', components: [new MessageActionRow().addComponents(button)] });
+     *
+     * button.onClick(async (interaction) => {
+     *   await interaction.reply('You clicked me!');
+     * }, { message });
+     *
+     * // remove onClick handler and destroy the interaction collector
+     * button.onClick(null);
+     * ```
+     */
+    onClick(handler: null): this;
+    onClick(handler: CommandKitButtonBuilderInteractionCollectorDispatch, data: CommandKitButtonBuilderInteractionCollectorDispatchContextData): this;
+}
+
+type CommandKitEffectCallback = () => void;
+type CommandKitSignalInitializer<T> = T | (() => T);
+type CommandKitSignalUpdater<T> = T | ((prev: T) => T);
+type CommandKitSignal<T> = readonly [
+    () => T,
+    (value: CommandKitSignalUpdater<T>) => void,
+    () => void
+];
+declare function createSignal<T = unknown>(value?: CommandKitSignalInitializer<T>): CommandKitSignal<T>;
+declare function createEffect(callback: CommandKitEffectCallback): void;
+
+export { ButtonKit, CommandData, CommandKit, CommandKitButtonBuilderInteractionCollectorDispatch, CommandKitButtonBuilderInteractionCollectorDispatchContextData, CommandKitEffectCallback, CommandKitSignal, CommandKitSignalInitializer, CommandKitSignalUpdater, CommandObject, CommandOptions, CommandProps, CommandType, ContextMenuCommandProps, ReloadType, SlashCommandProps, ValidationFunctionProps, createEffect, createSignal };

package/dist/index.js

@@ -30,9 +30,12 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  ButtonKit: () => ButtonKit,
   CommandKit: () => CommandKit,
   CommandType: () => CommandType,
-  ReloadType: () => ReloadType
+  ReloadType: () => ReloadType,
+  createEffect: () => createEffect,
+  createSignal: () => createSignal
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -900,6 +903,113 @@ var CommandKit = class {
   }
 };
 
+// src/components/Button.ts
+var import_discord = require("discord.js");
+var ButtonKit = class extends import_discord.ButtonBuilder {
+  #onClickHandler = null;
+  #contextData = null;
+  #collector = null;
+  onClick(handler, data) {
+    if (this.data.style === import_discord.ButtonStyle.Link) {
+      throw new TypeError('Cannot setup "onClick" handler for link buttons');
+    }
+    this.#destroyCollector();
+    this.#onClickHandler = handler;
+    if (handler && data)
+      this.#contextData = data;
+    this.#setupInteractionCollector();
+    return this;
+  }
+  #setupInteractionCollector() {
+    if (!this.#contextData || !this.#onClickHandler)
+      return;
+    const message = this.#contextData?.message;
+    if (!message) {
+      throw new TypeError(
+        'Cannot setup "onClick" handler without a message in the context data'
+      );
+    }
+    if ("customId" in this.data && !this.data.customId) {
+      throw new TypeError('Cannot setup "onClick" handler without a custom id');
+    }
+    const data = {
+      time: 864e5,
+      autoReset: true,
+      ...this.#contextData
+    };
+    const collector = this.#collector = message.createMessageComponentCollector({
+      filter: (interaction) => interaction.customId === this.data.custom_id && interaction.message.id === message.id,
+      componentType: import_discord.ComponentType.Button,
+      ...data
+    });
+    this.#collector.on("collect", (interaction) => {
+      const handler = this.#onClickHandler;
+      if (!handler)
+        return this.#destroyCollector();
+      if (!this.#collector) {
+        return collector.stop("destroyed");
+      }
+      if (data.autoReset) {
+        this.#collector?.resetTimer();
+      }
+      return handler(interaction);
+    });
+    this.#collector.on("end", () => {
+      this.#destroyCollector();
+    });
+  }
+  #destroyCollector() {
+    this.#collector?.stop("end");
+    this.#collector?.removeAllListeners();
+    this.#collector = null;
+    this.#contextData = null;
+    this.#onClickHandler = null;
+  }
+};
+
+// src/utils/signal.ts
+var context = [];
+function createSignal(value) {
+  const subscribers = /* @__PURE__ */ new Set();
+  let disposed = false;
+  let val = value instanceof Function ? value() : value;
+  const getter = () => {
+    if (!disposed) {
+      const running = getCurrentObserver();
+      if (running)
+        subscribers.add(running);
+    }
+    return val;
+  };
+  const setter = (newValue) => {
+    if (disposed)
+      return;
+    val = newValue instanceof Function ? newValue(val) : newValue;
+    for (const subscriber of subscribers) {
+      subscriber();
+    }
+  };
+  const dispose = () => {
+    subscribers.clear();
+    disposed = true;
+  };
+  return [getter, setter, dispose];
+}
+function createEffect(callback) {
+  const execute = () => {
+    context.push(execute);
+    try {
+      callback();
+    } finally {
+      context.pop();
+    }
+  };
+  execute();
+}
+function getCurrentObserver() {
+  return context[context.length - 1];
+}
+
 // src/types/index.ts
 var CommandType = /* @__PURE__ */ ((CommandType2) => {
   CommandType2[CommandType2["ChatInput"] = 1] = "ChatInput";
@@ -914,7 +1024,10 @@ var ReloadType = /* @__PURE__ */ ((ReloadType2) => {
 })(ReloadType || {});
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ButtonKit,
   CommandKit,
   CommandType,
-  ReloadType
+  ReloadType,
+  createEffect,
+  createSignal
 });

package/dist/index.mjs

@@ -870,6 +870,113 @@ var CommandKit = class {
   }
 };
 
+// src/components/Button.ts
+import { ButtonBuilder, ButtonStyle, ComponentType } from "discord.js";
+var ButtonKit = class extends ButtonBuilder {
+  #onClickHandler = null;
+  #contextData = null;
+  #collector = null;
+  onClick(handler, data) {
+    if (this.data.style === ButtonStyle.Link) {
+      throw new TypeError('Cannot setup "onClick" handler for link buttons');
+    }
+    this.#destroyCollector();
+    this.#onClickHandler = handler;
+    if (handler && data)
+      this.#contextData = data;
+    this.#setupInteractionCollector();
+    return this;
+  }
+  #setupInteractionCollector() {
+    if (!this.#contextData || !this.#onClickHandler)
+      return;
+    const message = this.#contextData?.message;
+    if (!message) {
+      throw new TypeError(
+        'Cannot setup "onClick" handler without a message in the context data'
+      );
+    }
+    if ("customId" in this.data && !this.data.customId) {
+      throw new TypeError('Cannot setup "onClick" handler without a custom id');
+    }
+    const data = {
+      time: 864e5,
+      autoReset: true,
+      ...this.#contextData
+    };
+    const collector = this.#collector = message.createMessageComponentCollector({
+      filter: (interaction) => interaction.customId === this.data.custom_id && interaction.message.id === message.id,
+      componentType: ComponentType.Button,
+      ...data
+    });
+    this.#collector.on("collect", (interaction) => {
+      const handler = this.#onClickHandler;
+      if (!handler)
+        return this.#destroyCollector();
+      if (!this.#collector) {
+        return collector.stop("destroyed");
+      }
+      if (data.autoReset) {
+        this.#collector?.resetTimer();
+      }
+      return handler(interaction);
+    });
+    this.#collector.on("end", () => {
+      this.#destroyCollector();
+    });
+  }
+  #destroyCollector() {
+    this.#collector?.stop("end");
+    this.#collector?.removeAllListeners();
+    this.#collector = null;
+    this.#contextData = null;
+    this.#onClickHandler = null;
+  }
+};
+
+// src/utils/signal.ts
+var context = [];
+function createSignal(value) {
+  const subscribers = /* @__PURE__ */ new Set();
+  let disposed = false;
+  let val = value instanceof Function ? value() : value;
+  const getter = () => {
+    if (!disposed) {
+      const running = getCurrentObserver();
+      if (running)
+        subscribers.add(running);
+    }
+    return val;
+  };
+  const setter = (newValue) => {
+    if (disposed)
+      return;
+    val = newValue instanceof Function ? newValue(val) : newValue;
+    for (const subscriber of subscribers) {
+      subscriber();
+    }
+  };
+  const dispose = () => {
+    subscribers.clear();
+    disposed = true;
+  };
+  return [getter, setter, dispose];
+}
+function createEffect(callback) {
+  const execute = () => {
+    context.push(execute);
+    try {
+      callback();
+    } finally {
+      context.pop();
+    }
+  };
+  execute();
+}
+function getCurrentObserver() {
+  return context[context.length - 1];
+}
+
 // src/types/index.ts
 var CommandType = /* @__PURE__ */ ((CommandType2) => {
   CommandType2[CommandType2["ChatInput"] = 1] = "ChatInput";
@@ -883,7 +990,10 @@ var ReloadType = /* @__PURE__ */ ((ReloadType2) => {
   return ReloadType2;
 })(ReloadType || {});
 export {
+  ButtonKit,
   CommandKit,
   CommandType,
-  ReloadType
+  ReloadType,
+  createEffect,
+  createSignal
 };

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "commandkit",
   "description": "Beginner friendly command & event handler for Discord.js",
-  "version": "0.1.6-dev.20231006183935",
+  "version": "0.1.6-dev.20231112142249",
   "license": "MIT",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
+  "bin": "./bin/index.mjs",
   "exports": {
     ".": {
       "require": "./dist/index.js",
@@ -13,6 +14,10 @@
       "types": "./dist/index.d.ts"
     }
   },
+  "files": [
+    "dist",
+    "bin"
+  ],
   "scripts": {
     "lint": "tsc",
     "dev": "tsup --watch",
@@ -32,14 +37,17 @@
     "event handler"
   ],
   "dependencies": {
-    "rfdc": "^1.3.0"
+    "commander": "^11.1.0",
+    "ora": "^7.0.1",
+    "rfdc": "^1.3.0",
+    "rimraf": "^5.0.5",
+    "tsup": "^7.2.0"
   },
   "devDependencies": {
     "@types/node": "^20.5.9",
     "discord.js": "^14.13.0",
     "dotenv": "^16.3.1",
     "tsconfig": "workspace:*",
-    "tsup": "^7.2.0",
     "tsx": "^3.12.8",
     "typescript": "^5.1.6"
   },