@elizaos/api-client 1.4.5 → 1.5.0

package/dist/core/src/types/events.d.ts

@@ -0,0 +1,208 @@
+import type { HandlerCallback } from './components';
+import type { Entity, Room, World } from './environment';
+import type { Memory } from './memory';
+import type { ModelTypeName } from './model';
+import type { Metadata, UUID } from './primitives';
+import type { IAgentRuntime } from './runtime';
+/**
+ * Standard event types across all platforms
+ */
+export declare enum EventType {
+    WORLD_JOINED = "WORLD_JOINED",
+    WORLD_CONNECTED = "WORLD_CONNECTED",
+    WORLD_LEFT = "WORLD_LEFT",
+    ENTITY_JOINED = "ENTITY_JOINED",
+    ENTITY_LEFT = "ENTITY_LEFT",
+    ENTITY_UPDATED = "ENTITY_UPDATED",
+    ROOM_JOINED = "ROOM_JOINED",
+    ROOM_LEFT = "ROOM_LEFT",
+    MESSAGE_RECEIVED = "MESSAGE_RECEIVED",
+    MESSAGE_SENT = "MESSAGE_SENT",
+    MESSAGE_DELETED = "MESSAGE_DELETED",
+    CHANNEL_CLEARED = "CHANNEL_CLEARED",
+    VOICE_MESSAGE_RECEIVED = "VOICE_MESSAGE_RECEIVED",
+    VOICE_MESSAGE_SENT = "VOICE_MESSAGE_SENT",
+    REACTION_RECEIVED = "REACTION_RECEIVED",
+    POST_GENERATED = "POST_GENERATED",
+    INTERACTION_RECEIVED = "INTERACTION_RECEIVED",
+    RUN_STARTED = "RUN_STARTED",
+    RUN_ENDED = "RUN_ENDED",
+    RUN_TIMEOUT = "RUN_TIMEOUT",
+    ACTION_STARTED = "ACTION_STARTED",
+    ACTION_COMPLETED = "ACTION_COMPLETED",
+    EVALUATOR_STARTED = "EVALUATOR_STARTED",
+    EVALUATOR_COMPLETED = "EVALUATOR_COMPLETED",
+    MODEL_USED = "MODEL_USED",
+    EMBEDDING_GENERATION_REQUESTED = "EMBEDDING_GENERATION_REQUESTED",
+    EMBEDDING_GENERATION_COMPLETED = "EMBEDDING_GENERATION_COMPLETED",
+    EMBEDDING_GENERATION_FAILED = "EMBEDDING_GENERATION_FAILED"
+}
+/**
+ * Platform-specific event type prefix
+ */
+export declare enum PlatformPrefix {
+    DISCORD = "DISCORD",
+    TELEGRAM = "TELEGRAM",
+    TWITTER = "TWITTER"
+}
+/**
+ * Base payload interface for all events
+ */
+export interface EventPayload {
+    runtime: IAgentRuntime;
+    source: string;
+    onComplete?: () => void;
+}
+/**
+ * Payload for world-related events
+ */
+export interface WorldPayload extends EventPayload {
+    world: World;
+    rooms: Room[];
+    entities: Entity[];
+}
+/**
+ * Payload for entity-related events
+ */
+export interface EntityPayload extends EventPayload {
+    entityId: UUID;
+    worldId?: UUID;
+    roomId?: UUID;
+    metadata?: {
+        orginalId: string;
+        username: string;
+        displayName?: string;
+        [key: string]: any;
+    };
+}
+/**
+ * Payload for reaction-related events
+ */
+export interface MessagePayload extends EventPayload {
+    message: Memory;
+    callback?: HandlerCallback;
+    onComplete?: () => void;
+}
+/**
+ * Payload for channel cleared events
+ */
+export interface ChannelClearedPayload extends EventPayload {
+    roomId: UUID;
+    channelId: string;
+    memoryCount: number;
+}
+/**
+ * Payload for events that are invoked without a message
+ */
+export interface InvokePayload extends EventPayload {
+    worldId: UUID;
+    userId: string;
+    roomId: UUID;
+    callback?: HandlerCallback;
+    source: string;
+}
+/**
+ * Run event payload type
+ */
+export interface RunEventPayload extends EventPayload {
+    runId: UUID;
+    messageId: UUID;
+    roomId: UUID;
+    entityId: UUID;
+    startTime: number;
+    status: 'started' | 'completed' | 'timeout';
+    endTime?: number;
+    duration?: number;
+    error?: string;
+}
+/**
+ * Action event payload type
+ */
+export interface ActionEventPayload extends EventPayload {
+    actionId: UUID;
+    actionName: string;
+    startTime?: number;
+    completed?: boolean;
+    error?: Error;
+}
+/**
+ * Evaluator event payload type
+ */
+export interface EvaluatorEventPayload extends EventPayload {
+    evaluatorId: UUID;
+    evaluatorName: string;
+    startTime?: number;
+    completed?: boolean;
+    error?: Error;
+}
+/**
+ * Model event payload type
+ */
+export interface ModelEventPayload extends EventPayload {
+    provider: string;
+    type: ModelTypeName;
+    prompt: string;
+    tokens?: {
+        prompt: number;
+        completion: number;
+        total: number;
+    };
+}
+/**
+ * Payload for embedding generation events
+ */
+export interface EmbeddingGenerationPayload extends EventPayload {
+    memory: Memory;
+    priority?: 'high' | 'normal' | 'low';
+    retryCount?: number;
+    maxRetries?: number;
+    embedding?: number[];
+    error?: any;
+}
+export type MessageReceivedHandlerParams = {
+    runtime: IAgentRuntime;
+    message: Memory;
+    callback: HandlerCallback;
+    onComplete?: () => void;
+};
+/**
+ * Maps event types to their corresponding payload types
+ */
+export interface EventPayloadMap {
+    [EventType.WORLD_JOINED]: WorldPayload;
+    [EventType.WORLD_CONNECTED]: WorldPayload;
+    [EventType.WORLD_LEFT]: WorldPayload;
+    [EventType.ENTITY_JOINED]: EntityPayload;
+    [EventType.ENTITY_LEFT]: EntityPayload;
+    [EventType.ENTITY_UPDATED]: EntityPayload;
+    [EventType.MESSAGE_RECEIVED]: MessagePayload;
+    [EventType.MESSAGE_SENT]: MessagePayload;
+    [EventType.MESSAGE_DELETED]: MessagePayload;
+    [EventType.CHANNEL_CLEARED]: ChannelClearedPayload;
+    [EventType.REACTION_RECEIVED]: MessagePayload;
+    [EventType.POST_GENERATED]: InvokePayload;
+    [EventType.INTERACTION_RECEIVED]: MessagePayload;
+    [EventType.RUN_STARTED]: RunEventPayload;
+    [EventType.RUN_ENDED]: RunEventPayload;
+    [EventType.RUN_TIMEOUT]: RunEventPayload;
+    [EventType.ACTION_STARTED]: ActionEventPayload;
+    [EventType.ACTION_COMPLETED]: ActionEventPayload;
+    [EventType.EVALUATOR_STARTED]: EvaluatorEventPayload;
+    [EventType.EVALUATOR_COMPLETED]: EvaluatorEventPayload;
+    [EventType.MODEL_USED]: ModelEventPayload;
+    [EventType.EMBEDDING_GENERATION_REQUESTED]: EmbeddingGenerationPayload;
+    [EventType.EMBEDDING_GENERATION_COMPLETED]: EmbeddingGenerationPayload;
+    [EventType.EMBEDDING_GENERATION_FAILED]: EmbeddingGenerationPayload;
+}
+/**
+ * Event handler function type
+ */
+export type EventHandler<T extends keyof EventPayloadMap> = (payload: EventPayloadMap[T]) => Promise<void>;
+/**
+ * Defines a more specific type for event handlers, expecting an `Metadata`.
+ * This aims to improve upon generic 'any' type handlers, providing a clearer contract
+ * for functions that respond to events emitted within the agent runtime (see `emitEvent` in `AgentRuntime`).
+ * Handlers can be synchronous or asynchronous.
+ */
+export type TypedEventHandler = (data: Metadata) => Promise<void> | void;
+//# sourceMappingURL=events.d.ts.map

package/dist/core/src/types/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../../../core/src/types/events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC7C,OAAO,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE/C;;GAEG;AACH,oBAAY,SAAS;IAEnB,YAAY,iBAAiB;IAC7B,eAAe,oBAAoB;IACnC,UAAU,eAAe;IAGzB,aAAa,kBAAkB;IAC/B,WAAW,gBAAgB;IAC3B,cAAc,mBAAmB;IAGjC,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IAGvB,gBAAgB,qBAAqB;IACrC,YAAY,iBAAiB;IAC7B,eAAe,oBAAoB;IAGnC,eAAe,oBAAoB;IAGnC,sBAAsB,2BAA2B;IACjD,kBAAkB,uBAAuB;IAGzC,iBAAiB,sBAAsB;IACvC,cAAc,mBAAmB;IACjC,oBAAoB,yBAAyB;IAG7C,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,WAAW,gBAAgB;IAG3B,cAAc,mBAAmB;IACjC,gBAAgB,qBAAqB;IAGrC,iBAAiB,sBAAsB;IACvC,mBAAmB,wBAAwB;IAG3C,UAAU,eAAe;IAGzB,8BAA8B,mCAAmC;IACjE,8BAA8B,mCAAmC;IACjE,2BAA2B,gCAAgC;CAC5D;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,aAAa,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY;IAChD,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,YAAY;IACjD,QAAQ,EAAE,IAAI,CAAC;IACf,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,QAAQ,CAAC,EAAE;QACT,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,MAAM,EAAE,IAAI,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,YAAY;IACjD,OAAO,EAAE,IAAI,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,IAAI,CAAC;IACb,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,KAAK,EAAE,IAAI,CAAC;IACZ,SAAS,EAAE,IAAI,CAAC;IAChB,MAAM,EAAE,IAAI,CAAC;IACb,QAAQ,EAAE,IAAI,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,SAAS,CAAC;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,YAAY;IACtD,QAAQ,EAAE,IAAI,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,WAAW,EAAE,IAAI,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE;QACP,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,EAAE,MAAM,CAAC;QACnB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,YAAY;IAC9D,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,KAAK,CAAC,EAAE,GAAG,CAAC;CACb;AAED,MAAM,MAAM,4BAA4B,GAAG;IACzC,OAAO,EAAE,aAAa,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,eAAe,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC;IACvC,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,YAAY,CAAC;IAC1C,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC;IACrC,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,aAAa,CAAC;IACzC,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC;IACvC,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,aAAa,CAAC;IAC1C,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,cAAc,CAAC;IAC7C,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,cAAc,CAAC;IACzC,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,cAAc,CAAC;IAC5C,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE,qBAAqB,CAAC;IACnD,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,cAAc,CAAC;IAC9C,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,aAAa,CAAC;IAC1C,CAAC,SAAS,CAAC,oBAAoB,CAAC,EAAE,cAAc,CAAC;IACjD,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,eAAe,CAAC;IACzC,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,eAAe,CAAC;IACvC,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,eAAe,CAAC;IACzC,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,kBAAkB,CAAC;IAC/C,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;IACjD,CAAC,SAAS,CAAC,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;IACrD,CAAC,SAAS,CAAC,mBAAmB,CAAC,EAAE,qBAAqB,CAAC;IACvD,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC1C,CAAC,SAAS,CAAC,8BAA8B,CAAC,EAAE,0BAA0B,CAAC;IACvE,CAAC,SAAS,CAAC,8BAA8B,CAAC,EAAE,0BAA0B,CAAC;IACvE,CAAC,SAAS,CAAC,2BAA2B,CAAC,EAAE,0BAA0B,CAAC;CACrE;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,eAAe,IAAI,CAC1D,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC,KACxB,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,IAAI,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC"}

package/dist/core/src/types/index.d.ts

@@ -0,0 +1,30 @@
+export * from './primitives';
+export * from './state';
+export * from './memory';
+export * from './knowledge';
+export * from './environment';
+export * from './agent';
+export * from './components';
+export * from './plugin';
+export * from './service';
+export * from './model';
+export * from './database';
+export * from './events';
+export * from './task';
+export * from './tee';
+export * from './runtime';
+export * from './token';
+export * from './messaging';
+export * from './testing';
+export * from './settings';
+export * from './wallet';
+export * from './lp';
+export * from './pdf';
+export * from './video';
+export * from './browser';
+export * from './transcription';
+export * from './web-search';
+export * from './email';
+export * from './message';
+export * from './post';
+//# sourceMappingURL=index.d.ts.map

package/dist/core/src/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../core/src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,OAAO,CAAC;AACtB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,MAAM,CAAC;AACrB,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC"}

package/dist/core/src/types/knowledge.d.ts

@@ -0,0 +1,60 @@
+import type { MemoryMetadata } from './memory';
+import type { Content, UUID } from './primitives';
+/**
+ * Represents a single item of knowledge that can be processed and stored by the agent.
+ * Knowledge items consist of content (text and optional structured data) and metadata.
+ * These items are typically added to the agent's knowledge base via `AgentRuntime.addKnowledge`
+ * and retrieved using `AgentRuntime.getKnowledge`.
+ * The `id` is a unique identifier for the knowledge item, often derived from its source or content.
+ */
+export type KnowledgeItem = {
+    /** A Universally Unique Identifier for this specific knowledge item. */
+    id: UUID;
+    /** The actual content of the knowledge item, which must include text and can have other fields. */
+    content: Content;
+    /** Optional metadata associated with this knowledge item, conforming to `MemoryMetadata`. */
+    metadata?: MemoryMetadata;
+};
+/**
+ * Defines the scope or visibility of knowledge items within the agent's system.
+ * - `SHARED`: Indicates knowledge that is broadly accessible, potentially across different agents or users if the system architecture permits.
+ * - `PRIVATE`: Indicates knowledge that is restricted, typically to the specific agent or user context it belongs to.
+ * This enum is used to manage access and retrieval of knowledge items, often in conjunction with `AgentRuntime.addKnowledge` or `AgentRuntime.getKnowledge` scopes.
+ */
+export declare enum KnowledgeScope {
+    SHARED = "shared",
+    PRIVATE = "private"
+}
+/**
+ * Specifies prefixes for keys used in caching mechanisms, helping to namespace cached data.
+ * For example, `KNOWLEDGE` might be used to prefix keys for cached knowledge embeddings or processed documents.
+ * This helps in organizing the cache and avoiding key collisions.
+ * Used internally by caching strategies, potentially within `IDatabaseAdapter` cache methods or runtime caching layers.
+ */
+export declare enum CacheKeyPrefix {
+    KNOWLEDGE = "knowledge"
+}
+/**
+ * Represents an item within a directory listing, specifically for knowledge loading.
+ * When an agent's `Character.knowledge` configuration includes a directory, this type
+ * is used to specify the path to that directory and whether its contents should be treated as shared.
+ * - `directory`: The path to the directory containing knowledge files.
+ * - `shared`: An optional boolean (defaults to false) indicating if the knowledge from this directory is considered shared or private.
+ */
+export interface DirectoryItem {
+    /** The path to the directory containing knowledge files. */
+    directory: string;
+    /** If true, knowledge from this directory is considered shared; otherwise, it's private. Defaults to false. */
+    shared?: boolean;
+}
+/**
+ * Represents a row structure, typically from a database query related to text chunking or processing.
+ * This interface is quite minimal and seems to be a placeholder or a base for more specific chunk-related types.
+ * The `id` would be the unique identifier for the chunk.
+ * It might be used when splitting large documents into smaller, manageable pieces for embedding or analysis.
+ */
+export interface ChunkRow {
+    /** The unique identifier for this chunk of text. */
+    id: string;
+}
+//# sourceMappingURL=knowledge.d.ts.map

package/dist/core/src/types/knowledge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"knowledge.d.ts","sourceRoot":"","sources":["../../../../../core/src/types/knowledge.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAElD;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,wEAAwE;IACxE,EAAE,EAAE,IAAI,CAAC;IACT,mGAAmG;IACnG,OAAO,EAAE,OAAO,CAAC;IACjB,6FAA6F;IAC7F,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B,CAAC;AAEF;;;;;GAKG;AACH,oBAAY,cAAc;IACxB,MAAM,WAAW;IACjB,OAAO,YAAY;CACpB;AAED;;;;;GAKG;AACH,oBAAY,cAAc;IACxB,SAAS,cAAc;CACxB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,4DAA4D;IAC5D,SAAS,EAAE,MAAM,CAAC;IAClB,+GAA+G;IAC/G,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,oDAAoD;IACpD,EAAE,EAAE,MAAM,CAAC;CAEZ"}

package/dist/core/src/types/lp.d.ts

@@ -0,0 +1,115 @@
+import type { Metadata } from './primitives';
+import { Service } from './service';
+import type { TokenBalance } from './token';
+/**
+ * A standardized representation of a liquidity pool from any DEX.
+ */
+export type PoolInfo = {
+    id: string;
+    displayName?: string;
+    dex: string;
+    tokenA: {
+        mint: string;
+        symbol?: string;
+        reserve?: string;
+        decimals?: number;
+    };
+    tokenB: {
+        mint: string;
+        symbol?: string;
+        reserve?: string;
+        decimals?: number;
+    };
+    lpTokenMint?: string;
+    apr?: number;
+    apy?: number;
+    tvl?: number;
+    fee?: number;
+    metadata?: Metadata;
+};
+/**
+ * A standardized representation of a user's position in a liquidity pool.
+ */
+export type LpPositionDetails = {
+    poolId: string;
+    dex: string;
+    lpTokenBalance: TokenBalance;
+    underlyingTokens: TokenBalance[];
+    valueUsd?: number;
+    accruedFees?: TokenBalance[];
+    rewards?: TokenBalance[];
+    metadata?: Metadata;
+};
+/**
+ * A standardized result for blockchain transactions.
+ */
+export type TransactionResult = {
+    success: boolean;
+    transactionId?: string;
+    error?: string;
+    data?: any;
+};
+/**
+ * Abstract interface for a Liquidity Pool Service.
+ * DEX-specific plugins (e.g., for Orca, Raydium) must implement this service
+ * to allow the LP Manager to interact with them in a standardized way.
+ */
+export declare abstract class ILpService extends Service {
+    static readonly serviceType = "lp";
+    readonly capabilityDescription = "Provides standardized access to DEX liquidity pools.";
+    /**
+     * Returns the name of the DEX this service interacts with.
+     * @returns The name of the DEX (e.g., "Orca", "Raydium").
+     */
+    abstract getDexName(): string;
+    /**
+     * Fetches a list of available liquidity pools from the DEX.
+     * @param tokenAMint - Optional: Filter pools by the mint address of the first token.
+     * @param tokenBMint - Optional: Filter pools by the mint address of the second token.
+     * @returns A promise that resolves to an array of standardized PoolInfo objects.
+     */
+    abstract getPools(tokenAMint?: string, tokenBMint?: string): Promise<PoolInfo[]>;
+    /**
+     * Adds liquidity to a specified pool.
+     * @param params - The parameters for adding liquidity.
+     * @returns A promise resolving to a transaction result, including the LP tokens received.
+     */
+    abstract addLiquidity(params: {
+        userVault: any;
+        poolId: string;
+        tokenAAmountLamports: string;
+        tokenBAmountLamports?: string;
+        slippageBps: number;
+        tickLowerIndex?: number;
+        tickUpperIndex?: number;
+    }): Promise<TransactionResult & {
+        lpTokensReceived?: TokenBalance;
+    }>;
+    /**
+     * Removes liquidity from a specified pool.
+     * @param params - The parameters for removing liquidity.
+     * @returns A promise resolving to a transaction result, including the tokens received.
+     */
+    abstract removeLiquidity(params: {
+        userVault: any;
+        poolId: string;
+        lpTokenAmountLamports: string;
+        slippageBps: number;
+    }): Promise<TransactionResult & {
+        tokensReceived?: TokenBalance[];
+    }>;
+    /**
+     * Fetches the details of a specific LP position for a user.
+     * @param userAccountPublicKey - The user's wallet public key.
+     * @param poolOrPositionIdentifier - The identifier for the pool or a specific position (e.g., position NFT mint).
+     * @returns A promise resolving to the position details or null if not found.
+     */
+    abstract getLpPositionDetails(userAccountPublicKey: string, poolOrPositionIdentifier: string): Promise<LpPositionDetails | null>;
+    /**
+     * Fetches the latest market data (e.g., APY, TVL) for a list of pools.
+     * @param poolIds - An array of pool IDs to fetch data for.
+     * @returns A promise resolving to a map of pool IDs to their partial market data.
+     */
+    abstract getMarketDataForPools(poolIds: string[]): Promise<Record<string, Partial<PoolInfo>>>;
+}
+//# sourceMappingURL=lp.d.ts.map

package/dist/core/src/types/lp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lp.d.ts","sourceRoot":"","sources":["../../../../../core/src/types/lp.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,cAAc,EAAE,YAAY,CAAC;IAC7B,gBAAgB,EAAE,YAAY,EAAE,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,YAAY,EAAE,CAAC;IAC7B,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ,CAAC;AAEF;;;;GAIG;AACH,8BAAsB,UAAW,SAAQ,OAAO;IAC9C,gBAAyB,WAAW,QAAQ;IAE5C,SAAgB,qBAAqB,0DAA0D;IAE/F;;;OAGG;IACH,QAAQ,CAAC,UAAU,IAAI,MAAM;IAE7B;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAEhF;;;;OAIG;IACH,QAAQ,CAAC,YAAY,CAAC,MAAM,EAAE;QAC5B,SAAS,EAAE,GAAG,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,oBAAoB,EAAE,MAAM,CAAC;QAC7B,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,WAAW,EAAE,MAAM,CAAC;QACpB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB,GAAG,OAAO,CAAC,iBAAiB,GAAG;QAAE,gBAAgB,CAAC,EAAE,YAAY,CAAA;KAAE,CAAC;IAEpE;;;;OAIG;IACH,QAAQ,CAAC,eAAe,CAAC,MAAM,EAAE;QAC/B,SAAS,EAAE,GAAG,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,qBAAqB,EAAE,MAAM,CAAC;QAC9B,WAAW,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,iBAAiB,GAAG;QAAE,cAAc,CAAC,EAAE,YAAY,EAAE,CAAA;KAAE,CAAC;IAEpE;;;;;OAKG;IACH,QAAQ,CAAC,oBAAoB,CAC3B,oBAAoB,EAAE,MAAM,EAC5B,wBAAwB,EAAE,MAAM,GAC/B,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC;IAEpC;;;;OAIG;IACH,QAAQ,CAAC,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;CAC9F"}

package/dist/core/src/types/memory.d.ts

@@ -0,0 +1,165 @@
+import type { Content, UUID } from './primitives';
+/**
+ * Memory type enumeration for built-in memory types
+ */
+export type MemoryTypeAlias = string;
+/**
+ * Enumerates the built-in types of memories that can be stored and retrieved.
+ * - `DOCUMENT`: Represents a whole document or a large piece of text.
+ * - `FRAGMENT`: A chunk or segment of a `DOCUMENT`, often created for embedding and search.
+ * - `MESSAGE`: A conversational message, typically from a user or the agent.
+ * - `DESCRIPTION`: A descriptive piece of information, perhaps about an entity or concept.
+ * - `CUSTOM`: For any other type of memory not covered by the built-in types.
+ * This enum is used in `MemoryMetadata` to categorize memories and influences how they are processed or queried.
+ */
+export declare enum MemoryType {
+    DOCUMENT = "document",
+    FRAGMENT = "fragment",
+    MESSAGE = "message",
+    DESCRIPTION = "description",
+    CUSTOM = "custom"
+}
+/**
+ * Defines the scope of a memory, indicating its visibility and accessibility.
+ * - `shared`: The memory is accessible to multiple entities or across different contexts (e.g., a public fact).
+ * - `private`: The memory is specific to a single entity or a private context (e.g., a user's personal preference).
+ * - `room`: The memory is scoped to a specific room or channel.
+ * This is used in `MemoryMetadata` to control how memories are stored and retrieved based on context.
+ */
+export type MemoryScope = 'shared' | 'private' | 'room';
+/**
+ * Base interface for all memory metadata types.
+ * It includes common properties for all memories, such as:
+ * - `type`: The kind of memory (e.g., `MemoryType.MESSAGE`, `MemoryType.DOCUMENT`).
+ * - `source`: An optional string indicating the origin of the memory (e.g., 'discord', 'user_input').
+ * - `sourceId`: An optional UUID linking to a source entity or object.
+ * - `scope`: The visibility scope of the memory (`shared`, `private`, or `room`).
+ * - `timestamp`: An optional numerical timestamp (e.g., milliseconds since epoch) of when the memory was created or relevant.
+ * - `tags`: Optional array of strings for categorizing or filtering memories.
+ * Specific metadata types like `DocumentMetadata` or `MessageMetadata` extend this base.
+ */
+export interface BaseMetadata {
+    type: MemoryTypeAlias;
+    source?: string;
+    sourceId?: UUID;
+    scope?: MemoryScope;
+    timestamp?: number;
+    tags?: string[];
+}
+export interface DocumentMetadata extends BaseMetadata {
+    type: MemoryType.DOCUMENT;
+}
+export interface FragmentMetadata extends BaseMetadata {
+    type: MemoryType.FRAGMENT;
+    documentId: UUID;
+    position: number;
+}
+export interface MessageMetadata extends BaseMetadata {
+    type: MemoryType.MESSAGE;
+}
+export interface DescriptionMetadata extends BaseMetadata {
+    type: MemoryType.DESCRIPTION;
+}
+export interface CustomMetadata extends BaseMetadata {
+    [key: string]: unknown;
+}
+export type MemoryMetadata = DocumentMetadata | FragmentMetadata | MessageMetadata | DescriptionMetadata | CustomMetadata;
+/**
+ * Represents a stored memory/message
+ */
+export interface Memory {
+    /** Optional unique identifier */
+    id?: UUID;
+    /** Associated user ID */
+    entityId: UUID;
+    /** Associated agent ID */
+    agentId?: UUID;
+    /** Optional creation timestamp in milliseconds since epoch */
+    createdAt?: number;
+    /** Memory content */
+    content: Content;
+    /** Optional embedding vector for semantic search */
+    embedding?: number[];
+    /** Associated room ID */
+    roomId: UUID;
+    /** Associated world ID (optional) */
+    worldId?: UUID;
+    /** Whether memory is unique (used to prevent duplicates) */
+    unique?: boolean;
+    /** Embedding similarity score (set when retrieved via search) */
+    similarity?: number;
+    /** Metadata for the memory */
+    metadata?: MemoryMetadata;
+}
+/**
+ * Specialized memory type for messages with enhanced type checking
+ */
+export interface MessageMemory extends Memory {
+    metadata: MessageMetadata;
+    content: Content & {
+        text: string;
+    };
+}
+/**
+ * Factory function to create a new message memory with proper defaults
+ */
+export declare function createMessageMemory(params: {
+    id?: UUID;
+    entityId: UUID;
+    agentId?: UUID;
+    roomId: UUID;
+    content: Content & {
+        text: string;
+    };
+    embedding?: number[];
+}): MessageMemory;
+/**
+ * Type guard to check if a memory metadata is a DocumentMetadata
+ * @param metadata The metadata to check
+ * @returns True if the metadata is a DocumentMetadata
+ */
+export declare function isDocumentMetadata(metadata: MemoryMetadata): metadata is DocumentMetadata;
+/**
+ * Type guard to check if a memory metadata is a FragmentMetadata
+ * @param metadata The metadata to check
+ * @returns True if the metadata is a FragmentMetadata
+ */
+export declare function isFragmentMetadata(metadata: MemoryMetadata): metadata is FragmentMetadata;
+/**
+ * Type guard to check if a memory metadata is a MessageMetadata
+ * @param metadata The metadata to check
+ * @returns True if the metadata is a MessageMetadata
+ */
+export declare function isMessageMetadata(metadata: MemoryMetadata): metadata is MessageMetadata;
+/**
+ * Type guard to check if a memory metadata is a DescriptionMetadata
+ * @param metadata The metadata to check
+ * @returns True if the metadata is a DescriptionMetadata
+ */
+export declare function isDescriptionMetadata(metadata: MemoryMetadata): metadata is DescriptionMetadata;
+/**
+ * Type guard to check if a memory metadata is a CustomMetadata
+ * @param metadata The metadata to check
+ * @returns True if the metadata is a CustomMetadata
+ */
+export declare function isCustomMetadata(metadata: MemoryMetadata): metadata is CustomMetadata;
+/**
+ * Memory type guard for document memories
+ */
+export declare function isDocumentMemory(memory: Memory): memory is Memory & {
+    metadata: DocumentMetadata;
+};
+/**
+ * Memory type guard for fragment memories
+ */
+export declare function isFragmentMemory(memory: Memory): memory is Memory & {
+    metadata: FragmentMetadata;
+};
+/**
+ * Safely access the text content of a memory
+ * @param memory The memory to extract text from
+ * @param defaultValue Optional default value if no text is found
+ * @returns The text content or default value
+ */
+export declare function getMemoryText(memory: Memory, defaultValue?: string): string;
+//# sourceMappingURL=memory.d.ts.map

package/dist/core/src/types/memory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory.d.ts","sourceRoot":"","sources":["../../../../../core/src/types/memory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;;;;;;;GAQG;AACH,oBAAY,UAAU;IACpB,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,WAAW,gBAAgB;IAC3B,MAAM,WAAW;CAClB;AACD;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,CAAC;AAExD;;;;;;;;;;GAUG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,eAAe,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC;IAC1B,UAAU,EAAE,IAAI,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC;CAC9B;AAED,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,MAAM,cAAc,GACtB,gBAAgB,GAChB,gBAAgB,GAChB,eAAe,GACf,mBAAmB,GACnB,cAAc,CAAC;AAEnB;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,iCAAiC;IACjC,EAAE,CAAC,EAAE,IAAI,CAAC;IAEV,yBAAyB;IACzB,QAAQ,EAAE,IAAI,CAAC;IAEf,0BAA0B;IAC1B,OAAO,CAAC,EAAE,IAAI,CAAC;IAEf,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,qBAAqB;IACrB,OAAO,EAAE,OAAO,CAAC;IAEjB,oDAAoD;IACpD,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB,yBAAyB;IACzB,MAAM,EAAE,IAAI,CAAC;IAEb,qCAAqC;IACrC,OAAO,CAAC,EAAE,IAAI,CAAC;IAEf,4DAA4D;IAC5D,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,iEAAiE;IACjE,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,MAAM;IAC3C,QAAQ,EAAE,eAAe,CAAC;IAC1B,OAAO,EAAE,OAAO,GAAG;QACjB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE;IAC1C,EAAE,CAAC,EAAE,IAAI,CAAC;IACV,QAAQ,EAAE,IAAI,CAAC;IACf,OAAO,CAAC,EAAE,IAAI,CAAC;IACf,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE,OAAO,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACpC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,GAAG,aAAa,CAUhB;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,cAAc,GAAG,QAAQ,IAAI,gBAAgB,CAEzF;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,cAAc,GAAG,QAAQ,IAAI,gBAAgB,CAEzF;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,cAAc,GAAG,QAAQ,IAAI,eAAe,CAEvF;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,cAAc,GAAG,QAAQ,IAAI,mBAAmB,CAE/F;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,cAAc,GAAG,QAAQ,IAAI,cAAc,CAOrF;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,GACb,MAAM,IAAI,MAAM,GAAG;IAAE,QAAQ,EAAE,gBAAgB,CAAA;CAAE,CAEnD;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,GACb,MAAM,IAAI,MAAM,GAAG;IAAE,QAAQ,EAAE,gBAAgB,CAAA;CAAE,CAEnD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,SAAK,GAAG,MAAM,CAEvE"}