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

package/dist/prompts.d.ts

@@ -1,200 +0,0 @@
-import type { Entity, IAgentRuntime, Memory, State, TemplateType } from "./types";
-/**
- * Composes a context string by replacing placeholders in a template with corresponding values from the state.
- *
- * This function takes a template string with placeholders in the format `{{placeholder}}` and a state object.
- * It replaces each placeholder with the value from the state object that matches the placeholder's name.
- * If a matching key is not found in the state object for a given placeholder, the placeholder is replaced with an empty string.
- *
- * @param {Object} params - The parameters for composing the context.
- * @param {State} params.state - The state object containing values to replace the placeholders in the template.
- * @param {TemplateType} params.template - The template string or function containing placeholders to be replaced with state values.
- * @returns {string} The composed context string with placeholders replaced by corresponding state values.
- *
- * @example
- * // Given a state object and a template
- * const state = { userName: "Alice", userAge: 30 };
- * const template = "Hello, {{userName}}! You are {{userAge}} years old";
- *
- * // Composing the context with simple string replacement will result in:
- * // "Hello, Alice! You are 30 years old."
- * const contextSimple = composePromptFromState({ state, template });
- *
- * // Using composePromptFromState with a template function for dynamic template
- * const template = ({ state }) => {
- * const tone = Math.random() > 0.5 ? "kind" : "rude";
- *   return `Hello, {{userName}}! You are {{userAge}} years old. Be ${tone}`;
- * };
- * const contextSimple = composePromptFromState({ 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.
- */
-export declare const composePrompt: ({ state, template, }: {
-    state: {
-        [key: string]: string;
-    };
-    template: TemplateType;
-}) => string;
-/**
- * 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.
- */
-export declare const composePromptFromState: ({ state, template, }: {
-    state: State;
-    template: TemplateType;
-}) => string;
-/**
- * Adds a header to a body of text.
- *
- * This function takes a header string and a body string and returns a new string with the header prepended to the body.
- * If the body string is empty, the header is returned as is.
- *
- * @param {string} header - The header to add to the body.
- * @param {string} body - The body to which to add the header.
- * @returns {string} The body with the header prepended.
- *
- * @example
- * // Given a header and a body
- * const header = "Header";
- * const body = "Body";
- *
- * // Adding the header to the body will result in:
- * // "Header\nBody"
- * const text = addHeader(header, body);
- */
-export declare const addHeader: (header: string, body: string) => string;
-/**
- * Generates a string with random user names populated in a template.
- *
- * This function generates random user names and populates placeholders
- * in the provided template with these names. Placeholders in the template should follow the format `{{userX}}`
- * where `X` is the position of the user (e.g., `{{name1}}`, `{{name2}}`).
- *
- * @param {string} template - The template string containing placeholders for random user names.
- * @param {number} length - The number of random user names to generate.
- * @returns {string} The template string with placeholders replaced by random user names.
- *
- * @example
- * // Given a template and a length
- * const template = "Hello, {{name1}}! Meet {{name2}} and {{name3}}.";
- * const length = 3;
- *
- * // Composing the random user string will result in:
- * // "Hello, John! Meet Alice and Bob."
- * const result = composeRandomUser(template, length);
- */
-export declare const composeRandomUser: (template: string, length: number) => string;
-export declare const formatPosts: ({ messages, entities, conversationHeader, }: {
-    messages: Memory[];
-    entities: Entity[];
-    conversationHeader?: boolean;
-}) => string;
-/**
- * Format messages into a string
- * @param {Object} params - The formatting parameters
- * @param {Memory[]} params.messages - List of messages to format
- * @param {Entity[]} params.entities - List of entities for name resolution
- * @returns {string} Formatted message string with timestamps and user information
- */
-export declare const formatMessages: ({ messages, entities, }: {
-    messages: Memory[];
-    entities: Entity[];
-}) => string;
-export declare const formatTimestamp: (messageDate: number) => string;
-export 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.";
-export 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.";
-export declare const booleanFooter = "Respond with only a YES or a NO.";
-/**
- * Parses a string to determine its boolean equivalent.
- *
- * Recognized affirmative values: "YES", "Y", "TRUE", "T", "1", "ON", "ENABLE"
- * Recognized negative values: "NO", "N", "FALSE", "F", "0", "OFF", "DISABLE"
- *
- * @param {string | undefined | null} value - The input text to parse
- * @returns {boolean} - Returns `true` for affirmative inputs, `false` for negative or unrecognized inputs
- */
-export declare function parseBooleanFromText(value: string | undefined | null): boolean;
-export declare const stringArrayFooter = "Respond with a JSON array containing the values in a valid JSON block formatted for markdown with this structure:\n```json\n[\n  'value',\n  'value'\n]\n```\n\nYour response must include the valid JSON block.";
-/**
- * Parses a JSON array from a given text. The function looks for a JSON block wrapped in triple backticks
- * with `json` language identifier, and if not found, it searches for an array pattern within the text.
- * It then attempts to parse the JSON string into a JavaScript object. If parsing is successful and the result
- * is an array, it returns the array; otherwise, it returns null.
- *
- * @param text - The input text from which to extract and parse the JSON array.
- * @returns An array parsed from the JSON string if successful; otherwise, null.
- */
-export declare function parseJsonArrayFromText(text: string): any[];
-/**
- * Parses a JSON object from a given text. The function looks for a JSON block wrapped in triple backticks
- * with `json` language identifier, and if not found, it searches for an object pattern within the text.
- * It then attempts to parse the JSON string into a JavaScript object. If parsing is successful and the result
- * is an object (but not an array), it returns the object; otherwise, it tries to parse an array if the result
- * is an array, or returns null if parsing is unsuccessful or the result is neither an object nor an array.
- *
- * @param text - The input text from which to extract and parse the JSON object.
- * @returns An object parsed from the JSON string if successful; otherwise, null or the result of parsing an array.
- */
-export declare function parseJSONObjectFromText(text: string): Record<string, any> | null;
-/**
- * Extracts specific attributes (e.g., user, text, action) from a JSON-like string using regex.
- * @param response - The cleaned string response to extract attributes from.
- * @param attributesToExtract - An array of attribute names to extract.
- * @returns An object containing the extracted attributes.
- */
-export declare function extractAttributes(response: string, attributesToExtract?: string[]): {
-    [key: string]: string | undefined;
-};
-/**
- * Normalizes a JSON-like string by correcting formatting issues:
- * - Removes extra spaces after '{' and before '}'.
- * - Wraps unquoted values in double quotes.
- * - Converts single-quoted values to double-quoted.
- * - Ensures consistency in key-value formatting.
- * - Normalizes mixed adjacent quote pairs.
- *
- * This is useful for cleaning up improperly formatted JSON strings
- * before parsing them into valid JSON.
- *
- * @param str - The JSON-like string to normalize.
- * @returns A properly formatted JSON string.
- */
-export declare const normalizeJsonString: (str: string) => string;
-/**
- * Cleans a JSON-like response string by removing unnecessary markers, line breaks, and extra whitespace.
- * This is useful for handling improperly formatted JSON responses from external sources.
- *
- * @param response - The raw JSON-like string response to clean.
- * @returns The cleaned string, ready for parsing or further processing.
- */
-export declare function cleanJsonResponse(response: string): string;
-export declare const postActionResponseFooter = "Choose any combination of [LIKE], [RETWEET], [QUOTE], and [REPLY] that are appropriate. Each action must be on its own line. Your response must only include the chosen actions.";
-type ActionResponse = {
-    like: boolean;
-    retweet: boolean;
-    quote?: boolean;
-    reply?: boolean;
-};
-export declare const parseActionResponseFromText: (text: string) => {
-    actions: ActionResponse;
-};
-/**
- * Truncate text to fit within the character limit, ensuring it ends at a complete sentence.
- */
-export declare function truncateToCompleteSentence(text: string, maxLength: number): string;
-export declare function splitChunks(content: string, chunkSize?: number, bleed?: number): Promise<string[]>;
-/**
- * Trims the provided text prompt to a specified token limit using a tokenizer model and type.
- */
-export declare function trimTokens(prompt: string, maxTokens: number, runtime: IAgentRuntime): Promise<string>;
-export {};

package/dist/providers/actions.d.ts

@@ -1,14 +0,0 @@
-import type { Provider } from "../types";
-/**
- * A provider object that fetches possible response actions based on the provided runtime, message, and state.
- * @type {Provider}
- * @property {string} name - The name of the provider ("ACTIONS").
- * @property {string} description - The description of the provider ("Possible response actions").
- * @property {number} position - The position of the provider (-1).
- * @property {Function} get - Asynchronous function that retrieves actions that validate for the given message.
- * @param {IAgentRuntime} runtime - The runtime object.
- * @param {Memory} message - The message memory.
- * @param {State} state - The state object.
- * @returns {Object} An object containing the actions data, values, and combined text sections.
- */
-export declare const actionsProvider: Provider;

package/dist/providers/anxiety.d.ts

@@ -1,9 +0,0 @@
-import type { Provider } from "../types";
-/**
- * Represents an anxiety provider that provides examples and guidance for an AI roleplaying as a character.
- * The anxiety provider offers suggestions on how to reduce verbosity and eagerness in responses based on the channel type.
- * Randomly selects and returns three anxiety examples for the AI to follow.
- *
- * @type {Provider}
- */
-export declare const anxietyProvider: Provider;

package/dist/providers/attachments.d.ts

@@ -1,8 +0,0 @@
-import type { Provider } from "../types";
-/**
- * Provides a list of attachments in the current conversation.
- * @param {IAgentRuntime} runtime - The agent runtime object.
- * @param {Memory} message - The message memory object.
- * @returns {Object} The attachments values, data, and text.
- */
-export declare const attachmentsProvider: Provider;

package/dist/providers/capabilities.d.ts

@@ -1,13 +0,0 @@
-import type { Provider } from "../types";
-/**
- * Provider that collects capability descriptions from all registered services
- */
-/**
- * Provides capabilities information for the agent.
- *
- * @param {IAgentRuntime} runtime - The agent runtime instance.
- * @param {Memory} _message - The memory message object.
- * @returns {Promise<ProviderResult>} The provider result object containing capabilities information.
- */
-export declare const capabilitiesProvider: Provider;
-export default capabilitiesProvider;

package/dist/providers/character.d.ts

@@ -1,9 +0,0 @@
-import { type Provider } from "../types";
-/**
- * Character provider object.
- * @typedef {Object} Provider
- * @property {string} name - The name of the provider ("CHARACTER").
- * @property {string} description - Description of the character information.
- * @property {Function} get - Async function to get character information.
- */
-export declare const characterProvider: Provider;

package/dist/providers/choice.d.ts

@@ -1,10 +0,0 @@
-import type { Provider } from "../types";
-/**
- * Choice provider function that retrieves all pending tasks with options for a specific room
- *
- * @param {IAgentRuntime} runtime - The runtime object for the agent
- * @param {Memory} message - The message memory object
- * @returns {Promise<ProviderResult>} A promise that resolves with the provider result containing the pending tasks with options
- */
-export declare const choiceProvider: Provider;
-export default choiceProvider;

package/dist/providers/entities.d.ts

@@ -1,2 +0,0 @@
-import type { Provider } from "../types";
-export declare const entitiesProvider: Provider;

package/dist/providers/evaluators.d.ts

@@ -1,26 +0,0 @@
-import type { Evaluator, Provider } from "../types";
-/**
- * Formats the names of evaluators into a comma-separated list, each enclosed in single quotes.
- * @param evaluators - An array of evaluator objects.
- * @returns A string that concatenates the names of all evaluators, each enclosed in single quotes and separated by commas.
- */
-/**
- * Formats the names of the evaluators in the provided array.
- *
- * @param {Evaluator[]} evaluators - Array of evaluators.
- * @returns {string} - Formatted string of evaluator names.
- */
-export declare function formatEvaluatorNames(evaluators: Evaluator[]): string;
-/**
- * Formats evaluator examples into a readable string, replacing placeholders with generated names.
- * @param evaluators - An array of evaluator objects, each containing examples to format.
- * @returns A string that presents each evaluator example in a structured format, including context, messages, and outcomes, with placeholders replaced by generated names.
- */
-export declare function formatEvaluatorExamples(evaluators: Evaluator[]): string;
-/**
- * Formats evaluator details into a string, including both the name and description of each evaluator.
- * @param evaluators - An array of evaluator objects.
- * @returns A string that concatenates the name and description of each evaluator, separated by a colon and a newline character.
- */
-export declare function formatEvaluators(evaluators: Evaluator[]): string;
-export declare const evaluatorsProvider: Provider;

package/dist/providers/facts.d.ts

@@ -1,10 +0,0 @@
-import { type Provider } from "../types";
-/**
- * Function to get key facts that the agent knows.
- * @param {IAgentRuntime} runtime - The runtime environment for the agent.
- * @param {Memory} message - The message object containing relevant information.
- * @param {State} [_state] - Optional state information.
- * @returns {Object} An object containing values, data, and text related to the key facts.
- */
-declare const factsProvider: Provider;
-export { factsProvider };

package/dist/providers/knowledge.d.ts

@@ -1,13 +0,0 @@
-import type { Provider } from "../types";
-/**
- * Represents a knowledge provider that retrieves knowledge from the knowledge base.
- * @type {Provider}
- * @property {string} name - The name of the knowledge provider.
- * @property {string} description - The description of the knowledge provider.
- * @property {boolean} dynamic - Indicates if the knowledge provider is dynamic or static.
- * @property {Function} get - Asynchronously retrieves knowledge from the knowledge base.
- * @param {IAgentRuntime} runtime - The agent runtime object.
- * @param {Memory} message - The message containing the query for knowledge retrieval.
- * @returns {Object} An object containing the retrieved knowledge data, values, and text.
- */
-export declare const knowledgeProvider: Provider;

package/dist/providers/providers.d.ts

@@ -1,6 +0,0 @@
-import type { Provider } from "../types";
-/**
- * Provider for retrieving list of all data providers available for the agent to use.
- * @type { Provider }
- */
-export declare const providersProvider: Provider;

package/dist/providers/recentMessages.d.ts

@@ -1,13 +0,0 @@
-import { type Provider } from "../types";
-/**
- * A provider object that retrieves recent messages, interactions, and memories based on a given message.
- * @typedef {object} Provider
- * @property {string} name - The name of the provider ("RECENT_MESSAGES").
- * @property {string} description - A description of the provider's purpose ("Recent messages, interactions and other memories").
- * @property {number} position - The position of the provider (100).
- * @property {Function} get - Asynchronous function that retrieves recent messages, interactions, and memories.
- * @param {IAgentRuntime} runtime - The runtime context for the agent.
- * @param {Memory} message - The message to retrieve data from.
- * @returns {object} An object containing data, values, and text sections.
- */
-export declare const recentMessagesProvider: Provider;

package/dist/providers/relationships.d.ts

@@ -1,14 +0,0 @@
-import type { Provider } from "../types";
-/**
- * Provider for fetching relationships data.
- *
- * @type {Provider}
- * @property {string} name - The name of the provider ("RELATIONSHIPS").
- * @property {string} description - Description of the provider.
- * @property {Function} get - Asynchronous function to fetch relationships data.
- * @param {IAgentRuntime} runtime - The agent runtime object.
- * @param {Memory} message - The message object containing entity ID.
- * @returns {Promise<Object>} Object containing relationships data or error message.
- */
-declare const relationshipsProvider: Provider;
-export { relationshipsProvider };

package/dist/providers/roles.d.ts

@@ -1,14 +0,0 @@
-import { type Provider } from "../types";
-/**
- * Role provider that retrieves roles in the server based on the provided runtime, message, and state.
- * * @type { Provider }
- * @property { string } name - The name of the role provider.
- * @property { string } description - A brief description of the role provider.
- * @property { Function } get - Asynchronous function that retrieves and processes roles in the server.
- * @param { IAgentRuntime } runtime - The agent runtime object.
- * @param { Memory } message - The message memory object.
- * @param { State } state - The state object.
- * @returns {Promise<ProviderResult>} The result containing roles data, values, and text.
- */
-export declare const roleProvider: Provider;
-export default roleProvider;

package/dist/providers/settings.d.ts

@@ -1,6 +0,0 @@
-import { type Provider } from "../types";
-/**
- * Creates an settings provider with the given configuration
- * Updated to use world metadata instead of cache
- */
-export declare const settingsProvider: Provider;

package/dist/providers/shouldRespond.d.ts

@@ -1,6 +0,0 @@
-import type { Provider } from "../types";
-/**
- * Represents a provider that generates response examples for the agent.
- * @type {Provider}
- */
-export declare const shouldRespondProvider: Provider;

package/dist/providers/time.d.ts

@@ -1,11 +0,0 @@
-import type { Provider } from "../types";
-/**
- * Time provider function that retrieves the current date and time in UTC
- * for use in time-based operations or responses.
- *
- * @param _runtime - The runtime environment of the bot agent.
- * @param _message - The memory object containing message data.
- * @returns An object containing the current date and time data, human-readable date and time string,
- * and a text response with the current date and time information.
- */
-export declare const timeProvider: Provider;

package/dist/roles.d.ts

@@ -1,25 +0,0 @@
-import { type IAgentRuntime, Role, type World } from "./types";
-/**
- * Represents the state of server ownership, including a mapping of server IDs to their respective World objects.
- */
-export interface ServerOwnershipState {
-    servers: {
-        [serverId: string]: World;
-    };
-}
-/**
- * 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.
- */
-export declare function getUserServerRole(runtime: IAgentRuntime, entityId: string, serverId: string): Promise<Role>;
-/**
- * Finds a server where the given user is the owner
- */
-export declare function findWorldForOwner(runtime: IAgentRuntime, entityId: string): Promise<World | null>;