chore: add discord example

.changeset/cuddly-mangos-train.md

@@ -0,0 +1,6 @@
+---
+'@callstack/byorg-discord': minor
+'discord-example': patch
+---
+
+added start function to abstract away passing bot token

examples/discord/package.json

@@ -15,13 +15,14 @@
   "dependencies": {
     "@ai-sdk/openai": "^1.0.2",
     "@callstack/byorg-core": "0.4.2",
-    "@callstack/byorg-discord": "0.4.2",
-    "@callstack/byorg-utils": "0.4.2"
+    "@callstack/byorg-discord": "workspace:^",
+    "@callstack/byorg-utils": "0.4.2",
+    "zlib-sync": "^0.1.9"
   },
   "devDependencies": {
-    "dotenv-cli": "^7.4.2",
     "@callstack/eslint-config": "^14.2.0",
     "@rsbuild/core": "^1.0.5",
+    "dotenv-cli": "^7.4.2",
     "eslint": "^8.57.0",
     "prettier": "^3.3.3",
     "typescript": "^5.6.3"

examples/discord/rsbuild.config.ts

@@ -28,6 +28,11 @@ export default defineConfig({
           '.js': ['.js', '.ts'],
         },
       },
+      ignoreWarnings: [
+        /the request of a dependency is an expression/,
+        /Can't resolve 'bufferutil'/,
+        /Can't resolve 'utf-8-validate'/,
+      ],
     },
   },
 });

examples/discord/src/index.ts

@@ -1,33 +1,33 @@
-// TODO
-// import readline from 'readline';
-// import { Message, VercelChatModelAdapter, createApp } from '@callstack/byorg-core';
-// import { createOpenAI } from '@ai-sdk/openai';
-// import { requireEnv } from '@callstack/byorg-utils';
-// import { createDiscordApp } from '@callstack/byorg-discord';
+import { VercelChatModelAdapter, createApp } from '@callstack/byorg-core';
+import { createOpenAI } from '@ai-sdk/openai';
+import { requireEnv } from '@callstack/byorg-utils';
+import { createDiscordApp } from '@callstack/byorg-discord';
 
-// const LANGUAGE_MODEL = 'gpt-4o-2024-11-20';
-// const API_KEY = requireEnv('OPENAI_API_KEY');
+const LANGUAGE_MODEL = 'gpt-4o-2024-11-20';
+const API_KEY = requireEnv('OPENAI_API_KEY');
+const DISCORD_BOT_TOKEN = requireEnv('DISCORD_BOT_TOKEN');
 
-// const openAiProvider = createOpenAI({
-//   apiKey: API_KEY,
-//   compatibility: 'strict', // strict mode, enable when using the OpenAI API
-// });
+const openAiProvider = createOpenAI({
+  apiKey: API_KEY,
+  compatibility: 'strict', // strict mode, enable when using the OpenAI API
+});
 
-// const openAiModel = openAiProvider.languageModel(LANGUAGE_MODEL);
+const openAiModel = openAiProvider.languageModel(LANGUAGE_MODEL);
 
-// const chatModel = new VercelChatModelAdapter({
-//   languageModel: openAiModel,
-// });
+const chatModel = new VercelChatModelAdapter({
+  languageModel: openAiModel,
+});
 
-// const systemPrompt = () => {
-//   return 'Your name is Cassandra. You are an AI Assistant.';
-// };
+const systemPrompt = () => {
+  return 'Your name is Cassandra. You are an AI Assistant.';
+};
 
-// const app = createApp({
-//   chatModel,
-//   systemPrompt,
-// });
+const app = createApp({
+  chatModel,
+  systemPrompt,
+});
 
-// // const discord = createDiscordApp({
-// //   app,
-// // });
+void createDiscordApp({
+  app,
+  botToken: DISCORD_BOT_TOKEN,
+});

packages/discord/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@callstack/byorg-discord",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "type": "module",
   "license": "MIT",
   "author": "Szymon Chmal <[email protected]> (https://github.com/V3R0N), Maciej Jastrzebski <[email protected]> (https://github.com/mdjastrzebski), Kewin Wereszczynski <[email protected]> (https://github.com/Q1w1N)",

packages/discord/src/index.ts

@@ -6,12 +6,18 @@ const UPDATE_THROTTLE_TIME = 200;
 
 export type DiscordApplicationConfig = {
   app: Application;
+  botToken: string;
 };
 
-export async function createDiscordApp(options: DiscordApplicationConfig) {
-  const { app } = options;
+type ClientStart = {
+  start: () => Promise<string>;
+};
+
+export type DiscordClient = Client & ClientStart;
+
+export function createDiscordApp(options: DiscordApplicationConfig): DiscordClient {
+  const { app, botToken } = options;
 
-  const botToken = process.env['DISCORD_BOT_TOKEN'] as string;
   const client = new Client({
     intents: [
       GatewayIntentBits.DirectMessages,
@@ -20,7 +26,7 @@ export async function createDiscordApp(options: DiscordApplicationConfig) {
       GatewayIntentBits.GuildMessages,
     ],
     partials: [Partials.Channel],
-  });
+  }) as DiscordClient;
 
   client.once(Events.ClientReady, (readyClient) => {
     console.log(`Ready! Logged in as ${readyClient.user.tag}`);
@@ -76,7 +82,9 @@ export async function createDiscordApp(options: DiscordApplicationConfig) {
     await pendingEffects;
   });
 
-  await client.login(botToken);
+  client.start = () => {
+    return client.login(botToken);
+  };
 
   return client;
 }