@elizaos/core 1.0.0-alpha.21 → 1.0.0-alpha.23

package/dist/actions/choice.d.ts

@@ -0,0 +1,14 @@
+import { type Action } from "../types";
+/**
+ * Represents an action that allows selecting an option for a pending task that has multiple options.
+ * @type {Action}
+ * @property {string} name - The name of the action
+ * @property {string[]} similes - Similar words or phrases for the action
+ * @property {string} description - A brief description of the action
+ * @property {Function} validate - Asynchronous function to validate the action
+ * @property {Function} handler - Asynchronous function to handle the action
+ * @property {ActionExample[][]} examples - Examples demonstrating the usage of the action
+ */
+export declare const choiceAction: Action;
+export default choiceAction;
+//# sourceMappingURL=choice.d.ts.map

package/dist/actions/choice.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"choice.d.ts","sourceRoot":"","sources":["../../src/actions/choice.ts"],"names":[],"mappings":"AAGA,OAAO,EACN,KAAK,MAAM,EAOX,MAAM,UAAU,CAAC;AAkElB;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY,EAAE,MAwO1B,CAAC;AAEF,eAAe,YAAY,CAAC"}

package/dist/actions/followRoom.d.ts

@@ -0,0 +1,21 @@
+import { type Action } from "../types";
+/**
+ * Template for deciding if {{agentName}} should start following a room.
+ * The decision is based on various criteria, including recent messages and user interactions.
+ * Respond with YES if:
+ * - The user has directly asked {{agentName}} to follow the conversation
+ * - The conversation topic is engaging and {{agentName}}'s input would add value
+ * - {{agentName}} has unique insights to contribute and users seem receptive
+ * Otherwise, respond with NO.
+ */
+export declare const shouldFollowTemplate = "# Task: Decide if {{agentName}} should start following this room, i.e. eagerly participating without explicit mentions.\n\n{{recentMessages}}\n\nShould {{agentName}} start following this room, eagerly participating without explicit mentions?\nRespond with YES if:\n- The user has directly asked {{agentName}} to follow the conversation or participate more actively\n- The conversation topic is highly engaging and {{agentName}}'s input would add significant value\n- {{agentName}} has unique insights to contribute and the users seem receptive\n\nOtherwise, respond with NO.\nRespond with only a YES or a NO.";
+/**
+ * Action for following a room with great interest.
+ * Similes: FOLLOW_CHAT, FOLLOW_CHANNEL, FOLLOW_CONVERSATION, FOLLOW_THREAD
+ * Description: Start following this channel with great interest, chiming in without needing to be explicitly mentioned. Only do this if explicitly asked to.
+ * @param {IAgentRuntime} runtime - The current agent runtime.
+ * @param {Memory} message - The message memory.
+ * @returns {Promise<boolean>} - Promise that resolves to a boolean indicating if the room should be followed.
+ */
+export declare const followRoomAction: Action;
+//# sourceMappingURL=followRoom.d.ts.map

package/dist/actions/followRoom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"followRoom.d.ts","sourceRoot":"","sources":["../../src/actions/followRoom.ts"],"names":[],"mappings":"AAGA,OAAO,EACN,KAAK,MAAM,EAOX,MAAM,UAAU,CAAC;AAElB;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB,qmBAWhB,CAAC;AAElB;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAgZpB,CAAC"}

package/dist/actions/ignore.d.ts

@@ -0,0 +1,14 @@
+import type { Action } from "../types";
+/**
+ * Action representing the IGNORE action. This action is used when ignoring the user in a conversation.
+ *
+ * @type {Action}
+ * @property {string} name - The name of the action, which is "IGNORE".
+ * @property {string[]} similes - An array of related similes for the action.
+ * @property {Function} validate - Asynchronous function that validates the action.
+ * @property {string} description - Description of when to use the IGNORE action in a conversation.
+ * @property {Function} handler - Asynchronous function that handles the action logic.
+ * @property {ActionExample[][]} examples - Array of examples demonstrating the usage of the IGNORE action.
+ */
+export declare const ignoreAction: Action;
+//# sourceMappingURL=ignore.d.ts.map

package/dist/actions/ignore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ignore.d.ts","sourceRoot":"","sources":["../../src/actions/ignore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAwC,MAAM,UAAU,CAAC;AAE7E;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,EAAE,MA+NhB,CAAC"}

package/dist/actions/muteRoom.d.ts

@@ -0,0 +1,23 @@
+import { type Action } from "../types";
+/**
+ * Template string for deciding if the agent should mute a room and stop responding unless explicitly mentioned.
+ *
+ * @type {string}
+ */
+export declare const shouldMuteTemplate = "# Task: Decide if {{agentName}} should mute this room and stop responding unless explicitly mentioned.\n\n{{recentMessages}}\n\nShould {{agentName}} mute this room and stop responding unless explicitly mentioned?\n\nRespond with YES if:\n- The user is being aggressive, rude, or inappropriate\n- The user has directly asked {{agentName}} to stop responding or be quiet\n- {{agentName}}'s responses are not well-received or are annoying the user(s)\n\nOtherwise, respond with NO.\nRespond with only a YES or a NO.";
+/**
+ * Action for muting a room, ignoring all messages unless explicitly mentioned.
+ * Only do this if explicitly asked to, or if you're annoying people.
+ *
+ * @name MUTE_ROOM
+ * @type {Action}
+ *
+ * @property {string} name - The name of the action
+ * @property {string[]} similes - Similar actions related to muting a room
+ * @property {string} description - Description of the action
+ * @property {Function} validate - Validation function to check if the room is not already muted
+ * @property {Function} handler - Handler function to handle muting the room
+ * @property {ActionExample[][]} examples - Examples of using the action
+ */
+export declare const muteRoomAction: Action;
+//# sourceMappingURL=muteRoom.d.ts.map

package/dist/actions/muteRoom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"muteRoom.d.ts","sourceRoot":"","sources":["../../src/actions/muteRoom.ts"],"names":[],"mappings":"AAGA,OAAO,EACN,KAAK,MAAM,EAOX,MAAM,UAAU,CAAC;AAElB;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,qgBAYd,CAAC;AAElB;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,cAAc,EAAE,MA6NlB,CAAC"}

package/dist/actions/none.d.ts

@@ -0,0 +1,10 @@
+import type { Action } from "../types";
+/**
+ * Represents the none action.
+ *
+ * This action responds but performs no additional action. It is the default if the agent is speaking and not doing anything additional.
+ *
+ * @type {Action}
+ */
+export declare const noneAction: Action;
+//# sourceMappingURL=none.d.ts.map

package/dist/actions/none.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"none.d.ts","sourceRoot":"","sources":["../../src/actions/none.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAwC,MAAM,UAAU,CAAC;AAE7E;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,EAAE,MAyId,CAAC"}

package/dist/actions/reply.d.ts

@@ -0,0 +1,16 @@
+import { type Action } from "../types";
+/**
+ * Represents an action that allows the agent to reply to the current conversation with a generated message.
+ *
+ * This action can be used as an acknowledgement at the beginning of a chain of actions, or as a final response at the end of a chain of actions.
+ *
+ * @typedef {Object} replyAction
+ * @property {string} name - The name of the action ("REPLY").
+ * @property {string[]} similes - An array of similes for the action.
+ * @property {string} description - A description of the action and its usage.
+ * @property {Function} validate - An asynchronous function for validating the action runtime.
+ * @property {Function} handler - An asynchronous function for handling the action logic.
+ * @property {ActionExample[][]} examples - An array of example scenarios for the action.
+ */
+export declare const replyAction: Action;
+//# sourceMappingURL=reply.d.ts.map

package/dist/actions/reply.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reply.d.ts","sourceRoot":"","sources":["../../src/actions/reply.ts"],"names":[],"mappings":"AACA,OAAO,EACN,KAAK,MAAM,EAQX,MAAM,UAAU,CAAC;AA0BlB;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,WAAW,EAqGnB,MAAM,CAAC"}

package/dist/actions/roles.d.ts

@@ -0,0 +1,14 @@
+import { type Action } from "../types";
+/**
+ * Represents an action to update the role of a user within a server.
+ * @typedef {Object} Action
+ * @property {string} name - The name of the action.
+ * @property {string[]} similes - The similar actions that can be performed.
+ * @property {string} description - A description of the action and its purpose.
+ * @property {Function} validate - A function to validate the action before execution.
+ * @property {Function} handler - A function to handle the execution of the action.
+ * @property {ActionExample[][]} examples - Examples demonstrating how the action can be used.
+ */
+declare const updateRoleAction: Action;
+export default updateRoleAction;
+//# sourceMappingURL=roles.d.ts.map

package/dist/actions/roles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roles.d.ts","sourceRoot":"","sources":["../../src/actions/roles.ts"],"names":[],"mappings":"AAIA,OAAO,EACN,KAAK,MAAM,EAWX,MAAM,UAAU,CAAC;AAgFlB;;;;;;;;;GASG;AACH,QAAA,MAAM,gBAAgB,EAAE,MAoOvB,CAAC;AAEF,eAAe,gBAAgB,CAAC"}

package/dist/actions/sendMessage.d.ts

@@ -0,0 +1,15 @@
+import { type Action } from "../types";
+/**
+ * Represents an action to send a message to a user or room.
+ *
+ * @typedef {Action} sendMessageAction
+ * @property {string} name - The name of the action.
+ * @property {string[]} similes - Additional names for the action.
+ * @property {string} description - Description of the action.
+ * @property {function} validate - Asynchronous function to validate if the action can be executed.
+ * @property {function} handler - Asynchronous function to handle the action execution.
+ * @property {ActionExample[][]} examples - Examples demonstrating the usage of the action.
+ */
+export declare const sendMessageAction: Action;
+export default sendMessageAction;
+//# sourceMappingURL=sendMessage.d.ts.map

package/dist/actions/sendMessage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendMessage.d.ts","sourceRoot":"","sources":["../../src/actions/sendMessage.ts"],"names":[],"mappings":"AAMA,OAAO,EACN,KAAK,MAAM,EAOX,MAAM,UAAU,CAAC;AA2FlB;;;;;;;;;;GAUG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAsP/B,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/dist/actions/settings.d.ts

@@ -0,0 +1,22 @@
+import { type Action, type IAgentRuntime, type WorldSettings } from "../types";
+/**
+ * Gets settings state from world metadata
+ */
+/**
+ * Retrieves the settings for a specific world from the database.
+ * @param {IAgentRuntime} runtime - The Agent Runtime instance.
+ * @param {string} serverId - The ID of the server.
+ * @returns {Promise<WorldSettings | null>} The settings of the world, or null if not found.
+ */
+export declare function getWorldSettings(runtime: IAgentRuntime, serverId: string): Promise<WorldSettings | null>;
+/**
+ * Updates settings state in world metadata
+ */
+export declare function updateWorldSettings(runtime: IAgentRuntime, serverId: string, worldSettings: WorldSettings): Promise<boolean>;
+/**
+ * Enhanced settings action with improved state management and logging
+ * Updated to use world metadata instead of cache
+ */
+declare const updateSettingsAction: Action;
+export default updateSettingsAction;
+//# sourceMappingURL=settings.d.ts.map

package/dist/actions/settings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../src/actions/settings.ts"],"names":[],"mappings":"AASA,OAAO,EACN,KAAK,MAAM,EAKX,KAAK,aAAa,EAMlB,KAAK,aAAa,EAClB,MAAM,UAAU,CAAC;AAgNlB;;GAEG;AACH;;;;;GAKG;AACH,wBAAsB,gBAAgB,CACrC,OAAO,EAAE,aAAa,EACtB,QAAQ,EAAE,MAAM,GACd,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAc/B;AAED;;GAEG;AACH,wBAAsB,mBAAmB,CACxC,OAAO,EAAE,aAAa,EACtB,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,aAAa,GAC1B,OAAO,CAAC,OAAO,CAAC,CA0BlB;AA+XD;;;GAGG;AACH,QAAA,MAAM,oBAAoB,EAAE,MAiT3B,CAAC;AAEF,eAAe,oBAAoB,CAAC"}

package/dist/actions/unfollowRoom.d.ts

@@ -0,0 +1,13 @@
+import { type Action } from "../types";
+/**
+ * Action for unfollowing a room.
+ *
+ * - Name: UNFOLLOW_ROOM
+ * - Similes: ["UNFOLLOW_CHAT", "UNFOLLOW_CONVERSATION", "UNFOLLOW_ROOM", "UNFOLLOW_THREAD"]
+ * - Description: Stop following this channel. You can still respond if explicitly mentioned, but you won't automatically chime in anymore. Unfollow if you're annoying people or have been asked to.
+ * - Validate function checks if the room state is "FOLLOWED".
+ * - Handler function handles the unfollowing logic based on user input.
+ * - Examples provide sample interactions for unfollowing a room.
+ */
+export declare const unfollowRoomAction: Action;
+//# sourceMappingURL=unfollowRoom.d.ts.map

package/dist/actions/unfollowRoom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unfollowRoom.d.ts","sourceRoot":"","sources":["../../src/actions/unfollowRoom.ts"],"names":[],"mappings":"AAEA,OAAO,EACN,KAAK,MAAM,EAOX,MAAM,UAAU,CAAC;AAoBlB;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB,EAAE,MA+TtB,CAAC"}

package/dist/actions/unmuteRoom.d.ts

@@ -0,0 +1,19 @@
+import { type Action } from "../types";
+/**
+ * Template for determining if an agent should unmute a previously muted room.
+ * * @type { string }
+ */
+export declare const shouldUnmuteTemplate = "# Task: Decide if {{agentName}} should unmute this previously muted room and start considering it for responses again.\n\n{{recentMessages}}\n\nShould {{agentName}} unmute this previously muted room and start considering it for responses again?\nRespond with YES if:\n- The user has explicitly asked {{agentName}} to start responding again\n- The user seems to want to re-engage with {{agentName}} in a respectful manner\n- The tone of the conversation has improved and {{agentName}}'s input would be welcome\n\nOtherwise, respond with NO.\nRespond with only a YES or a NO.";
+/**
+ * Action to unmute a room, allowing the agent to consider responding to messages again.
+ *
+ * @name UNMUTE_ROOM
+ * @similes ["UNMUTE_CHAT", "UNMUTE_CONVERSATION", "UNMUTE_ROOM", "UNMUTE_THREAD"]
+ * @description Unmutes a room, allowing the agent to consider responding to messages again.
+ *
+ * @param {IAgentRuntime} runtime - The agent runtime to access runtime functionalities.
+ * @param {Memory} message - The message containing information about the room.
+ * @returns {Promise<boolean>} A boolean value indicating if the room was successfully unmuted.
+ */
+export declare const unmuteRoomAction: Action;
+//# sourceMappingURL=unmuteRoom.d.ts.map

package/dist/actions/unmuteRoom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unmuteRoom.d.ts","sourceRoot":"","sources":["../../src/actions/unmuteRoom.ts"],"names":[],"mappings":"AAGA,OAAO,EACN,KAAK,MAAM,EAOX,MAAM,UAAU,CAAC;AAElB;;;GAGG;AACH,eAAO,MAAM,oBAAoB,kkBAWhB,CAAC;AAElB;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB,EAAE,MAwMpB,CAAC"}

package/dist/actions/updateEntity.d.ts

@@ -0,0 +1,43 @@
+import { type Action } from "../types";
+/**
+ * Action for updating contact details for a user entity.
+ *
+ * @name UPDATE_ENTITY
+ * @description Add or edit contact details for a user entity (like twitter, discord, email address, etc.)
+ *
+ * @param {IAgentRuntime} _runtime - The runtime environment.
+ * @param {Memory} _message - The message data.
+ * @param {State} _state - The current state.
+ * @returns {Promise<boolean>} Returns a promise indicating if validation was successful.
+ *
+ * @param {IAgentRuntime} runtime - The runtime environment.
+ * @param {Memory} message - The message data.
+ * @param {State} state - The current state.
+ * @param {any} _options - Additional options.
+ * @param {HandlerCallback} callback - The callback function.
+ * @param {Memory[]} responses - Array of responses.
+ * @returns {Promise<void>} Promise that resolves after handling the update entity action.
+ *
+ * @example
+ * [
+ *    [
+ *      {
+ *        name: "{{name1}}",
+ *        content: {
+ *          text: "Please update my telegram username to @dev_guru",
+ *        },
+ *      },
+ *      {
+ *        name: "{{name2}}",
+ *        content: {
+ *          text: "I've updated your telegram information.",
+ *          actions: ["UPDATE_ENTITY"],
+ *        },
+ *      },
+ *    ],
+ *    ...
+ * ]
+ */
+export declare const updateEntityAction: Action;
+export default updateEntityAction;
+//# sourceMappingURL=updateEntity.d.ts.map

package/dist/actions/updateEntity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateEntity.d.ts","sourceRoot":"","sources":["../../src/actions/updateEntity.ts"],"names":[],"mappings":"AAYA,OAAO,EACN,KAAK,MAAM,EAQX,MAAM,UAAU,CAAC;AA+DlB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,eAAO,MAAM,kBAAkB,EAAE,MAmMhC,CAAC;AAEF,eAAe,kBAAkB,CAAC"}

package/dist/actions.d.ts

@@ -0,0 +1,29 @@
+import type { Action } from "./types";
+/**
+ * Composes a set of example conversations based on provided actions and a specified count.
+ * It randomly selects examples from the provided actions and formats them with generated names.
+ * @param actionsData - An array of `Action` objects from which to draw examples.
+ * @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.
+ */
+export declare const composeActionExamples: (actionsData: Action[], count: number) => string;
+/**
+ * Formats the names of the provided actions into a comma-separated string.
+ * @param actions - An array of `Action` objects from which to extract names.
+ * @returns A comma-separated string of action names.
+ */
+export declare function formatActionNames(actions: Action[]): string;
+/**
+ * Formats the provided actions into a detailed string listing each action's name and description, separated by commas and newlines.
+ * @param actions - An array of `Action` objects to format.
+ * @returns A detailed string of actions, including names and descriptions.
+ */
+export declare function formatActions(actions: Action[]): string;
+//# sourceMappingURL=actions.d.ts.map

package/dist/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../src/actions.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAiB,MAAM,SAAS,CAAC;AAErD;;;;;;GAMG;AACH;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,GAAI,aAAa,MAAM,EAAE,EAAE,OAAO,MAAM,WA2CzE,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,UAKlD;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,UAK9C"}

package/dist/bootstrap.d.ts

@@ -0,0 +1,4 @@
+import { type Plugin } from "./types";
+export declare const bootstrapPlugin: Plugin;
+export default bootstrapPlugin;
+//# sourceMappingURL=bootstrap.d.ts.map

package/dist/bootstrap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bootstrap.d.ts","sourceRoot":"","sources":["../src/bootstrap.ts"],"names":[],"mappings":"AAyCA,OAAO,EAaN,KAAK,MAAM,EAIX,MAAM,SAAS,CAAC;AAstBjB,eAAO,MAAM,eAAe,EAAE,MAsC7B,CAAC;AAEF,eAAe,eAAe,CAAC"}