@elizaos/core 1.0.0-alpha.0 → 1.0.0-alpha.11

package/dist/index.d.ts

@@ -4,6 +4,10 @@ import * as pino from 'pino';
 /**
  * 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
+ */
 type UUID = `${string}-${string}-${string}-${string}-${string}`;
 /**
  * Represents the content of a message or communication
@@ -429,9 +433,10 @@ declare abstract class Service {
     static stop(_runtime: IAgentRuntime): Promise<unknown>;
 }
 type Route = {
-    type: "GET" | "POST" | "PUT" | "DELETE";
+    type: "GET" | "POST" | "PUT" | "DELETE" | "STATIC";
     path: string;
-    handler: (req: any, res: any, runtime: IAgentRuntime) => Promise<void>;
+    filePath?: string;
+    handler?: (req: any, res: any, runtime: IAgentRuntime) => Promise<void>;
 };
 /**
  * Plugin for extending agent functionality
@@ -453,7 +458,7 @@ interface Plugin {
     actions?: Action[];
     providers?: Provider[];
     evaluators?: Evaluator[];
-    adapters?: IDatabaseAdapter[];
+    adapter?: IDatabaseAdapter;
     models?: {
         [key: string]: (...args: any[]) => Promise<any>;
     };
@@ -540,6 +545,8 @@ interface Agent extends Character {
 interface IDatabaseAdapter {
     /** Database instance */
     db: any;
+    /** Initialize database connection */
+    init(): Promise<void>;
     /** Close database connection */
     close(): Promise<void>;
     getAgent(agentId: UUID): Promise<Agent | null>;
@@ -759,7 +766,6 @@ interface IAgentRuntime {
     getAllServices(): Map<ServiceType, Service>;
     registerService(service: typeof Service): void;
     registerDatabaseAdapter(adapter: IDatabaseAdapter): void;
-    getDatabaseAdapters(): IDatabaseAdapter[];
     getDatabaseAdapter(): IDatabaseAdapter | null;
     setSetting(key: string, value: string | boolean | null | any, secret: boolean): void;
     getSetting(key: string): string | boolean | null | any;
@@ -955,7 +961,7 @@ interface TaskWorker {
     name: string;
     execute: (runtime: IAgentRuntime, options: {
         [key: string]: unknown;
-    }) => Promise<void>;
+    }, task: Task) => Promise<void>;
     validate?: (runtime: IAgentRuntime, message: Memory, state: State) => Promise<boolean>;
 }
 interface Task {
@@ -1011,6 +1017,13 @@ interface OnboardingConfig {
  * @param count - The number of examples to generate.
  * @returns A string containing formatted examples of conversations.
  */
+/**
+ * Compose a specified number of random action examples from the given actionsData.
+ *
+ * @param {Action[]} actionsData - The list of actions to generate examples from.
+ * @param {number} count - The number of examples to compose.
+ * @returns {string} The formatted action examples.
+ */
 declare const composeActionExamples: (actionsData: Action[], count: number) => string;
 /**
  * Formats the names of the provided actions into a comma-separated string.
@@ -1029,11 +1042,23 @@ declare function formatActions(actions: Action[]): string;
  * An abstract class representing a database adapter for managing various entities
  * like entities, memories, entities, goals, and rooms.
  */
+/**
+ * Database adapter class to be extended by individual database adapters.
+ *
+ * @template DB - The type of the database instance.
+ * @abstract
+ * @implements {IDatabaseAdapter}
+ */
 declare abstract class DatabaseAdapter<DB = unknown> implements IDatabaseAdapter {
     /**
      * The database instance.
      */
     db: DB;
+    /**
+     * Initialize the database adapter.
+     * @returns A Promise that resolves when initialization is complete.
+     */
+    abstract init(): Promise<void>;
     /**
      * Optional close method for the database adapter.
      * @returns A Promise that resolves when closing is complete.
@@ -1476,16 +1501,42 @@ declare abstract class DatabaseAdapter<DB = unknown> implements IDatabaseAdapter
     abstract deleteTask(id: UUID): Promise<void>;
 }
 
+/**
+ * Finds an entity by name in the given runtime environment.
+ *
+ * @param {IAgentRuntime} runtime - The agent runtime environment.
+ * @param {Memory} message - The memory message containing relevant information.
+ * @param {State} state - The current state of the system.
+ * @returns {Promise<Entity | null>} A promise that resolves to the found entity or null if not found.
+ */
 declare function findEntityByName(runtime: IAgentRuntime, message: Memory, state: State): Promise<Entity | null>;
+/**
+ * Function to create a unique UUID based on the runtime and base user ID.
+ *
+ * @param {RuntimeContext} runtime - The runtime context object.
+ * @param {UUID|string} baseUserId - The base user ID to use in generating the UUID.
+ * @returns {UUID} - The unique UUID generated based on the runtime and base user ID.
+ */
 declare const createUniqueUuid: (runtime: any, baseUserId: UUID | string) => UUID;
 /**
  * Get details for a list of entities.
  */
+/**
+ * Retrieves entity details for a specific room from the database.
+ *
+ * @param {Object} params - The input parameters
+ * @param {IAgentRuntime} params.runtime - The Agent Runtime instance
+ * @param {UUID} params.roomId - The ID of the room to retrieve entity details for
+ * @returns {Promise<Array>} - A promise that resolves to an array of unique entity details
+ */
 declare function getEntityDetails({ runtime, roomId, }: {
     runtime: IAgentRuntime;
     roomId: UUID;
 }): Promise<any[]>;
 
+/**
+ * Interface for settings object with key-value pairs.
+ */
 interface Settings {
     [key: string]: string | undefined;
 }
@@ -1887,6 +1938,12 @@ declare function validateCharacterConfig(json: unknown): CharacterConfig;
 
 declare const dynamicImport: (specifier: string) => Promise<any>;
 declare const registerDynamicImport: (specifier: string, module: any) => void;
+/**
+ * Handles importing of plugins asynchronously.
+ *
+ * @param {string[]} plugins - An array of strings representing the plugins to import.
+ * @returns {Promise<Function[]>} - A Promise that resolves to an array of imported plugins functions.
+ */
 declare function handlePluginImporting(plugins: string[]): Promise<any[]>;
 
 declare const logger: pino.Logger<string, boolean>;
@@ -1895,6 +1952,9 @@ declare const elizaLogger: pino.Logger<string, boolean>;
 /**
  * Manage memories in the database.
  */
+/**
+ * The AgentRuntime instance associated with this manager.
+ */
 declare class MemoryManager implements IMemoryManager {
     /**
      * The AgentRuntime instance associated with this manager.
@@ -2031,6 +2091,14 @@ declare class MemoryManager implements IMemoryManager {
  * };
  * const contextSimple = composePrompt({ state, template });
  */
+/**
+ * Function to compose a prompt using a provided template and state.
+ *
+ * @param {Object} options - Object containing state and template information.
+ * @param {State} options.state - The state object containing values to fill the template.
+ * @param {TemplateType} options.template - The template to be used for composing the prompt.
+ * @returns {string} The composed prompt output.
+ */
 declare const composePrompt: ({ state, template, }: {
     state: State;
     template: TemplateType;
@@ -2093,7 +2161,7 @@ declare const formatMessages: ({ messages, entities, }: {
     entities: Entity[];
 }) => string;
 declare const formatTimestamp: (messageDate: number) => string;
-declare const shouldRespondTemplate = "# Task: Decide on behalf of {{agentName}} whether they should respond to the message, ignore it or stop the conversation.\n{{providers}}\n# Instructions: Decide if {{agentName}} should respond to or interact with the conversation.\nIf the message is directed at or relevant to {{agentName}}, respond with RESPOND action.\nIf a user asks {{agentName}} to be quiet, respond with STOP action.\nIf {{agentName}} should ignore the message, respond with IGNORE action.\nIf responding with the RESPOND action, include a list of optional providers that could be relevant to the response.\nResponse format should be formatted in a valid JSON block like this:\n```json\n{\n    \"name\": \"{{agentName}}\",\n    \"action\": \"RESPOND\" | \"IGNORE\" | \"STOP\",\n    \"providers\": [\"<string>\", \"<string>\", ...]\n}\n```\nYour response should include the valid JSON block and nothing else.";
+declare const shouldRespondTemplate = "# Task: Decide on behalf of {{agentName}} whether they should respond to the message, ignore it or stop the conversation.\n{{providers}}\n# Instructions: Decide if {{agentName}} should respond to or interact with the conversation.\nIf the message is directed at or relevant to {{agentName}}, respond with RESPOND action.\nIf a user asks {{agentName}} to be quiet, respond with STOP action.\nIf {{agentName}} should ignore the message, respond with IGNORE action.\nIf responding with the RESPOND action, include a list of optional providers that could be relevant to the response.\nResponse format should be formatted in a valid JSON block like this:\n```json\n{\n    \"name\": \"{{agentName}}\",\n\t\"reasoning\": \"<string>\",\n    \"action\": \"RESPOND\" | \"IGNORE\" | \"STOP\",\n    \"providers\": [\"<string>\", \"<string>\", ...]\n}\n```\nYour response should include the valid JSON block and nothing else.";
 declare const messageHandlerTemplate = "# Task: Generate dialog and actions for the character {{agentName}}.\n{{providers}}\n# Instructions: Write a thought and plan for {{agentName}} and decide what actions to take. Also include the providers that {{agentName}} will use to have the right context for responding and acting, if any.\nFirst, think about what you want to do next and plan your actions. Then, write the next message and include the actions you plan to take.\n\"thought\" should be a short description of what the agent is thinking about and planning.\n\"actions\" should be an array of the actions {{agentName}} plans to take based on the thought (if none, use IGNORE, if simply responding with text, use REPLY)\n\"providers\" should be an optional array of the providers that {{agentName}} will use to have the right context for responding and acting\n\"evaluators\" should be an optional array of the evaluators that {{agentName}} will use to evaluate the conversation after responding\n\"plan\" should be explanation of the message you plan to send, the actions you plan to take, and the data providers you plan to use.\nThese are the available valid actions: {{actionNames}}\n\nResponse format should be formatted in a valid JSON block like this:\n```json\n{\n    \"thought\": \"<string>\",\n    \"plan\": \"<string>\",\n    \"actions\": [\"<string>\", \"<string>\", ...],\n    \"providers\": [\"<string>\", \"<string>\", ...]\n}\n```\n\nYour response should include the valid JSON block and nothing else.";
 declare const booleanFooter = "Respond with only a YES or a NO.";
 /**
@@ -2180,6 +2248,9 @@ declare function splitChunks(content: string, chunkSize?: number, bleed?: number
  */
 declare function trimTokens(prompt: string, maxTokens: number, runtime: IAgentRuntime): Promise<any>;
 
+/**
+ * Represents the state of server ownership, including a mapping of server IDs to their respective World objects.
+ */
 interface ServerOwnershipState {
     servers: {
         [serverId: string]: World;
@@ -2188,6 +2259,14 @@ interface ServerOwnershipState {
 /**
  * Gets a user's role from world metadata
  */
+/**
+ * Retrieve the server role of a specified user entity within a given server.
+ *
+ * @param {IAgentRuntime} runtime - The runtime object containing necessary configurations and services.
+ * @param {string} entityId - The unique identifier of the user entity.
+ * @param {string} serverId - The unique identifier of the server.
+ * @returns {Promise<Role>} The role of the user entity within the server, resolved as a Promise.
+ */
 declare function getUserServerRole(runtime: IAgentRuntime, entityId: string, serverId: string): Promise<Role>;
 /**
  * Finds a server where the given user is the owner
@@ -2198,6 +2277,19 @@ declare function findWorldForOwner(runtime: IAgentRuntime, entityId: string): Pr
  * Represents the runtime environment for an agent, handling message processing,
  * action registration, and interaction with external services like OpenAI and Supabase.
  */
+/**
+ * Represents the runtime environment for an agent.
+ * @class
+ * @implements { IAgentRuntime }
+ * @property { number } #conversationLength - The maximum length of a conversation.
+ * @property { UUID } agentId - The unique identifier for the agent.
+ * @property { Character } character - The character associated with the agent.
+ * @property { IDatabaseAdapter } databaseAdapter - The adapter for interacting with the database.
+ * @property {Action[]} actions - The list of actions available to the agent.
+ * @property {Evaluator[]} evaluators - The list of evaluators for decision making.
+ * @property {Provider[]} providers - The list of providers for external services.
+ * @property {Plugin[]} plugins - The list of plugins to extend functionality.
+ */
 declare class AgentRuntime implements IAgentRuntime {
     #private;
     readonly agentId: UUID;
@@ -2219,7 +2311,7 @@ declare class AgentRuntime implements IAgentRuntime {
     }>;
     readonly fetch: typeof fetch;
     services: Map<ServiceType, Service>;
-    adapters: IDatabaseAdapter[];
+    adapter: IDatabaseAdapter;
     private readonly knowledgeRoot;
     models: Map<string, ((params: any) => Promise<any>)[]>;
     routes: Route[];
@@ -2231,7 +2323,7 @@ declare class AgentRuntime implements IAgentRuntime {
         plugins?: Plugin[];
         fetch?: typeof fetch;
         databaseAdapter?: IDatabaseAdapter;
-        adapters?: IDatabaseAdapter[];
+        adapter?: IDatabaseAdapter;
         events?: {
             [key: string]: ((params: any) => void)[];
         };
@@ -2262,7 +2354,6 @@ declare class AgentRuntime implements IAgentRuntime {
      */
     getConversationLength(): number;
     registerDatabaseAdapter(adapter: IDatabaseAdapter): void;
-    getDatabaseAdapters(): IDatabaseAdapter[];
     getDatabaseAdapter(): IDatabaseAdapter;
     /**
      * Register a provider for the agent to use.
@@ -2362,7 +2453,20 @@ declare function getWorldSettings(runtime: IAgentRuntime, serverId: string): Pro
 declare function initializeOnboarding(runtime: IAgentRuntime, world: World, config: OnboardingConfig): Promise<WorldSettings | null>;
 
 declare const uuidSchema: z.ZodType<UUID>;
+/**
+ * Validates a UUID value.
+ *
+ * @param {unknown} value - The value to validate.
+ * @returns {UUID | null} Returns the validated UUID value or null if validation fails.
+ */
 declare function validateUuid(value: unknown): UUID | null;
+/**
+ * Converts a string or number to a UUID.
+ *
+ * @param {string | number} target - The string or number to convert to a UUID.
+ * @returns {UUID} The UUID generated from the input target.
+ * @throws {TypeError} Throws an error if the input target is not a string.
+ */
 declare function stringToUuid(target: string | number): UUID;
 
 export { type Action, type ActionExample, type Agent, AgentRuntime, type BaseMetadata, CacheKeyPrefix, type CacheOptions, ChannelType, type Character, type CharacterConfig, CharacterSchema, type ChunkRow, type Component, type Content, type ConversationExample, type CustomMetadata, DatabaseAdapter, type DeriveKeyAttestationData, type DescriptionMetadata, type DetokenizeTextParams, type DirectoryItem, type DocumentMetadata, type Entity, type EvaluationExample, type Evaluator, type FragmentMetadata, type GenerateTextParams, type Goal, GoalStatus, type Handler, type HandlerCallback, type IAgentRuntime, type IBrowserService, type IDatabaseAdapter, type IFileService, type IMemoryManager, type IPdfService, type ITeeLogService, type IVideoService, type KnowledgeItem, KnowledgeScope, type Media, type Memory, MemoryManager, type MemoryMetadata, MemoryType, type MemoryTypeAlias, type MessageExample, MessageExampleSchema, type MessageMetadata, type ModelConfiguration, type ModelType, ModelTypes, type Objective, type OnboardingConfig, type Participant, type Plugin, PluginSchema, type Project, type ProjectAgent, type Provider, type ProviderResult, type Relationship, type RemoteAttestationMessage, type RemoteAttestationQuote, Role, type Room, type Route, type ServerOwnershipState, Service, type ServiceType, ServiceTypes, type Setting, type SgxAttestation, type State, TEEMode, type Task, type TaskWorker, type TeeAgent, type TeeLog, TeeLogDAO, type TeeLogQuery, type TeePageQuery, type TeePluginConfig, TeeType, type TeeVendorConfig, type TemplateType, type TestCase, type TestSuite, type TokenizeTextParams, type UUID, type Validator, type World, type WorldSettings, addHeader, booleanFooter, cleanJsonResponse, composeActionExamples, composePrompt, composeRandomUser, configureSettings, createUniqueUuid, dynamicImport, elizaLogger, extractAttributes, findEntityByName, findNearestEnvFile, findWorldForOwner, formatActionNames, formatActions, formatMessages, formatPosts, formatTimestamp, getEntityDetails, getEnvVariable, getUserServerRole, getWorldSettings, handlePluginImporting, hasEnvVariable, initializeOnboarding, loadEnvConfig, logger, messageHandlerTemplate, normalizeJsonString, parseActionResponseFromText, parseBooleanFromText, parseJSONObjectFromText, parseJsonArrayFromText, postActionResponseFooter, registerDynamicImport, settings, shouldRespondTemplate, splitChunks, stringArrayFooter, stringToUuid, trimTokens, truncateToCompleteSentence, updateWorldSettings, uuidSchema, validateCharacterConfig, validateUuid };