Merge pull request #371 from underctrl-io/tasks-plugin

feat: tasks plugin

Author: twlite

.github/workflows/publish-dev.yaml

@@ -61,6 +61,7 @@ jobs:
             "@commandkit/analytics:packages/analytics"
             "@commandkit/ai:packages/ai"
             "@commandkit/queue:packages/queue"
+            "@commandkit/tasks:packages/tasks"
           )
 
           for entry in "${PACKAGES[@]}"; do
@@ -84,6 +85,7 @@ jobs:
             "@commandkit/analytics"
             "@commandkit/ai"
             "@commandkit/queue"
+            "@commandkit/tasks"
           )
 
           for pkg in "${PACKAGES[@]}"; do

.github/workflows/publish-latest.yaml

@@ -40,6 +40,7 @@ jobs:
             "@commandkit/devtools:packages/devtools"
             "@commandkit/cache:packages/cache"
             "@commandkit/queue:packages/queue"
+            "@commandkit/tasks:packages/tasks"
           )
 
           for entry in "${PACKAGES[@]}"; do

apps/test-bot/.gitignore

@@ -1,4 +1,4 @@
 .env
 .commandkit
 compiled-commandkit.config.mjs
-commandkit*.db*
+*.db*

apps/test-bot/commandkit.config.ts

@@ -4,6 +4,7 @@ import { i18n } from '@commandkit/i18n';
 import { devtools } from '@commandkit/devtools';
 import { cache } from '@commandkit/cache';
 import { ai } from '@commandkit/ai';
+import { tasks } from '@commandkit/tasks';
 
 export default defineConfig({
   plugins: [
@@ -12,5 +13,6 @@ export default defineConfig({
     devtools(),
     cache(),
     ai(),
+    tasks(),
   ],
 });

apps/test-bot/package.json

@@ -16,12 +16,15 @@
     "@commandkit/devtools": "workspace:*",
     "@commandkit/i18n": "workspace:*",
     "@commandkit/legacy": "workspace:*",
+    "@commandkit/tasks": "workspace:*",
     "commandkit": "workspace:*",
     "discord.js": "catalog:discordjs",
     "dotenv": "^16.4.7",
+    "ms": "^2.1.3",
     "zod": "^3.25.56"
   },
   "devDependencies": {
+    "@types/ms": "^2.1.0",
     "tsx": "^4.7.0"
   }
 }

apps/test-bot/src/app.ts

@@ -1,5 +1,7 @@
 import { Client } from 'discord.js';
 import { Logger, commandkit } from 'commandkit';
+import { setDriver } from '@commandkit/tasks';
+import { HyperCronDriver } from '@commandkit/tasks/hypercron';
 import './ai.ts';
 
 const client = new Client({
@@ -12,6 +14,8 @@ const client = new Client({
   ],
 });
 
+setDriver(new HyperCronDriver());
+
 Logger.log('Application bootstrapped successfully!');
 
 commandkit.setPrefixResolver((message) => {

apps/test-bot/src/app/commands/remind.ts

@@ -0,0 +1,72 @@
+import type { CommandData, ChatInputCommand, MessageCommand } from 'commandkit';
+import { ApplicationCommandOptionType } from 'discord.js';
+import ms from 'ms';
+import { createTask } from '@commandkit/tasks';
+import { RemindTaskData } from '../tasks/remind';
+
+export const command: CommandData = {
+  name: 'remind',
+  description: 'remind command',
+  options: [
+    {
+      name: 'time',
+      description: 'The time to remind after. Eg: 6h, 10m, 1d',
+      type: ApplicationCommandOptionType.String,
+      required: true,
+    },
+    {
+      name: 'message',
+      description: 'The message to remind about.',
+      type: ApplicationCommandOptionType.String,
+      required: true,
+    },
+  ],
+};
+
+export const chatInput: ChatInputCommand = async (ctx) => {
+  const time = ctx.options.getString('time', true);
+  const message = ctx.options.getString('message', true);
+  const timeMs = Date.now() + ms(time as `${number}`);
+
+  await createTask({
+    name: 'remind',
+    data: {
+      userId: ctx.interaction.user.id,
+      message,
+      channelId: ctx.interaction.channelId,
+      setAt: Date.now(),
+    } satisfies RemindTaskData,
+    schedule: {
+      type: 'date',
+      value: timeMs,
+    },
+  });
+
+  await ctx.interaction.reply(
+    `I will remind you <t:${Math.floor(timeMs / 1000)}:R> for \`${message}\``,
+  );
+};
+
+export const message: MessageCommand = async (ctx) => {
+  const [time, ...messageParts] = ctx.args();
+  const message = messageParts.join(' ');
+  const timeMs = Date.now() + ms(time as `${number}`);
+
+  await createTask({
+    name: 'remind',
+    data: {
+      userId: ctx.message.author.id,
+      message,
+      channelId: ctx.message.channelId,
+      setAt: Date.now(),
+    } satisfies RemindTaskData,
+    schedule: {
+      type: 'date',
+      value: timeMs,
+    },
+  });
+
+  await ctx.message.reply(
+    `I will remind you <t:${Math.floor(timeMs / 1000)}:R> for \`${message}\``,
+  );
+};

apps/test-bot/src/app/tasks/remind.ts

@@ -0,0 +1,31 @@
+import { task } from '@commandkit/tasks';
+
+export interface RemindTaskData {
+  userId: string;
+  message: string;
+  channelId: string;
+  setAt: number;
+}
+
+export default task<RemindTaskData>({
+  name: 'remind',
+  async execute(ctx) {
+    const { userId, message, channelId, setAt } = ctx.data;
+
+    const channel = await ctx.client.channels.fetch(channelId);
+
+    if (!channel?.isTextBased() || !channel.isSendable()) return;
+
+    await channel.send({
+      content: `<@${userId}>`,
+      embeds: [
+        {
+          title: `You asked me <t:${Math.floor(setAt / 1000)}:R> to remind you about:`,
+          description: message,
+          color: 0x0099ff,
+          timestamp: new Date(setAt).toISOString(),
+        },
+      ],
+    });
+  },
+});

apps/website/docs/api-reference/ai/functions/configure-ai.mdx

@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## configureAI
 
-<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="183" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="197" packageName="@commandkit/ai" />
 
 Configures the AI plugin with the provided options.
 This function allows you to set a message filter, select an AI model, and generate a system prompt.

apps/website/docs/api-reference/ai/functions/get-aiconfig.mdx

@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## getAIConfig
 
-<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="174" packageName="@commandkit/ai" />
+<GenerationInfo sourceFile="packages/ai/src/configure.ts" sourceLine="188" packageName="@commandkit/ai" />
 
 Retrieves the current AI configuration.