feat: improve type saftey

packages/plugin-node/src/services/browser.ts

@@ -1,4 +1,4 @@
-import { generateText, trimTokens } from "@ai16z/eliza";
+import { generateText, IBrowserService, trimTokens } from "@ai16z/eliza";
 import { parseJSONObjectFromText } from "@ai16z/eliza";
 import { Service } from "@ai16z/eliza";
 import { settings } from "@ai16z/eliza";
@@ -56,7 +56,7 @@ type PageContent = {
     bodyContent: string;
 };
 
-export class BrowserService extends Service {
+export class BrowserService extends Service implements IBrowserService {
     private browser: Browser | undefined;
     private context: BrowserContext | undefined;
     private blocker: PlaywrightBlocker | undefined;
@@ -73,6 +73,10 @@ export class BrowserService extends Service {
         return runtime;
     }
 
+    getInstance(): IBrowserService {
+        return BrowserService.getInstance();
+    }
+
     constructor() {
         super();
         this.browser = undefined;

packages/plugin-node/src/services/image.ts

@@ -1,6 +1,11 @@
 import { elizaLogger, models } from "@ai16z/eliza";
 import { Service } from "@ai16z/eliza";
-import { IAgentRuntime, ModelProviderName, ServiceType } from "@ai16z/eliza";
+import {
+    IAgentRuntime,
+    ModelProviderName,
+    ServiceType,
+    IImageDescriptionService,
+} from "@ai16z/eliza";
 import {
     AutoProcessor,
     AutoTokenizer,
@@ -17,7 +22,10 @@ import gifFrames from "gif-frames";
 import os from "os";
 import path from "path";
 
-export class ImageDescriptionService extends Service {
+export class ImageDescriptionService
+    extends Service
+    implements IImageDescriptionService
+{
     static serviceType: ServiceType = ServiceType.IMAGE_DESCRIPTION;
 
     private modelId: string = "onnx-community/Florence-2-base-ft";
@@ -30,6 +38,10 @@ export class ImageDescriptionService extends Service {
     private queue: string[] = [];
     private processing: boolean = false;
 
+    getInstance(): IImageDescriptionService {
+        return ImageDescriptionService.getInstance();
+    }
+
     async initialize(runtime: IAgentRuntime): Promise<void> {
         this.runtime = runtime;
         const model = models[runtime?.character?.modelProvider];

packages/plugin-node/src/services/pdf.ts

@@ -1,14 +1,18 @@
-import { IAgentRuntime, Service, ServiceType } from "@ai16z/eliza";
+import { IAgentRuntime, IPdfService, Service, ServiceType } from "@ai16z/eliza";
 import { getDocument, PDFDocumentProxy } from "pdfjs-dist";
 import { TextItem, TextMarkedContent } from "pdfjs-dist/types/src/display/api";
 
-export class PdfService extends Service {
+export class PdfService extends Service implements IPdfService {
     static serviceType: ServiceType = ServiceType.PDF;
 
     constructor() {
         super();
     }
 
+    getInstance(): IPdfService {
+        return PdfService.getInstance();
+    }
+
     async initialize(runtime: IAgentRuntime): Promise<void> {}
 
     async convertPdfToText(pdfBuffer: Buffer): Promise<string> {

packages/plugin-node/src/services/speech.ts

@@ -1,5 +1,10 @@
 import { PassThrough, Readable } from "stream";
-import { IAgentRuntime, ISpeechService, ServiceType } from "@ai16z/eliza";
+import {
+    IAgentRuntime,
+    ISpeechService,
+    ITranscriptionService,
+    ServiceType,
+} from "@ai16z/eliza";
 import { getWavHeader } from "./audioUtils.ts";
 import { synthesize } from "../vendor/vits.ts";
 import { Service } from "@ai16z/eliza";
@@ -109,11 +114,15 @@ async function textToSpeech(runtime: IAgentRuntime, text: string) {
     }
 }
 
-export class SpeechService extends Service {
+export class SpeechService extends Service implements ISpeechService {
     static serviceType: ServiceType = ServiceType.SPEECH_GENERATION;
 
     async initialize(runtime: IAgentRuntime): Promise<void> {}
 
+    getInstance(): ISpeechService {
+        return SpeechService.getInstance();
+    }
+
     async generate(runtime: IAgentRuntime, text: string): Promise<Readable> {
         // check for elevenlabs API key
         if (runtime.getSetting("ELEVENLABS_XI_API_KEY")) {

packages/plugin-node/src/services/transcription.ts

@@ -1,4 +1,9 @@
-import { elizaLogger, IAgentRuntime, settings } from "@ai16z/eliza";
+import {
+    elizaLogger,
+    IAgentRuntime,
+    ITranscriptionService,
+    settings,
+} from "@ai16z/eliza";
 import { Service, ServiceType } from "@ai16z/eliza";
 import { exec } from "child_process";
 import { File } from "formdata-node";
@@ -16,7 +21,10 @@ const __dirname = path.dirname(__filename);
 
 const execAsync = promisify(exec);
 
-export class TranscriptionService extends Service {
+export class TranscriptionService
+    extends Service
+    implements ITranscriptionService
+{
     static serviceType: ServiceType = ServiceType.TRANSCRIPTION;
     private CONTENT_CACHE_DIR: string;
     private DEBUG_AUDIO_DIR: string;
@@ -29,6 +37,10 @@ export class TranscriptionService extends Service {
 
     async initialize(runtime: IAgentRuntime): Promise<void> {}
 
+    getInstance(): ITranscriptionService {
+        return TranscriptionService.getInstance();
+    }
+
     constructor() {
         super();
         const rootDir = path.resolve(__dirname, "../../");

packages/plugin-node/src/services/video.ts

@@ -4,6 +4,7 @@ import {
     ITranscriptionService,
     Media,
     ServiceType,
+    IVideoService,
 } from "@ai16z/eliza";
 import { stringToUuid } from "@ai16z/eliza";
 import ffmpeg from "fluent-ffmpeg";
@@ -12,7 +13,7 @@ import path from "path";
 import { tmpdir } from "os";
 import youtubeDl from "youtube-dl-exec";
 
-export class VideoService extends Service {
+export class VideoService extends Service implements IVideoService {
     static serviceType: ServiceType = ServiceType.VIDEO;
     private cacheKey = "content/video";
     private dataDir = "./content_cache";
@@ -25,6 +26,10 @@ export class VideoService extends Service {
         this.ensureDataDirectoryExists();
     }
 
+    getInstance(): IVideoService {
+        return VideoService.getInstance();
+    }
+
     async initialize(runtime: IAgentRuntime): Promise<void> {}
 
     private ensureDataDirectoryExists() {
@@ -88,7 +93,7 @@ export class VideoService extends Service {
 
     public async processVideo(
         url: string,
-        runtime: IAgentRuntime
+        runtime?: IAgentRuntime
     ): Promise<Media> {
         this.queue.push(url);
         this.processQueue(runtime);