update send method to work with multimodality

.changeset/dirty-meals-confess.md

@@ -0,0 +1,5 @@
+---
+"ccat-api": minor
+---
+
+update send method to work with multimodality

api/client.ts

@@ -4,6 +4,7 @@ import {
     SocketResponse, SocketError, 
     WebSocketState, WebSocketSettings,
     isMessageResponse, CatSettings,
+    SocketRequest,
 } from './utils'
 
 /**
@@ -114,29 +115,26 @@ export class CatClient {
 
     /**
      * Sends a message to the Cat through the WebSocket connection.
-     * @param message The message to send to the Cat.
-     * @param data The custom data to send to the Cat.
+     * @param msg The message to send to the Cat.
      * @param userId The ID of the user sending the message. Defaults to "user".
+     * @throws If the message does not contain text, audio or image.
      * @returns The `CatClient` instance.
      */
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    send(message: string, data?: Record<string, any>, userId?: string): CatClient {
+    send(msg: SocketRequest, userId?: string): CatClient {
         if (this.ws?.readyState !== WebSocket.OPEN) {
             this.errorHandler?.({
                 name: 'SocketClosed',
                 description: 'The connection to the server was closed'
             })
             return this
         }
-        if (data && ('text' in data || 'user_id' in data)) {
-            throw new Error('The data object should not have a "text" or a "user_id" property')
-        }
-        const jsonMessage = JSON.stringify({ 
-            text: message,
-            user_id: userId ?? (this.config.userId ?? 'user'),
-            ...data
-        })
-        this.ws.send(jsonMessage)
+        if ('text' in msg || 'audio' in msg || 'image' in msg) {
+            const jsonMessage = JSON.stringify({ 
+                ...msg,
+                user_id: userId ?? (this.config.userId ?? 'user'),
+            })
+            this.ws.send(jsonMessage)
+        } else throw new Error('The message argument must contain either text, audio or image.')
         return this
     }
 

api/models/Plugin.ts

@@ -12,6 +12,8 @@ export type Plugin = {
     tags: string;
     thumb: string;
     version: string;
+    min_cat_version?: string;
+    max_cat_version?: string;
     active?: boolean;
     url?: string;
     upgrade?: string;
@@ -22,7 +24,5 @@ export type Plugin = {
     tools?: Array<{
         name: string;
     }>;
-    min_cat_version: string;
-    max_cat_version: string;
 };
 

api/utils.ts

@@ -74,11 +74,18 @@ export enum WebSocketState {
     CONNECTING, OPEN, CLOSING, CLOSED
 }
 
-export interface SocketResponse {
+export interface SocketRequest {
+    text?: string
+    audio?: string
+    image?: string
+    [key: string]: any
+}
+
+export interface SocketResponse extends SocketRequest {
     type: 'notification' | 'chat' | 'chat_token'
-    content: string
+    user_id: string
+    who: string
     why?: MessageWhy & Record<string, any>
-    [key: string]: any
 }
 
 export interface SocketError {
@@ -88,7 +95,9 @@ export interface SocketError {
 
 export const isMessageResponse = (value: unknown): value is SocketResponse => {
     return !!(value && typeof value === 'object' 
-        && 'content' in value
+        && ('text' in value || 'audio' in value || 'image' in value)
+        && 'user_id' in value
+        && 'who' in value
         && 'type' in value
         && value.type !== 'error'
     )

catapi.json

@@ -2391,6 +2391,14 @@
                         "title": "Version",
                         "type": "string"
                     },
+                    "min_cat_version": {
+                        "title": "Min Cat Version",
+                        "type": "string"
+                    },
+                    "max_cat_version": {
+                        "title": "Max Cat Version",
+                        "type": "string"
+                    },
                     "active": {
                         "title": "Active",
                         "type": "boolean"