@elizaos/core 1.0.0-alpha.48 → 1.0.0-alpha.49

package/dist/types.d.ts

@@ -1,1294 +0,0 @@
-import type { Readable } from "node:stream";
-/**
- * Represents a UUID string in the format "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
- */
-/**
- * Type definition for a Universally Unique Identifier (UUID) using a specific format.
- * @typedef {`${string}-${string}-${string}-${string}-${string}`} UUID
- */
-export type UUID = `${string}-${string}-${string}-${string}-${string}`;
-/**
- * Represents the content of a message or communication
- */
-export interface Content {
-    thought?: string;
-    /** The agent's plan for the next message */
-    plan?: string;
-    /** The main text content */
-    text?: string;
-    /** Optional action associated with the message */
-    actions?: string[];
-    /** Optional providers associated with the message */
-    providers?: string[];
-    /** Optional source/origin of the content */
-    source?: string;
-    /** URL of the original message/post (e.g. tweet URL, Discord message link) */
-    url?: string;
-    /** UUID of parent message if this is a reply/thread */
-    inReplyTo?: UUID;
-    /** Array of media attachments */
-    attachments?: Media[];
-    /** Additional dynamic properties */
-    [key: string]: unknown;
-}
-/**
- * Example content with associated user for demonstration purposes
- */
-export interface ActionExample {
-    /** User associated with the example */
-    name: string;
-    /** Content of the example */
-    content: Content;
-}
-/**
- * Example conversation content with user ID
- */
-export interface ConversationExample {
-    /** UUID of user in conversation */
-    entityId: UUID;
-    /** Content of the conversation */
-    content: Content;
-}
-export type ModelType = (typeof ModelTypes)[keyof typeof ModelTypes] | string;
-/**
- * Model size/type classification
- */
-export declare const ModelTypes: {
-    readonly SMALL: "TEXT_SMALL";
-    readonly MEDIUM: "TEXT_LARGE";
-    readonly LARGE: "TEXT_LARGE";
-    readonly TEXT_SMALL: "TEXT_SMALL";
-    readonly TEXT_LARGE: "TEXT_LARGE";
-    readonly TEXT_EMBEDDING: "TEXT_EMBEDDING";
-    readonly TEXT_TOKENIZER_ENCODE: "TEXT_TOKENIZER_ENCODE";
-    readonly TEXT_TOKENIZER_DECODE: "TEXT_TOKENIZER_DECODE";
-    readonly TEXT_REASONING_SMALL: "REASONING_SMALL";
-    readonly TEXT_REASONING_LARGE: "REASONING_LARGE";
-    readonly TEXT_COMPLETION: "TEXT_COMPLETION";
-    readonly IMAGE: "IMAGE";
-    readonly IMAGE_DESCRIPTION: "IMAGE_DESCRIPTION";
-    readonly TRANSCRIPTION: "TRANSCRIPTION";
-    readonly TEXT_TO_SPEECH: "TEXT_TO_SPEECH";
-    readonly AUDIO: "AUDIO";
-    readonly VIDEO: "VIDEO";
-    readonly OBJECT_SMALL: "OBJECT_SMALL";
-    readonly OBJECT_LARGE: "OBJECT_LARGE";
-};
-export type ServiceType = (typeof ServiceTypes)[keyof typeof ServiceTypes];
-export declare const ServiceTypes: {
-    readonly TRANSCRIPTION: "transcription";
-    readonly VIDEO: "video";
-    readonly BROWSER: "browser";
-    readonly PDF: "pdf";
-    readonly REMOTE_FILES: "aws_s3";
-    readonly WEB_SEARCH: "web_search";
-    readonly EMAIL: "email";
-    readonly TEE: "tee";
-    readonly TASK: "task";
-};
-/**
- * Represents the current state/context of a conversation
- */
-export interface State {
-    /** Additional dynamic properties */
-    [key: string]: any;
-    values: {
-        [key: string]: any;
-    };
-    data: {
-        [key: string]: any;
-    };
-    text: string;
-}
-export type MemoryTypeAlias = string;
-export declare enum MemoryType {
-    DOCUMENT = "document",
-    FRAGMENT = "fragment",
-    MESSAGE = "message",
-    DESCRIPTION = "description",
-    CUSTOM = "custom"
-}
-export interface BaseMetadata {
-    type: MemoryTypeAlias;
-    source?: string;
-    sourceId?: UUID;
-    scope?: string;
-    timestamp?: number;
-    tags?: string[];
-}
-export interface DocumentMetadata extends BaseMetadata {
-    type: MemoryType.DOCUMENT;
-}
-export interface FragmentMetadata extends BaseMetadata {
-    type: MemoryType.FRAGMENT;
-    documentId: UUID;
-    position: number;
-}
-export interface MessageMetadata extends BaseMetadata {
-    type: MemoryType.MESSAGE;
-}
-export interface DescriptionMetadata extends BaseMetadata {
-    type: MemoryType.DESCRIPTION;
-}
-export interface CustomMetadata extends BaseMetadata {
-    type: MemoryTypeAlias;
-    [key: string]: unknown;
-}
-export type MemoryMetadata = DocumentMetadata | FragmentMetadata | MessageMetadata | DescriptionMetadata | CustomMetadata | any;
-/**
- * Represents a stored memory/message
- */
-export interface Memory {
-    /** Optional unique identifier */
-    id?: UUID;
-    /** Associated user ID */
-    entityId: UUID;
-    /** Associated agent ID */
-    agentId?: UUID;
-    /** Optional creation timestamp */
-    createdAt?: number;
-    /** Memory content */
-    content: Content;
-    /** Optional embedding vector */
-    embedding?: number[];
-    /** Associated room ID */
-    roomId: UUID;
-    /** Whether memory is unique */
-    unique?: boolean;
-    /** Embedding similarity score */
-    similarity?: number;
-    /** Metadata for the knowledge */
-    metadata?: MemoryMetadata;
-}
-/**
- * Example message for demonstration
- */
-export interface MessageExample {
-    /** Associated user */
-    name: string;
-    /** Message content */
-    content: Content;
-}
-/**
- * Handler function type for processing messages
- */
-export type Handler = (runtime: IAgentRuntime, message: Memory, state?: State, options?: {
-    [key: string]: unknown;
-}, callback?: HandlerCallback, responses?: Memory[]) => Promise<unknown>;
-/**
- * Callback function type for handlers
- */
-export type HandlerCallback = (response: Content, files?: any) => Promise<Memory[]>;
-/**
- * Validator function type for actions/evaluators
- */
-export type Validator = (runtime: IAgentRuntime, message: Memory, state?: State) => Promise<boolean>;
-/**
- * Represents an action the agent can perform
- */
-export interface Action {
-    /** Similar action descriptions */
-    similes?: string[];
-    /** Detailed description */
-    description: string;
-    /** Example usages */
-    examples?: ActionExample[][];
-    /** Handler function */
-    handler: Handler;
-    /** Action name */
-    name: string;
-    /** Validation function */
-    validate: Validator;
-}
-/**
- * Example for evaluating agent behavior
- */
-export interface EvaluationExample {
-    /** Evaluation context */
-    prompt: string;
-    /** Example messages */
-    messages: Array<ActionExample>;
-    /** Expected outcome */
-    outcome: string;
-}
-/**
- * Evaluator for assessing agent responses
- */
-export interface Evaluator {
-    /** Whether to always run */
-    alwaysRun?: boolean;
-    /** Detailed description */
-    description: string;
-    /** Similar evaluator descriptions */
-    similes?: string[];
-    /** Example evaluations */
-    examples: EvaluationExample[];
-    /** Handler function */
-    handler: Handler;
-    /** Evaluator name */
-    name: string;
-    /** Validation function */
-    validate: Validator;
-}
-export interface ProviderResult {
-    values?: {
-        [key: string]: any;
-    };
-    data?: {
-        [key: string]: any;
-    };
-    text?: string;
-}
-/**
- * Provider for external data/services
- */
-export interface Provider {
-    /** Provider name */
-    name: string;
-    /** Description of the provider */
-    description?: string;
-    /** Whether the provider is dynamic */
-    dynamic?: boolean;
-    /** Position of the provider in the provider list, positive or negative */
-    position?: number;
-    /**
-     * Whether the provider is private
-     *
-     * Private providers are not displayed in the regular provider list, they have to be called explicitly
-     */
-    private?: boolean;
-    /** Data retrieval function */
-    get: (runtime: IAgentRuntime, message: Memory, state: State) => Promise<ProviderResult>;
-}
-/**
- * Represents a relationship between users
- */
-export interface Relationship {
-    /** Unique identifier */
-    id: UUID;
-    /** First user ID */
-    sourceEntityId: UUID;
-    /** Second user ID */
-    targetEntityId: UUID;
-    /** Agent ID */
-    agentId: UUID;
-    /** Tags for filtering/categorizing relationships */
-    tags: string[];
-    /** Additional metadata about the relationship */
-    metadata: {
-        [key: string]: any;
-    };
-    /** Optional creation timestamp */
-    createdAt?: string;
-}
-export interface Component {
-    id: UUID;
-    entityId: UUID;
-    agentId: UUID;
-    roomId: UUID;
-    worldId: UUID;
-    sourceEntityId: UUID;
-    type: string;
-    data: {
-        [key: string]: any;
-    };
-}
-/**
- * Represents a user account
- */
-export interface Entity {
-    /** Unique identifier, optional on creation */
-    id?: UUID;
-    /** Names of the entity */
-    names: string[];
-    /** Optional additional metadata */
-    metadata?: {
-        [key: string]: any;
-    };
-    /** Agent ID this account is related to, for agents should be themselves */
-    agentId: UUID;
-    /** Optional array of components */
-    components?: Component[];
-}
-export type World = {
-    id: UUID;
-    name?: string;
-    agentId: UUID;
-    serverId: string;
-    metadata?: {
-        ownership?: {
-            ownerId: string;
-        };
-        roles?: {
-            [entityId: UUID]: Role;
-        };
-        [key: string]: unknown;
-    };
-};
-export type Room = {
-    id: UUID;
-    name?: string;
-    agentId?: UUID;
-    source: string;
-    type: ChannelType;
-    channelId?: string;
-    serverId?: string;
-    worldId?: UUID;
-    metadata?: Record<string, unknown>;
-};
-/**
- * Room participant with account details
- */
-export interface Participant {
-    /** Unique identifier */
-    id: UUID;
-    /** Associated account */
-    entity: Entity;
-}
-/**
- * Represents a media attachment
- */
-export type Media = {
-    /** Unique identifier */
-    id: string;
-    /** Media URL */
-    url: string;
-    /** Media title */
-    title: string;
-    /** Media source */
-    source: string;
-    /** Media description */
-    description: string;
-    /** Text content */
-    text: string;
-    /** Content type */
-    contentType?: string;
-};
-export declare enum ChannelType {
-    SELF = "SELF",
-    DM = "DM",
-    GROUP = "GROUP",
-    VOICE_DM = "VOICE_DM",
-    VOICE_GROUP = "VOICE_GROUP",
-    FEED = "FEED",
-    THREAD = "THREAD",
-    WORLD = "WORLD",
-    API = "API",
-    FORUM = "FORUM"
-}
-/**
- * Client instance
- */
-export declare abstract class Service {
-    /** Runtime instance */
-    protected runtime: IAgentRuntime;
-    constructor(runtime?: IAgentRuntime);
-    abstract stop(): Promise<void>;
-    /** Service type */
-    static serviceType: string;
-    /** Service name */
-    abstract capabilityDescription: string;
-    /** Service configuration */
-    config?: {
-        [key: string]: any;
-    };
-    /** Start service connection */
-    static start(_runtime: IAgentRuntime): Promise<Service>;
-    /** Stop service connection */
-    static stop(_runtime: IAgentRuntime): Promise<unknown>;
-}
-export type Route = {
-    type: "GET" | "POST" | "PUT" | "DELETE" | "STATIC";
-    path: string;
-    filePath?: string;
-    handler?: (req: any, res: any, runtime: IAgentRuntime) => Promise<void>;
-};
-/**
- * Plugin for extending agent functionality
- */
-export interface Plugin {
-    name: string;
-    description: string;
-    init?: (config: Record<string, string>, runtime: IAgentRuntime) => Promise<void>;
-    config?: {
-        [key: string]: any;
-    };
-    memoryManagers?: IMemoryManager[];
-    services?: (typeof Service)[];
-    componentTypes?: {
-        name: string;
-        schema: Record<string, unknown>;
-        validator?: (data: any) => boolean;
-    }[];
-    actions?: Action[];
-    providers?: Provider[];
-    evaluators?: Evaluator[];
-    adapter?: IDatabaseAdapter;
-    models?: {
-        [key: string]: (...args: any[]) => Promise<any>;
-    };
-    events?: {
-        [K in keyof EventPayloadMap]?: EventHandler<K>[];
-    } & {
-        [key: string]: ((params: EventPayload) => Promise<any>)[];
-    };
-    routes?: Route[];
-    tests?: TestSuite[];
-}
-export interface ProjectAgent {
-    character: Character;
-    init?: (runtime: IAgentRuntime) => Promise<void>;
-    plugins?: Plugin[];
-    tests?: TestSuite | TestSuite[];
-}
-export interface Project {
-    agents: ProjectAgent[];
-}
-export interface ModelConfiguration {
-    temperature?: number;
-    maxOutputTokens?: number;
-    frequency_penalty?: number;
-    presence_penalty?: number;
-    maxInputTokens?: number;
-}
-export type TemplateType = string | ((options: {
-    state: State | {
-        [key: string]: string;
-    };
-}) => string);
-/**
- * Configuration for an agent character
- */
-export interface Character {
-    /** Optional unique identifier */
-    id?: UUID;
-    /** Character name */
-    name: string;
-    /** Optional username */
-    username?: string;
-    /** Optional system prompt */
-    system?: string;
-    /** Optional prompt templates */
-    templates?: {
-        [key: string]: TemplateType;
-    };
-    /** Character biography */
-    bio: string | string[];
-    /** Example messages */
-    messageExamples?: MessageExample[][];
-    /** Example posts */
-    postExamples?: string[];
-    /** Known topics */
-    topics?: string[];
-    /** Character traits */
-    adjectives?: string[];
-    /** Optional knowledge base */
-    knowledge?: (string | {
-        path: string;
-        shared?: boolean;
-    })[];
-    /** Available plugins */
-    plugins?: string[];
-    /** Optional configuration */
-    settings?: {
-        [key: string]: any | string | boolean | number;
-    };
-    /** Optional secrets */
-    secrets?: {
-        [key: string]: string | boolean | number;
-    };
-    /** Writing style guides */
-    style?: {
-        all?: string[];
-        chat?: string[];
-        post?: string[];
-    };
-}
-export interface Agent extends Character {
-    createdAt: number;
-    updatedAt: number;
-}
-/**
- * Interface for database operations
- */
-export interface IDatabaseAdapter {
-    /** Database instance */
-    db: any;
-    /** Initialize database connection */
-    init(): Promise<void>;
-    /** Close database connection */
-    close(): Promise<void>;
-    getAgent(agentId: UUID): Promise<Agent | null>;
-    /** Get all agents */
-    getAgents(): Promise<Agent[]>;
-    createAgent(agent: Partial<Agent>): Promise<boolean>;
-    updateAgent(agentId: UUID, agent: Partial<Agent>): Promise<boolean>;
-    deleteAgent(agentId: UUID): Promise<boolean>;
-    ensureAgentExists(agent: Partial<Agent>): Promise<void>;
-    ensureEmbeddingDimension(dimension: number): Promise<void>;
-    /** Get entity by ID */
-    getEntityById(entityId: UUID): Promise<Entity | null>;
-    /** Get entities for room */
-    getEntitiesForRoom(roomId: UUID, includeComponents?: boolean): Promise<Entity[]>;
-    /** Create new entity */
-    createEntity(entity: Entity): Promise<boolean>;
-    /** Update entity */
-    updateEntity(entity: Entity): Promise<void>;
-    /** Get component by ID */
-    getComponent(entityId: UUID, type: string, worldId?: UUID, sourceEntityId?: UUID): Promise<Component | null>;
-    /** Get all components for an entity */
-    getComponents(entityId: UUID, worldId?: UUID, sourceEntityId?: UUID): Promise<Component[]>;
-    /** Create component */
-    createComponent(component: Component): Promise<boolean>;
-    /** Update component */
-    updateComponent(component: Component): Promise<void>;
-    /** Delete component */
-    deleteComponent(componentId: UUID): Promise<void>;
-    /** Get memories matching criteria */
-    getMemories(params: {
-        roomId: UUID;
-        count?: number;
-        unique?: boolean;
-        tableName: string;
-        start?: number;
-        end?: number;
-    }): Promise<Memory[]>;
-    getMemoryById(id: UUID): Promise<Memory | null>;
-    getMemoriesByIds(ids: UUID[], tableName?: string): Promise<Memory[]>;
-    getMemoriesByRoomIds(params: {
-        tableName: string;
-        roomIds: UUID[];
-        limit?: number;
-    }): Promise<Memory[]>;
-    getCachedEmbeddings(params: {
-        query_table_name: string;
-        query_threshold: number;
-        query_input: string;
-        query_field_name: string;
-        query_field_sub_name: string;
-        query_match_count: number;
-    }): Promise<{
-        embedding: number[];
-        levenshtein_score: number;
-    }[]>;
-    log(params: {
-        body: {
-            [key: string]: unknown;
-        };
-        entityId: UUID;
-        roomId: UUID;
-        type: string;
-    }): Promise<void>;
-    searchMemories(params: {
-        embedding: number[];
-        match_threshold?: number;
-        count?: number;
-        roomId?: UUID;
-        unique?: boolean;
-        tableName: string;
-    }): Promise<Memory[]>;
-    createMemory(memory: Memory, tableName: string, unique?: boolean): Promise<UUID>;
-    removeMemory(memoryId: UUID, tableName: string): Promise<void>;
-    removeAllMemories(roomId: UUID, tableName: string): Promise<void>;
-    countMemories(roomId: UUID, unique?: boolean, tableName?: string): Promise<number>;
-    createWorld(world: World): Promise<UUID>;
-    getWorld(id: UUID): Promise<World | null>;
-    getAllWorlds(): Promise<World[]>;
-    updateWorld(world: World): Promise<void>;
-    getRoom(roomId: UUID): Promise<Room | null>;
-    createRoom({ id, name, source, type, channelId, serverId, worldId, }: Room): Promise<UUID>;
-    deleteRoom(roomId: UUID): Promise<void>;
-    updateRoom(room: Room): Promise<void>;
-    getRoomsForParticipant(entityId: UUID): Promise<UUID[]>;
-    getRoomsForParticipants(userIds: UUID[]): Promise<UUID[]>;
-    getRooms(worldId: UUID): Promise<Room[]>;
-    addParticipant(entityId: UUID, roomId: UUID): Promise<boolean>;
-    removeParticipant(entityId: UUID, roomId: UUID): Promise<boolean>;
-    getParticipantsForEntity(entityId: UUID): Promise<Participant[]>;
-    getParticipantsForRoom(roomId: UUID): Promise<UUID[]>;
-    getParticipantUserState(roomId: UUID, entityId: UUID): Promise<"FOLLOWED" | "MUTED" | null>;
-    setParticipantUserState(roomId: UUID, entityId: UUID, state: "FOLLOWED" | "MUTED" | null): Promise<void>;
-    /**
-     * Creates a new relationship between two entities.
-     * @param params Object containing the relationship details
-     * @returns Promise resolving to boolean indicating success
-     */
-    createRelationship(params: {
-        sourceEntityId: UUID;
-        targetEntityId: UUID;
-        tags?: string[];
-        metadata?: {
-            [key: string]: any;
-        };
-    }): Promise<boolean>;
-    /**
-     * Updates an existing relationship between two entities.
-     * @param relationship The relationship object with updated data
-     * @returns Promise resolving to void
-     */
-    updateRelationship(relationship: Relationship): Promise<void>;
-    /**
-     * Retrieves a relationship between two entities if it exists.
-     * @param params Object containing the entity IDs and agent ID
-     * @returns Promise resolving to the Relationship object or null if not found
-     */
-    getRelationship(params: {
-        sourceEntityId: UUID;
-        targetEntityId: UUID;
-    }): Promise<Relationship | null>;
-    /**
-     * Retrieves all relationships for a specific entity.
-     * @param params Object containing the user ID, agent ID and optional tags to filter by
-     * @returns Promise resolving to an array of Relationship objects
-     */
-    getRelationships(params: {
-        entityId: UUID;
-        tags?: string[];
-    }): Promise<Relationship[]>;
-    ensureEmbeddingDimension(dimension: number): Promise<void>;
-    getCache<T>(key: string): Promise<T | undefined>;
-    setCache<T>(key: string, value: T): Promise<boolean>;
-    deleteCache(key: string): Promise<boolean>;
-    createTask(task: Task): Promise<UUID>;
-    getTasks(params: {
-        roomId?: UUID;
-        tags?: string[];
-    }): Promise<Task[]>;
-    getTask(id: UUID): Promise<Task | null>;
-    getTasksByName(name: string): Promise<Task[]>;
-    updateTask(id: UUID, task: Partial<Task>): Promise<void>;
-    deleteTask(id: UUID): Promise<void>;
-}
-export interface IMemoryManager {
-    runtime: IAgentRuntime;
-    tableName: string;
-    addEmbeddingToMemory(memory: Memory): Promise<Memory>;
-    getMemories(opts: {
-        roomId: UUID;
-        count?: number;
-        unique?: boolean;
-        start?: number;
-        end?: number;
-    }): Promise<Memory[]>;
-    searchMemories(params: {
-        embedding: number[];
-        match_threshold?: number;
-        count?: number;
-        roomId?: UUID;
-        unique?: boolean;
-        metadata?: MemoryMetadata;
-    }): Promise<Memory[]>;
-    getCachedEmbeddings(content: string): Promise<{
-        embedding: number[];
-        levenshtein_score: number;
-    }[]>;
-    getMemoryById(id: UUID): Promise<Memory | null>;
-    getMemoriesByRoomIds(params: {
-        roomIds: UUID[];
-        limit?: number;
-    }): Promise<Memory[]>;
-    createMemory(memory: Memory, unique?: boolean): Promise<UUID>;
-    removeMemory(memoryId: UUID): Promise<void>;
-    removeAllMemories(roomId: UUID): Promise<void>;
-    countMemories(roomId: UUID, unique?: boolean): Promise<number>;
-}
-export type CacheOptions = {
-    expires?: number;
-};
-export interface IAgentRuntime extends IDatabaseAdapter {
-    agentId: UUID;
-    databaseAdapter: IDatabaseAdapter;
-    character: Character;
-    providers: Provider[];
-    actions: Action[];
-    evaluators: Evaluator[];
-    plugins: Plugin[];
-    services: Map<ServiceType, Service>;
-    events: Map<string, ((params: any) => Promise<void>)[]>;
-    fetch?: typeof fetch | null;
-    routes: Route[];
-    registerPlugin(plugin: Plugin): Promise<void>;
-    initialize(): Promise<void>;
-    getKnowledge(message: Memory): Promise<KnowledgeItem[]>;
-    addKnowledge(item: KnowledgeItem, options: {
-        targetTokens: number;
-        overlap: number;
-        modelContextSize: number;
-    }): Promise<void>;
-    getMemoryManager(tableName: string): IMemoryManager | null;
-    getService<T extends Service>(service: ServiceType | string): T | null;
-    getAllServices(): Map<ServiceType, Service>;
-    registerService(service: typeof Service): void;
-    registerDatabaseAdapter(adapter: IDatabaseAdapter): void;
-    setSetting(key: string, value: string | boolean | null | any, secret: boolean): void;
-    getSetting(key: string): string | boolean | null | any;
-    getConversationLength(): number;
-    processActions(message: Memory, responses: Memory[], state?: State, callback?: HandlerCallback): Promise<void>;
-    evaluate(message: Memory, state?: State, didRespond?: boolean, callback?: HandlerCallback, responses?: Memory[]): Promise<Evaluator[] | null>;
-    registerProvider(provider: Provider): void;
-    registerAction(action: Action): void;
-    registerEvaluator(evaluator: Evaluator): void;
-    ensureConnection({ entityId, roomId, userName, name, source, channelId, serverId, type, worldId, }: {
-        entityId: UUID;
-        roomId: UUID;
-        userName?: string;
-        name?: string;
-        source?: string;
-        channelId?: string;
-        serverId?: string;
-        type: ChannelType;
-        worldId?: UUID;
-    }): Promise<void>;
-    ensureParticipantInRoom(entityId: UUID, roomId: UUID): Promise<void>;
-    ensureWorldExists(world: World): Promise<void>;
-    ensureRoomExists(room: Room): Promise<void>;
-    composeState(message: Memory, filterList?: string[], includeList?: string[]): Promise<State>;
-    /**
-     * Use a model with strongly typed parameters and return values based on model type
-     * @template T - The model type to use
-     * @template R - The expected return type, defaults to the type defined in ModelResultMap[T]
-     * @param {T} modelType - The type of model to use
-     * @param {ModelParamsMap[T] | any} params - The parameters for the model, typed based on model type
-     * @returns {Promise<R>} - The model result, typed based on the provided generic type parameter
-     */
-    useModel<T extends ModelType, R = ModelResultMap[T]>(modelType: T, params: Omit<ModelParamsMap[T], "runtime"> | any): Promise<R>;
-    registerModel(modelType: ModelType | string, handler: (params: any) => Promise<any>): void;
-    getModel(modelType: ModelType | string): ((runtime: IAgentRuntime, params: any) => Promise<any>) | undefined;
-    registerEvent(event: string, handler: (params: any) => Promise<void>): void;
-    getEvent(event: string): ((params: any) => Promise<void>)[] | undefined;
-    emitEvent(event: string | string[], params: any): Promise<void>;
-    registerTaskWorker(taskHandler: TaskWorker): void;
-    getTaskWorker(name: string): TaskWorker | undefined;
-    stop(): Promise<void>;
-}
-export type KnowledgeItem = {
-    id: UUID;
-    content: Content;
-};
-export declare enum KnowledgeScope {
-    SHARED = "shared",
-    PRIVATE = "private"
-}
-export declare enum CacheKeyPrefix {
-    KNOWLEDGE = "knowledge"
-}
-export interface DirectoryItem {
-    directory: string;
-    shared?: boolean;
-}
-export interface ChunkRow {
-    id: string;
-}
-export type GenerateTextParams = {
-    runtime: IAgentRuntime;
-    prompt: string;
-    modelType: ModelType;
-    maxTokens?: number;
-    temperature?: number;
-    frequencyPenalty?: number;
-    presencePenalty?: number;
-    stopSequences?: string[];
-};
-export interface TokenizeTextParams {
-    prompt: string;
-    modelType: ModelType;
-}
-export interface DetokenizeTextParams {
-    tokens: number[];
-    modelType: ModelType;
-}
-export interface IVideoService extends Service {
-    isVideoUrl(url: string): boolean;
-    fetchVideoInfo(url: string): Promise<Media>;
-    downloadVideo(videoInfo: Media): Promise<string>;
-    processVideo(url: string, runtime: IAgentRuntime): Promise<Media>;
-}
-export interface IBrowserService extends Service {
-    getPageContent(url: string, runtime: IAgentRuntime): Promise<{
-        title: string;
-        description: string;
-        bodyContent: string;
-    }>;
-}
-export interface IPdfService extends Service {
-    convertPdfToText(pdfBuffer: Buffer): Promise<string>;
-}
-export interface IFileService extends Service {
-    uploadFile(imagePath: string, subDirectory: string, useSignedUrl: boolean, expiresIn: number): Promise<{
-        success: boolean;
-        url?: string;
-        error?: string;
-    }>;
-    generateSignedUrl(fileName: string, expiresIn: number): Promise<string>;
-}
-export interface ITeeLogService extends Service {
-    log(agentId: string, roomId: string, entityId: string, type: string, content: string): Promise<boolean>;
-    generateAttestation<T>(reportData: string, hashAlgorithm?: T | any): Promise<string>;
-    getAllAgents(): Promise<TeeAgent[]>;
-    getAgent(agentId: string): Promise<TeeAgent | null>;
-    getLogs(query: TeeLogQuery, page: number, pageSize: number): Promise<TeePageQuery<TeeLog[]>>;
-}
-export interface TestCase {
-    name: string;
-    fn: (runtime: IAgentRuntime) => Promise<void> | void;
-}
-export interface TestSuite {
-    name: string;
-    tests: TestCase[];
-}
-export interface TeeLog {
-    id: string;
-    agentId: string;
-    roomId: string;
-    entityId: string;
-    type: string;
-    content: string;
-    timestamp: number;
-    signature: string;
-}
-export interface TeeLogQuery {
-    agentId?: string;
-    roomId?: string;
-    entityId?: string;
-    type?: string;
-    containsContent?: string;
-    startTimestamp?: number;
-    endTimestamp?: number;
-}
-export interface TeeAgent {
-    id: string;
-    agentId: string;
-    agentName: string;
-    createdAt: number;
-    publicKey: string;
-    attestation: string;
-}
-export interface TeePageQuery<Result = any> {
-    page: number;
-    pageSize: number;
-    total?: number;
-    data?: Result;
-}
-export declare abstract class TeeLogDAO<DB = any> {
-    db: DB;
-    abstract initialize(): Promise<void>;
-    abstract addLog(log: TeeLog): Promise<boolean>;
-    abstract getPagedLogs(query: TeeLogQuery, page: number, pageSize: number): Promise<TeePageQuery<TeeLog[]>>;
-    abstract addAgent(agent: TeeAgent): Promise<boolean>;
-    abstract getAgent(agentId: string): Promise<TeeAgent>;
-    abstract getAllAgents(): Promise<TeeAgent[]>;
-}
-export declare enum TEEMode {
-    OFF = "OFF",
-    LOCAL = "LOCAL",// For local development with simulator
-    DOCKER = "DOCKER",// For docker development with simulator
-    PRODUCTION = "PRODUCTION"
-}
-export interface RemoteAttestationQuote {
-    quote: string;
-    timestamp: number;
-}
-export interface DeriveKeyAttestationData {
-    agentId: string;
-    publicKey: string;
-    subject?: string;
-}
-export interface RemoteAttestationMessage {
-    agentId: string;
-    timestamp: number;
-    message: {
-        entityId: string;
-        roomId: string;
-        content: string;
-    };
-}
-export interface SgxAttestation {
-    quote: string;
-    timestamp: number;
-}
-export declare enum TeeType {
-    SGX_GRAMINE = "sgx_gramine",
-    TDX_DSTACK = "tdx_dstack"
-}
-export interface TeeVendorConfig {
-    [key: string]: unknown;
-}
-export interface TeePluginConfig {
-    vendor?: string;
-    vendorConfig?: TeeVendorConfig;
-}
-export interface TaskWorker {
-    name: string;
-    execute: (runtime: IAgentRuntime, options: {
-        [key: string]: unknown;
-    }, task: Task) => Promise<void>;
-    validate?: (runtime: IAgentRuntime, message: Memory, state: State) => Promise<boolean>;
-}
-export interface Task {
-    id?: UUID;
-    name: string;
-    updatedAt?: number;
-    metadata?: {
-        updateInterval?: number;
-        options?: {
-            name: string;
-            description: string;
-        }[];
-        [key: string]: unknown;
-    };
-    description: string;
-    roomId?: UUID;
-    worldId?: UUID;
-    tags: string[];
-}
-export declare enum Role {
-    OWNER = "OWNER",
-    ADMIN = "ADMIN",
-    NONE = "NONE"
-}
-export interface Setting {
-    name: string;
-    description: string;
-    usageDescription: string;
-    value: string | boolean | null;
-    required: boolean;
-    public?: boolean;
-    secret?: boolean;
-    validation?: (value: any) => boolean;
-    dependsOn?: string[];
-    onSetAction?: (value: any) => string;
-    visibleIf?: (settings: {
-        [key: string]: Setting;
-    }) => boolean;
-}
-export interface WorldSettings {
-    [key: string]: Setting;
-}
-export interface OnboardingConfig {
-    settings: {
-        [key: string]: Omit<Setting, "value">;
-    };
-}
-/**
- * Base parameters common to all model types
- */
-export interface BaseModelParams {
-    /** The agent runtime for accessing services and utilities */
-    runtime: IAgentRuntime;
-}
-/**
- * Parameters for text generation models
- */
-export interface TextGenerationParams extends BaseModelParams {
-    /** The prompt to generate text from */
-    prompt: string;
-    /** Model temperature (0.0 to 1.0, lower is more deterministic) */
-    temperature?: number;
-    /** Maximum number of tokens to generate */
-    maxTokens?: number;
-    /** Sequences that should stop generation when encountered */
-    stopSequences?: string[];
-    /** Frequency penalty to apply */
-    frequencyPenalty?: number;
-    /** Presence penalty to apply */
-    presencePenalty?: number;
-}
-/**
- * Parameters for text embedding models
- */
-export interface TextEmbeddingParams extends BaseModelParams {
-    /** The text to create embeddings for */
-    text: string;
-}
-/**
- * Parameters for text tokenization models
- */
-export interface TokenizeTextParams extends BaseModelParams {
-    /** The text to tokenize */
-    prompt: string;
-    /** The model type to use for tokenization */
-    modelType: ModelType;
-}
-/**
- * Parameters for text detokenization models
- */
-export interface DetokenizeTextParams extends BaseModelParams {
-    /** The tokens to convert back to text */
-    tokens: number[];
-    /** The model type to use for detokenization */
-    modelType: ModelType;
-}
-/**
- * Parameters for image generation models
- */
-export interface ImageGenerationParams extends BaseModelParams {
-    /** The prompt describing the image to generate */
-    prompt: string;
-    /** The dimensions of the image to generate */
-    size?: string;
-    /** Number of images to generate */
-    count?: number;
-}
-/**
- * Parameters for image description models
- */
-export interface ImageDescriptionParams extends BaseModelParams {
-    /** The URL or path of the image to describe */
-    imageUrl: string;
-    /** Optional prompt to guide the description */
-    prompt?: string;
-}
-/**
- * Parameters for transcription models
- */
-export interface TranscriptionParams extends BaseModelParams {
-    /** The URL or path of the audio file to transcribe */
-    audioUrl: string;
-    /** Optional prompt to guide transcription */
-    prompt?: string;
-}
-/**
- * Parameters for text-to-speech models
- */
-export interface TextToSpeechParams extends BaseModelParams {
-    /** The text to convert to speech */
-    text: string;
-    /** The voice to use */
-    voice?: string;
-    /** The speaking speed */
-    speed?: number;
-}
-/**
- * Parameters for audio processing models
- */
-export interface AudioProcessingParams extends BaseModelParams {
-    /** The URL or path of the audio file to process */
-    audioUrl: string;
-    /** The type of audio processing to perform */
-    processingType: string;
-}
-/**
- * Parameters for video processing models
- */
-export interface VideoProcessingParams extends BaseModelParams {
-    /** The URL or path of the video file to process */
-    videoUrl: string;
-    /** The type of video processing to perform */
-    processingType: string;
-}
-/**
- * Optional JSON schema for validating generated objects
- */
-export type JSONSchema = {
-    type: string;
-    properties?: Record<string, any>;
-    required?: string[];
-    items?: JSONSchema;
-    [key: string]: any;
-};
-/**
- * Parameters for object generation models
- * @template T - The expected return type, inferred from schema if provided
- */
-export interface ObjectGenerationParams<T = any> extends BaseModelParams {
-    /** The prompt describing the object to generate */
-    prompt: string;
-    /** Optional JSON schema for validation */
-    schema?: JSONSchema;
-    /** Type of object to generate */
-    output?: "object" | "array" | "enum";
-    /** For enum type, the allowed values */
-    enumValues?: string[];
-    /** Model type to use */
-    modelType?: ModelType;
-    /** Model temperature (0.0 to 1.0) */
-    temperature?: number;
-    /** Sequences that should stop generation */
-    stopSequences?: string[];
-}
-/**
- * Map of model types to their parameter types
- */
-export interface ModelParamsMap {
-    [ModelTypes.TEXT_SMALL]: TextGenerationParams;
-    [ModelTypes.TEXT_LARGE]: TextGenerationParams;
-    [ModelTypes.TEXT_EMBEDDING]: TextEmbeddingParams | string | null;
-    [ModelTypes.TEXT_TOKENIZER_ENCODE]: TokenizeTextParams;
-    [ModelTypes.TEXT_TOKENIZER_DECODE]: DetokenizeTextParams;
-    [ModelTypes.TEXT_REASONING_SMALL]: TextGenerationParams;
-    [ModelTypes.TEXT_REASONING_LARGE]: TextGenerationParams;
-    [ModelTypes.IMAGE]: ImageGenerationParams;
-    [ModelTypes.IMAGE_DESCRIPTION]: ImageDescriptionParams | string;
-    [ModelTypes.TRANSCRIPTION]: TranscriptionParams | Buffer | string;
-    [ModelTypes.TEXT_TO_SPEECH]: TextToSpeechParams | string;
-    [ModelTypes.AUDIO]: AudioProcessingParams;
-    [ModelTypes.VIDEO]: VideoProcessingParams;
-    [ModelTypes.OBJECT_SMALL]: ObjectGenerationParams<any>;
-    [ModelTypes.OBJECT_LARGE]: ObjectGenerationParams<any>;
-    [key: string]: BaseModelParams | any;
-}
-/**
- * Map of model types to their return value types
- */
-export interface ModelResultMap {
-    [ModelTypes.TEXT_SMALL]: string;
-    [ModelTypes.TEXT_LARGE]: string;
-    [ModelTypes.TEXT_EMBEDDING]: number[];
-    [ModelTypes.TEXT_TOKENIZER_ENCODE]: number[];
-    [ModelTypes.TEXT_TOKENIZER_DECODE]: string;
-    [ModelTypes.TEXT_REASONING_SMALL]: string;
-    [ModelTypes.TEXT_REASONING_LARGE]: string;
-    [ModelTypes.IMAGE]: {
-        url: string;
-    }[];
-    [ModelTypes.IMAGE_DESCRIPTION]: {
-        title: string;
-        description: string;
-    };
-    [ModelTypes.TRANSCRIPTION]: string;
-    [ModelTypes.TEXT_TO_SPEECH]: Readable | Buffer;
-    [ModelTypes.AUDIO]: any;
-    [ModelTypes.VIDEO]: any;
-    [ModelTypes.OBJECT_SMALL]: any;
-    [ModelTypes.OBJECT_LARGE]: any;
-    [key: string]: any;
-}
-/**
- * Standard event types across all platforms
- */
-export declare enum EventTypes {
-    WORLD_JOINED = "WORLD_JOINED",
-    WORLD_CONNECTED = "WORLD_CONNECTED",
-    WORLD_LEFT = "WORLD_LEFT",
-    ENTITY_JOINED = "ENTITY_JOINED",
-    ENTITY_LEFT = "ENTITY_LEFT",
-    ENTITY_UPDATED = "ENTITY_UPDATED",
-    ROOM_JOINED = "ROOM_JOINED",
-    ROOM_LEFT = "ROOM_LEFT",
-    MESSAGE_RECEIVED = "MESSAGE_RECEIVED",
-    MESSAGE_SENT = "MESSAGE_SENT",
-    VOICE_MESSAGE_RECEIVED = "VOICE_MESSAGE_RECEIVED",
-    VOICE_MESSAGE_SENT = "VOICE_MESSAGE_SENT",
-    REACTION_RECEIVED = "REACTION_RECEIVED",
-    POST_GENERATED = "POST_GENERATED",
-    INTERACTION_RECEIVED = "INTERACTION_RECEIVED",
-    RUN_STARTED = "RUN_STARTED",
-    RUN_ENDED = "RUN_ENDED",
-    RUN_TIMEOUT = "RUN_TIMEOUT",
-    ACTION_STARTED = "ACTION_STARTED",
-    ACTION_COMPLETED = "ACTION_COMPLETED",
-    EVALUATOR_STARTED = "EVALUATOR_STARTED",
-    EVALUATOR_COMPLETED = "EVALUATOR_COMPLETED"
-}
-/**
- * Platform-specific event type prefix
- */
-export declare enum PlatformPrefix {
-    DISCORD = "DISCORD",
-    TELEGRAM = "TELEGRAM",
-    TWITTER = "TWITTER"
-}
-/**
- * Base payload interface for all events
- */
-export interface EventPayload {
-    runtime: IAgentRuntime;
-    source: string;
-}
-/**
- * Payload for world-related events
- */
-export interface WorldPayload extends EventPayload {
-    world: World;
-    rooms: Room[];
-    entities: Entity[];
-}
-/**
- * Payload for entity-related events
- */
-export interface EntityPayload extends EventPayload {
-    entityId: UUID;
-    worldId?: UUID;
-    roomId?: UUID;
-    metadata?: {
-        orginalId: string;
-        username: string;
-        displayName?: string;
-        [key: string]: any;
-    };
-}
-/**
- * Payload for reaction-related events
- */
-export interface MessagePayload extends EventPayload {
-    message: Memory;
-    callback?: HandlerCallback;
-}
-/**
- * Run event payload type
- */
-export interface RunEventPayload extends EventPayload {
-    runId: UUID;
-    messageId: UUID;
-    roomId: UUID;
-    entityId: UUID;
-    startTime: number;
-    status: "started" | "completed" | "timeout";
-    endTime?: number;
-    duration?: number;
-    error?: string;
-}
-/**
- * Action event payload type
- */
-export interface ActionEventPayload extends EventPayload {
-    actionId: UUID;
-    actionName: string;
-    startTime?: number;
-    completed?: boolean;
-    error?: Error;
-}
-/**
- * Evaluator event payload type
- */
-export interface EvaluatorEventPayload extends EventPayload {
-    evaluatorId: UUID;
-    evaluatorName: string;
-    startTime?: number;
-    completed?: boolean;
-    error?: Error;
-}
-/**
- * Maps event types to their corresponding payload types
- */
-export interface EventPayloadMap {
-    [EventTypes.WORLD_JOINED]: WorldPayload;
-    [EventTypes.WORLD_CONNECTED]: WorldPayload;
-    [EventTypes.WORLD_LEFT]: WorldPayload;
-    [EventTypes.ENTITY_JOINED]: EntityPayload;
-    [EventTypes.ENTITY_LEFT]: EntityPayload;
-    [EventTypes.ENTITY_UPDATED]: EntityPayload;
-    [EventTypes.MESSAGE_RECEIVED]: MessagePayload;
-    [EventTypes.MESSAGE_SENT]: MessagePayload;
-    [EventTypes.REACTION_RECEIVED]: MessagePayload;
-    [EventTypes.POST_GENERATED]: MessagePayload;
-    [EventTypes.INTERACTION_RECEIVED]: MessagePayload;
-    [EventTypes.RUN_STARTED]: RunEventPayload;
-    [EventTypes.RUN_ENDED]: RunEventPayload;
-    [EventTypes.RUN_TIMEOUT]: RunEventPayload;
-    [EventTypes.ACTION_STARTED]: ActionEventPayload;
-    [EventTypes.ACTION_COMPLETED]: ActionEventPayload;
-    [EventTypes.EVALUATOR_STARTED]: EvaluatorEventPayload;
-    [EventTypes.EVALUATOR_COMPLETED]: EvaluatorEventPayload;
-}
-/**
- * Event handler function type
- */
-export type EventHandler<T extends keyof EventPayloadMap> = (payload: EventPayloadMap[T]) => Promise<void>;
-/**
- * Update the Plugin interface with typed events
- */
-export declare enum SOCKET_MESSAGE_TYPE {
-    ROOM_JOINING = 1,
-    SEND_MESSAGE = 2
-}