@elizaos/core 2.0.0-alpha.2 → 2.0.0-alpha.21

package/dist/types/components.d.ts

@@ -1,290 +0,0 @@
-import type { Memory } from "./memory";
-import type { Content } from "./primitives";
-import type { JsonValue, ActionExample as ProtoActionExample, ActionParameter as ProtoActionParameter, ActionParameterSchema as ProtoActionParameterSchema, ActionParameters as ProtoActionParametersType, EvaluationExample as ProtoEvaluationExample } from "./proto.js";
-import type { IAgentRuntime } from "./runtime";
-import type { ActionPlan, State } from "./state";
-/**
- * JSON Schema type for action parameter validation.
- * Supports basic JSON Schema properties for parameter definition.
- */
-export interface ActionParameterSchema extends Omit<ProtoActionParameterSchema, "$typeName" | "$unknown" | "defaultValue" | "properties" | "items" | "enumValues"> {
-    /** Default value if parameter is not provided */
-    default?: JsonValue | null;
-    /** For object types, define nested properties */
-    properties?: Record<string, ActionParameterSchema>;
-    /** For array types, define the item schema */
-    items?: ActionParameterSchema;
-    /** Enumerated allowed values (schema-compatible) */
-    enumValues?: string[];
-    /** Enumerated allowed values */
-    enum?: string[];
-}
-/**
- * Defines a single parameter for an action.
- * Parameters are extracted from the conversation by the LLM and passed to the action handler.
- */
-export interface ActionParameter extends Omit<ProtoActionParameter, "$typeName" | "$unknown" | "schema"> {
-    /** Parameter name (used as the key in the parameters object) */
-    name: string;
-    /** Human-readable description for LLM guidance */
-    description: string;
-    /** Whether this parameter is required (default: false) */
-    required?: boolean;
-    /** JSON Schema for parameter validation */
-    schema: ActionParameterSchema;
-    /**
-     * Optional example values for this parameter.
-     * These are shown to the model in action descriptions to improve extraction accuracy.
-     */
-    examples?: ActionParameterExampleValue[];
-}
-/**
- * Primitive value types that can be used in action parameters.
- */
-export type ActionParameterValue = string | number | boolean | null;
-/**
- * Example value types allowed for action parameter examples.
- * Supports primitives as well as nested objects/arrays for documentation purposes.
- */
-export type ActionParameterExampleValue = ActionParameterValue | ActionParameters | ActionParameterValue[] | ActionParameters[];
-/**
- * Validated parameters passed to an action handler.
- * Keys are parameter names, values are the validated parameter values.
- * Supports nested objects and arrays for complex parameter structures.
- */
-export interface ActionParameters {
-    [key: string]: ActionParameterValue | ActionParameters | ActionParameterValue[] | ActionParameters[] | JsonValue;
-}
-export type ProtoActionParameters = ProtoActionParametersType;
-/**
- * Example content with associated user for demonstration purposes
- */
-export interface ActionExample extends Omit<ProtoActionExample, "$typeName" | "$unknown" | "content"> {
-    content: Content;
-}
-export interface EvaluationExample extends Omit<ProtoEvaluationExample, "$typeName" | "$unknown" | "messages"> {
-    messages: ActionExample[];
-}
-/**
- * Callback function type for handlers
- */
-export type HandlerCallback = (response: Content) => Promise<Memory[]>;
-/**
- * Handler function type for processing messages
- */
-export type Handler = (runtime: IAgentRuntime, message: Memory, state?: State, options?: HandlerOptions | Record<string, JsonValue | undefined>, callback?: HandlerCallback, responses?: Memory[]) => Promise<ActionResult | undefined>;
-/**
- * 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 {
-    /** Action name */
-    name: string;
-    /** Detailed description */
-    description: string;
-    /** Handler function */
-    handler: Handler;
-    /** Validation function */
-    validate: Validator;
-    /** Similar action descriptions */
-    similes?: string[];
-    /** Example usages */
-    examples?: ActionExample[][];
-    /** Optional priority for action ordering */
-    priority?: number;
-    /** Optional tags for categorization */
-    tags?: string[];
-    /**
-     * Optional input parameters for the action.
-     * When defined, the LLM will be prompted to extract these parameters from the conversation
-     * and they will be validated before being passed to the handler via HandlerOptions.parameters.
-     *
-     * Parameters can be required or optional. Optional parameters may have defaults
-     * or can be backfilled inside the action handler if not provided.
-     *
-     * @example
-     * ```typescript
-     * parameters: [
-     *   {
-     *     name: "targetUser",
-     *     description: "The username or ID of the user to send the message to",
-     *     required: true,
-     *     schema: { type: "string" }
-     *   },
-     *   {
-     *     name: "platform",
-     *     description: "The platform to send the message on (telegram, discord, etc)",
-     *     required: false,
-     *     schema: { type: "string", enum: ["telegram", "discord", "x"], default: "telegram" }
-     *   }
-     * ]
-     * ```
-     */
-    parameters?: ActionParameter[];
-}
-/**
- * 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;
-}
-/**
- * JSON-serializable primitive values.
- * These are the basic types that can be serialized to JSON.
- */
-export type JsonPrimitive = string | number | boolean | null;
-/**
- * Value types allowed in provider results.
- *
- * This type accepts:
- * - Primitive JSON values (string, number, boolean, null, undefined)
- * - Arrays of values
- * - Any object (Record<string, unknown>)
- *
- * The broad object type (Record<string, unknown>) ensures that domain types
- * like Memory[], Character, Content, etc. are accepted without requiring
- * unsafe 'as unknown as' casts, while still maintaining JSON-serializable
- * semantics at runtime.
- */
-export type ProviderValue = JsonPrimitive | JsonValue | Uint8Array | bigint | object | ProviderValue[] | {
-    [key: string]: ProviderValue | undefined;
-} | undefined;
-/**
- * Data record type that accepts any JSON-serializable values.
- * This is broader than ProviderValue to accommodate domain types
- * like Memory[], Character, Content without requiring casts.
- * The index signature allows dynamic property access.
- */
-export type ProviderDataRecord = {
-    [key: string]: ProviderValue;
-};
-/**
- * Result returned by a provider
- */
-export interface ProviderResult {
-    /** Human-readable text for LLM prompt inclusion */
-    text?: string;
-    /** Key-value pairs for template variable substitution */
-    values?: Record<string, ProviderValue>;
-    /**
-     * Structured data for programmatic access by other components.
-     * Accepts JSON-serializable values and domain objects.
-     */
-    data?: ProviderDataRecord;
-}
-/**
- * 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>;
-}
-/**
- * Result returned by an action after execution
- * Used for action chaining and state management
- */
-export interface ActionResult {
-    /** Whether the action succeeded */
-    success: boolean;
-    /** Optional text description of the result */
-    text?: string;
-    /** Values to merge into the state */
-    values?: Record<string, ProviderValue>;
-    /**
-     * Data payload containing action-specific results.
-     * Accepts any JSON-serializable object values including domain types.
-     */
-    data?: ProviderDataRecord;
-    /** Error information if the action failed */
-    error?: string | Error;
-    /** Whether to continue the action chain (for chained actions) */
-    continueChain?: boolean;
-    /** Optional cleanup function to execute after action completion */
-    cleanup?: () => void | Promise<void>;
-}
-/**
- * Context provided to actions during execution
- * Allows actions to access previous results and execution state
- */
-export interface ActionContext {
-    /** Results from previously executed actions in this run */
-    previousResults: ActionResult[];
-    /** Get a specific previous result by action name */
-    getPreviousResult?: (actionName: string) => ActionResult | undefined;
-}
-/**
- * Callback for streaming response chunks during action execution.
- * messageId is a string that can be either a UUID or other identifier.
- */
-export type StreamChunkCallback = (chunk: string, messageId?: string) => Promise<void>;
-/**
- * Options passed to action handlers during execution
- * Provides context about the current execution and multi-step plans
- */
-export interface HandlerOptions {
-    /** Context with previous action results and utilities */
-    actionContext?: ActionContext;
-    /** Multi-step action plan information */
-    actionPlan?: ActionPlan;
-    /** Optional stream chunk callback for streaming responses */
-    onStreamChunk?: StreamChunkCallback;
-    /**
-     * Validated input parameters extracted from the conversation.
-     * Only present when the action defines parameters and they were successfully extracted.
-     *
-     * Parameters are validated against the action's parameter schema before being passed here.
-     * Optional parameters may be undefined if not provided in the conversation.
-     *
-     * @example
-     * ```typescript
-     * handler: async (runtime, message, state, options) => {
-     *   const params = options?.parameters;
-     *   if (params) {
-     *     const targetUser = params.targetUser as string;
-     *     const platform = params.platform as string ?? "telegram"; // backfill default
-     *   }
-     * }
-     * ```
-     */
-    parameters?: ActionParameters;
-    /**
-     * Parameter validation errors, if the action defined parameters but extraction/validation was incomplete.
-     *
-     * Actions SHOULD handle these errors gracefully (e.g. ask the user for missing required values,
-     * or infer from context when safe).
-     */
-    parameterErrors?: string[];
-    /** Allow extensions from plugins */
-    [key: string]: JsonValue | object | undefined;
-}
-//# sourceMappingURL=components.d.ts.map

package/dist/types/components.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../src/types/components.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EACV,SAAS,EACT,aAAa,IAAI,kBAAkB,EACnC,eAAe,IAAI,oBAAoB,EACvC,qBAAqB,IAAI,0BAA0B,EACnD,gBAAgB,IAAI,yBAAyB,EAC7C,iBAAiB,IAAI,sBAAsB,EAC5C,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEjD;;;GAGG;AACH,MAAM,WAAW,qBACf,SAAQ,IAAI,CACV,0BAA0B,EACxB,WAAW,GACX,UAAU,GACV,cAAc,GACd,YAAY,GACZ,OAAO,GACP,YAAY,CACf;IACD,iDAAiD;IACjD,OAAO,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;IAC3B,iDAAiD;IACjD,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACnD,8CAA8C;IAC9C,KAAK,CAAC,EAAE,qBAAqB,CAAC;IAC9B,oDAAoD;IACpD,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,gCAAgC;IAChC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,eACf,SAAQ,IAAI,CAAC,oBAAoB,EAAE,WAAW,GAAG,UAAU,GAAG,QAAQ,CAAC;IACvE,gEAAgE;IAChE,IAAI,EAAE,MAAM,CAAC;IACb,kDAAkD;IAClD,WAAW,EAAE,MAAM,CAAC;IACpB,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,2CAA2C;IAC3C,MAAM,EAAE,qBAAqB,CAAC;IAC9B;;;OAGG;IACH,QAAQ,CAAC,EAAE,2BAA2B,EAAE,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAEpE;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GACnC,oBAAoB,GACpB,gBAAgB,GAChB,oBAAoB,EAAE,GACtB,gBAAgB,EAAE,CAAC;AAEvB;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,CAAC,GAAG,EAAE,MAAM,GACR,oBAAoB,GACpB,gBAAgB,GAChB,oBAAoB,EAAE,GACtB,gBAAgB,EAAE,GAClB,SAAS,CAAC;CACf;AAED,MAAM,MAAM,qBAAqB,GAAG,yBAAyB,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,aACf,SAAQ,IAAI,CAAC,kBAAkB,EAAE,WAAW,GAAG,UAAU,GAAG,SAAS,CAAC;IACtE,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,iBACf,SAAQ,IAAI,CAAC,sBAAsB,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IAC3E,QAAQ,EAAE,aAAa,EAAE,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,QAAQ,EAAE,OAAO,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,CACpB,OAAO,EAAE,aAAa,EACtB,OAAO,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,KAAK,EACb,OAAO,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC,EAChE,QAAQ,CAAC,EAAE,eAAe,EAC1B,SAAS,CAAC,EAAE,MAAM,EAAE,KACjB,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,CACtB,OAAO,EAAE,aAAa,EACtB,OAAO,EAAE,MAAM,EACf,KAAK,CAAC,EAAE,KAAK,KACV,OAAO,CAAC,OAAO,CAAC,CAAC;AAEtB;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IAEb,2BAA2B;IAC3B,WAAW,EAAE,MAAM,CAAC;IAEpB,uBAAuB;IACvB,OAAO,EAAE,OAAO,CAAC;IAEjB,0BAA0B;IAC1B,QAAQ,EAAE,SAAS,CAAC;IAEpB,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB,qBAAqB;IACrB,QAAQ,CAAC,EAAE,aAAa,EAAE,EAAE,CAAC;IAE7B,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,uCAAuC;IACvC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,4BAA4B;IAC5B,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,2BAA2B;IAC3B,WAAW,EAAE,MAAM,CAAC;IAEpB,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB,0BAA0B;IAC1B,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAE9B,uBAAuB;IACvB,OAAO,EAAE,OAAO,CAAC;IAEjB,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IAEb,0BAA0B;IAC1B,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAE7D;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,aAAa,GACrB,aAAa,GACb,SAAS,GACT,UAAU,GACV,MAAM,GACN,MAAM,GACN,aAAa,EAAE,GACf;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAA;CAAE,GAC5C,SAAS,CAAC;AAEd;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,mDAAmD;IACnD,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,yDAAyD;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAEvC;;;OAGG;IACH,IAAI,CAAC,EAAE,kBAAkB,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IAEb,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,sCAAsC;IACtC,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,8BAA8B;IAC9B,GAAG,EAAE,CACH,OAAO,EAAE,aAAa,EACtB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,KAAK,KACT,OAAO,CAAC,cAAc,CAAC,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,mCAAmC;IACnC,OAAO,EAAE,OAAO,CAAC;IAEjB,8CAA8C;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,qCAAqC;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAEvC;;;OAGG;IACH,IAAI,CAAC,EAAE,kBAAkB,CAAC;IAE1B,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAEvB,iEAAiE;IACjE,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,mEAAmE;IACnE,OAAO,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,2DAA2D;IAC3D,eAAe,EAAE,YAAY,EAAE,CAAC;IAEhC,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,YAAY,GAAG,SAAS,CAAC;CACtE;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAChC,KAAK,EAAE,MAAM,EACb,SAAS,CAAC,EAAE,MAAM,KACf,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,yDAAyD;IACzD,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B,yCAAyC;IACzC,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB,6DAA6D;IAC7D,aAAa,CAAC,EAAE,mBAAmB,CAAC;IAEpC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAE9B;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAE3B,oCAAoC;IACpC,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAC;CAC/C"}