@elizaos/core 1.0.1 → 1.0.3

package/dist/settings.d.ts

@@ -1,91 +0,0 @@
-import type { Character, IAgentRuntime, OnboardingConfig, Setting, World, WorldSettings } from './types';
-/**
- * Creates a new Setting object based on provided config settings.
- * @param {Omit<Setting, "value">} configSetting - The configuration settings for the new Setting object.
- * @returns {Setting} - The newly created Setting object.
- */
-/**
- * Creates a Setting object from a configSetting object by omitting the 'value' property.
- *
- * @param {Omit<Setting, 'value'>} configSetting - The configSetting object to create the Setting from.
- * @returns {Setting} A new Setting object created from the provided configSetting object.
- */
-export declare function createSettingFromConfig(configSetting: Omit<Setting, 'value'>): Setting;
-/**
- * Retrieves the salt based on env variable SECRET_SALT
- *
- * @returns {string} The salt for the agent.
- */
-export declare function getSalt(): string;
-/**
- * Common encryption function for string values
- * @param {string} value - The string value to encrypt
- * @param {string} salt - The salt to use for encryption
- * @returns {string} - The encrypted value in 'iv:encrypted' format
- */
-export declare function encryptStringValue(value: string, salt: string): string;
-/**
- * Common decryption function for string values
- * @param {string} value - The encrypted value in 'iv:encrypted' format
- * @param {string} salt - The salt to use for decryption
- * @returns {string} - The decrypted string value
- */
-export declare function decryptStringValue(value: string, salt: string): string;
-/**
- * Applies salt to the value of a setting
- * Only applies to secret settings with string values
- */
-export declare function saltSettingValue(setting: Setting, salt: string): Setting;
-/**
- * Removes salt from the value of a setting
- * Only applies to secret settings with string values
- */
-export declare function unsaltSettingValue(setting: Setting, salt: string): Setting;
-/**
- * Applies salt to all settings in a WorldSettings object
- */
-export declare function saltWorldSettings(worldSettings: WorldSettings, salt: string): WorldSettings;
-/**
- * Removes salt from all settings in a WorldSettings object
- */
-export declare function unsaltWorldSettings(worldSettings: WorldSettings, salt: string): WorldSettings;
-/**
- * Updates settings state in world metadata
- */
-export declare function updateWorldSettings(runtime: IAgentRuntime, serverId: string, worldSettings: WorldSettings): Promise<boolean>;
-/**
- * Gets settings state from world metadata
- */
-export declare function getWorldSettings(runtime: IAgentRuntime, serverId: string): Promise<WorldSettings | null>;
-/**
- * Initializes settings configuration for a server
- */
-export declare function initializeOnboarding(runtime: IAgentRuntime, world: World, config: OnboardingConfig): Promise<WorldSettings | null>;
-/**
- * Encrypts sensitive data in a Character object
- * @param {Character} character - The character object to encrypt secrets for
- * @returns {Character} - A copy of the character with encrypted secrets
- */
-export declare function encryptedCharacter(character: Character): Character;
-/**
- * Decrypts sensitive data in a Character object
- * @param {Character} character - The character object with encrypted secrets
- * @param {IAgentRuntime} runtime - The runtime information needed for salt generation
- * @returns {Character} - A copy of the character with decrypted secrets
- */
-export declare function decryptedCharacter(character: Character, runtime: IAgentRuntime): Character;
-/**
- * Helper function to encrypt all string values in an object
- * @param {Record<string, any>} obj - Object with values to encrypt
- * @param {string} salt - The salt to use for encryption
- * @returns {Record<string, any>} - Object with encrypted values
- */
-export declare function encryptObjectValues(obj: Record<string, any>, salt: string): Record<string, any>;
-/**
- * Helper function to decrypt all string values in an object
- * @param {Record<string, any>} obj - Object with encrypted values
- * @param {string} salt - The salt to use for decryption
- * @returns {Record<string, any>} - Object with decrypted values
- */
-export declare function decryptObjectValues(obj: Record<string, any>, salt: string): Record<string, any>;
-export { decryptStringValue as decryptSecret };

package/dist/test_resources/constants.d.ts

@@ -1,9 +0,0 @@
-import type { UUID } from '@elizaos/core';
-export declare const SERVER_URL = "http://localhost:7998";
-export declare const SUPABASE_URL = "https://pronvzrzfwsptkojvudd.supabase.co";
-export declare const SUPABASE_ANON_KEY = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6InByb252enJ6ZndzcHRrb2p2dWRkIiwicm9sZSI6ImFub24iLCJpYXQiOjE3MDY4NTYwNDcsImV4cCI6MjAyMjQzMjA0N30.I6_-XrqssUb2SWYg5DjsUqSodNS3_RPoET3-aPdqywM";
-export declare const TEST_EMAIL = "testuser123@gmail.com";
-export declare const TEST_PASSWORD = "testuser123@gmail.com";
-export declare const TEST_EMAIL_2 = "testuser234@gmail.com";
-export declare const TEST_PASSWORD_2 = "testuser234@gmail.com";
-export declare const zeroUuid: UUID;

package/dist/test_resources/testSetup.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/test_resources/types.d.ts

@@ -1,22 +0,0 @@
-/**
- * Interface representing a User.
- * @typedef {Object} User
- * @property {string} id - The user's ID.
- * @property {string} [email] - The user's email (optional).
- * @property {string} [phone] - The user's phone number (optional).
- * @property {string} [role] - The user's role (optional).
- */
-/**
- * Represents a User with optional properties.
- * @typedef {Object} User
- * @property {string} id - The unique identifier for the user.
- * @property {string} [email] - The email address of the user (optional).
- * @property {string} [phone] - The phone number of the user (optional).
- * @property {string} [role] - The role of the user (optional).
- */
-export interface User {
-    id: string;
-    email?: string;
-    phone?: string;
-    role?: string;
-}

package/dist/utils.d.ts

@@ -1,192 +0,0 @@
-import { Buffer } from 'buffer';
-import type { Entity, IAgentRuntime, Memory, State, TemplateType } from './types';
-import { UUID } from './types';
-declare const Readable: any;
-/**
- * Generates a WAV file header based on the provided audio parameters.
- * @param {number} audioLength - The length of the audio data in bytes.
- * @param {number} sampleRate - The sample rate of the audio.
- * @param {number} [channelCount=1] - The number of channels (default is 1).
- * @param {number} [bitsPerSample=16] - The number of bits per sample (default is 16).
- * @returns {Buffer} The WAV file header as a Buffer object.
- */
-declare function getWavHeader(audioLength: number, sampleRate: number, channelCount?: number, bitsPerSample?: number): Buffer;
-/**
- * Prepends a WAV header to a readable stream of audio data.
- *
- * @param {Readable} readable - The readable stream containing the audio data.
- * @param {number} audioLength - The length of the audio data in seconds.
- * @param {number} sampleRate - The sample rate of the audio data.
- * @param {number} [channelCount=1] - The number of channels in the audio data (default is 1).
- * @param {number} [bitsPerSample=16] - The number of bits per sample in the audio data (default is 16).
- * @returns {Readable} A new readable stream with the WAV header prepended to the audio data.
- */
-declare function prependWavHeader(readable: typeof Readable, audioLength: number, sampleRate: number, channelCount?: number, bitsPerSample?: number): typeof Readable;
-export { getWavHeader, prependWavHeader };
-/**
- * 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.
- * It compiles the template (upgrading double braces to triple braces for non-HTML escaping)
- * and then populates it with values from the state. Additionally, it processes the
- * resulting string with `composeRandomUser` to replace placeholders like `{{nameX}}`.
- *
- * @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 string or function to be used for composing the prompt.
- * @returns {string} The composed prompt output, with state values and random user names populated.
- */
-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;
-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;
-/**
- * Parses key-value pairs from a simple XML structure within a given text.
- * It looks for an XML block (e.g., <response>...</response>) and extracts
- * text content from direct child elements (e.g., <key>value</key>).
- *
- * Note: This uses regex and is suitable for simple, predictable XML structures.
- * For complex XML, a proper parsing library is recommended.
- *
- * @param text - The input text containing the XML structure.
- * @returns An object with key-value pairs extracted from the XML, or null if parsing fails.
- */
-export declare function parseKeyValueXml(text: string): Record<string, any> | null;
-/**
- * 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;
-/**
- * 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;
-/**
- * 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 declare function safeReplacer(): (key: string, value: any) => any;
-/**
- * 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;
-/**
- * Validates a UUID value.
- *
- * @param {unknown} value - The value to validate.
- * @returns {UUID | null} Returns the validated UUID value or null if validation fails.
- */
-export 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.
- */
-export declare function stringToUuid(target: string | number): UUID;