Merge pull request #4 from elizaos-plugins/odi-dm

/start support, expose sourceId, target => ChannelType & typescript fixes

Author: wtfsayo

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elizaos/plugin-telegram",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -31,7 +31,7 @@
     "vitest": "1.6.1"
   },
   "scripts": {
-    "build": "tsup",
+    "build": "tsup && tsc",
     "dev": "tsup --watch",
     "test": "vitest run",
     "test:watch": "vitest",

src/messageManager.ts

@@ -330,6 +330,8 @@ export class MessageManager {
       const chat = message.chat as Chat;
       const channelType = getChannelType(chat);
 
+      const sourceId = createUniqueUuid(this.runtime, '' + chat.id);
+
       await this.runtime.ensureConnection({
         entityId,
         roomId,
@@ -352,10 +354,11 @@ export class MessageManager {
         content: {
           text: fullText,
           // attachments?
-          source: 'telegram',
+          source: "telegram",
+          // url?
           channelType: channelType,
           inReplyTo:
-            'reply_to_message' in message && message.reply_to_message
+            "reply_to_message" in message && message.reply_to_message
               ? createUniqueUuid(this.runtime, message.reply_to_message.message_id.toString())
               : undefined,
         },
@@ -366,9 +369,11 @@ export class MessageManager {
           // include very technical/exact reference to this user for security reasons
           // don't remove or change this, spartan needs this
           fromId: chat.id,
+          sourceId,
           // why message? all Memories contain content (which is basically a message)
-          // what are the other types?
-          type: 'message',
+          // what are the other types? see MemoryType
+          type: "message", // MemoryType.MESSAGE
+          // scope: `shared`, `private`, or `room`
         },
         createdAt: message.date * 1000,
       };
@@ -380,7 +385,8 @@ export class MessageManager {
           if (!content.text) return [];
 
           let sentMessages: boolean | Message.TextMessage[] = false
-          if (content?.target === 'DM') {
+          // channelType target === 'telegram'
+          if (content?.channelType === 'DM') {
             sentMessages = []
             if (ctx.from) {
               // FIXME split on 4096 chars
@@ -396,7 +402,7 @@ export class MessageManager {
           const memories: Memory[] = [];
           for (let i = 0; i < sentMessages.length; i++) {
             const sentMessage = sentMessages[i];
-            const _isLastMessage = i === sentMessages.length - 1;
+            
 
             const responseMemory: Memory = {
               id: createUniqueUuid(this.runtime, sentMessage.message_id.toString()),

src/service.ts

@@ -3,16 +3,13 @@ import {
   type Content,
   type Entity,
   EventType,
-  type HandlerCallback,
   type IAgentRuntime,
-  type Memory,
   Role,
   type Room,
   Service,
   type TargetInfo,
   type UUID,
   type World,
-  WorldPayload,
   createUniqueUuid,
   logger,
 } from '@elizaos/core';
@@ -21,7 +18,7 @@ import { type ChatMemberOwner, type ChatMemberAdministrator, type User } from 't
 import { TELEGRAM_SERVICE_NAME } from './constants';
 import { validateTelegramConfig } from './environment';
 import { MessageManager } from './messageManager';
-import { TelegramEventTypes, TelegramWorldPayload } from './types';
+import { TelegramEventTypes, type TelegramWorldPayload } from './types';
 
 /**
  * Class representing a Telegram service that allows the agent to send and receive messages on Telegram.
@@ -144,6 +141,12 @@ export class TelegramService extends Service {
    * @returns {Promise<void>} A Promise that resolves when the initialization is complete.
    */
   private async initializeBot(): Promise<void> {
+    this.bot.start(ctx => {
+      this.runtime.emitEvent([TelegramEventTypes.SLASH_START], {
+        // we don't need this
+        ctx,
+      });
+    });
     this.bot.launch({
       dropPendingUpdates: true,
       allowedUpdates: ['message', 'message_reaction'],

src/tests.ts

@@ -4,6 +4,8 @@ import type { Telegraf } from 'telegraf';
 import type { Context } from 'telegraf';
 import type { MessageManager } from './messageManager';
 import type { TelegramService } from './service';
+import type { TelegramContent } from './types';
+
 
 const TEST_IMAGE_URL =
   'https://github.com/elizaOS/awesome-eliza/blob/main/assets/eliza-logo.jpg?raw=true';
@@ -143,7 +145,7 @@ export class TelegramTestSuite implements TestSuite {
         ],
       };
 
-      await this.messageManager.sendMessageInChunks(mockContext as Context, messageContent);
+      await this.messageManager.sendMessageInChunks(mockContext as Context, messageContent as TelegramContent);
 
       logger.success('Message with image attachment sent successfully.');
     } catch (error) {

src/types.ts

@@ -31,6 +31,19 @@ export enum TelegramEventTypes {
   WORLD_CONNECTED = 'TELEGRAM_WORLD_CONNECTED',
   WORLD_LEFT = 'TELEGRAM_WORLD_LEFT',
 
+export interface TelegramEventPayloadMap {
+  [TelegramEventTypes.MESSAGE_RECEIVED]: TelegramMessageReceivedPayload;
+  [TelegramEventTypes.MESSAGE_SENT]: TelegramMessageSentPayload;
+  [TelegramEventTypes.REACTION_RECEIVED]: TelegramReactionReceivedPayload;
+  [TelegramEventTypes.WORLD_JOINED]: TelegramWorldPayload;
+  [TelegramEventTypes.WORLD_CONNECTED]: TelegramWorldPayload;
+  [TelegramEventTypes.WORLD_LEFT]: TelegramWorldPayload;
+  [TelegramEventTypes.SLASH_START]: { ctx: Context };
+  [TelegramEventTypes.ENTITY_JOINED]: TelegramEntityPayload;
+  [TelegramEventTypes.ENTITY_LEFT]: TelegramEntityPayload;
+  [TelegramEventTypes.ENTITY_UPDATED]: TelegramEntityPayload;
+  [TelegramEventTypes.INTERACTION_RECEIVED]: TelegramReactionReceivedPayload;
+}
   // Entity events
   ENTITY_JOINED = 'TELEGRAM_ENTITY_JOINED',
   ENTITY_LEFT = 'TELEGRAM_ENTITY_LEFT',

src/utils.ts

@@ -74,14 +74,14 @@ export function convertMarkdownToTelegram(markdown: string): string {
 
   // 1. Fenced code blocks (```...```)
   //    Matches an optional language (letters only) and then any content until the closing ```
-  converted = converted.replace(/```(\w+)?\n([\s\S]*?)```/g, (match, lang, code) => {
+  converted = converted.replace(/```(\w+)?\n([\s\S]*?)```/g, (_match, lang, code) => {
     const escapedCode = escapeCode(code);
     const formatted = '```' + (lang || '') + '\n' + escapedCode + '```';
     return storeReplacement(formatted);
   });
 
   // 2. Inline code (`...`)
-  converted = converted.replace(/`([^`]+)`/g, (match, code) => {
+  converted = converted.replace(/`([^`]+)`/g, (_match, code) => {
     const escapedCode = escapeCode(code);
     const formatted = '`' + escapedCode + '`';
     return storeReplacement(formatted);
@@ -90,7 +90,7 @@ export function convertMarkdownToTelegram(markdown: string): string {
   // 3. Links: [link text](url)
   converted = converted.replace(
     /$begin:math:display$([^$end:math:display$]+)]$begin:math:text$([^)]+)$end:math:text$/g,
-    (match, text, url) => {
+    (_match, text, url) => {
       // For link text we escape as plain text.
       const formattedText = escapePlainText(text);
       const escapedURL = escapeUrl(url);
@@ -101,15 +101,15 @@ export function convertMarkdownToTelegram(markdown: string): string {
 
   // 4. Bold text: standard markdown bold **text**
   //    Telegram bold is delimited by single asterisks: *text*
-  converted = converted.replace(/\*\*([^*]+)\*\*/g, (match, content) => {
+  converted = converted.replace(/\*\*([^*]+)\*\*/g, (_match, content) => {
     const formattedContent = escapePlainText(content);
     const formatted = `*${formattedContent}*`;
     return storeReplacement(formatted);
   });
 
   // 5. Strikethrough: standard markdown uses ~~text~~,
   //    while Telegram uses ~text~
-  converted = converted.replace(/~~([^~]+)~~/g, (match, content) => {
+  converted = converted.replace(/~~([^~]+)~~/g, (_match, content) => {
     const formattedContent = escapePlainText(content);
     const formatted = `~${formattedContent}~`;
     return storeReplacement(formatted);
@@ -120,13 +120,13 @@ export function convertMarkdownToTelegram(markdown: string): string {
   //    In Telegram MarkdownV2 italic must be delimited by underscores.
   //    Process asterisk-based italic first.
   //    (Using negative lookbehind/lookahead to avoid matching bold **)
-  converted = converted.replace(/(?<!\*)\*([^*\n]+)\*(?!\*)/g, (match, content) => {
+  converted = converted.replace(/(?<!\*)\*([^*\n]+)\*(?!\*)/g, (_match, content) => {
     const formattedContent = escapePlainText(content);
     const formatted = `_${formattedContent}_`;
     return storeReplacement(formatted);
   });
   //    Then underscore-based italic.
-  converted = converted.replace(/_([^_\n]+)_/g, (match, content) => {
+  converted = converted.replace(/_([^_\n]+)_/g, (_match, content) => {
     const formattedContent = escapePlainText(content);
     const formatted = `_${formattedContent}_`;
     return storeReplacement(formatted);
@@ -135,7 +135,7 @@ export function convertMarkdownToTelegram(markdown: string): string {
   // 7. Headers: Convert markdown headers (lines starting with '#' characters)
   //    to bold text. This avoids unescaped '#' characters (which crash Telegram)
   //    by removing them and wrapping the rest of the line in bold markers.
-  converted = converted.replace(/^(#{1,6})\s*(.*)$/gm, (match, hashes, headerContent: string) => {
+  converted = converted.replace(/^(#{1,6})\s*(.*)$/gm, (_match, _hashes, headerContent: string) => {
     // Remove any trailing whitespace and escape the header text.
     const formatted = `*${escapePlainText(headerContent.trim())}*`;
     return storeReplacement(formatted);

tsconfig.json

@@ -8,7 +8,7 @@
     "moduleResolution": "Bundler",
     "strict": true,
     "esModuleInterop": true,
-    "skipLibCheck": true,
+    "skipLibCheck": false,
     "forceConsistentCasingInFileNames": false,
     "allowImportingTsExtensions": true,
     "declaration": true,
@@ -20,7 +20,14 @@
     "noEmitOnError": false,
     "moduleDetection": "force",
     "allowArbitraryExtensions": true,
-    "baseUrl": "."
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "baseUrl": ".",
+    "typeRoots": ["./types", "./node_modules/@types"],
+    "paths": {
+      "@elizaos/core": ["../../core/src"],
+      "@elizaos/core/*": ["../../core/src/*"]
+    }
   },
   "include": ["src/**/*.ts"]
 }