@elizaos/plugin-farcaster 1.0.5 → 1.7.0

package/dist/index.d.ts

@@ -1,506 +1,13 @@
-import * as _elizaos_core from '@elizaos/core';
-import { Content, IAgentRuntime, UUID, Service, TestSuite, TestCase } from '@elizaos/core';
-import { NeynarAPIClient } from '@neynar/nodejs-sdk';
-import { CastWithInteractions } from '@neynar/nodejs-sdk/build/api/index.js';
-import { z } from 'zod';
-
-type Profile = {
-    fid: number;
-    name: string;
-    username: string;
-    pfp?: string;
-    bio?: string;
-    url?: string;
-};
-type Cast = {
-    hash: string;
-    authorFid: number;
-    text: string;
-    profile: Profile;
-    threadId?: string;
-    inReplyTo?: {
-        hash: string;
-        fid: number;
-    };
-    timestamp: Date;
-    stats?: {
-        recasts: number;
-        replies: number;
-        likes: number;
-    };
-};
-type CastId = {
-    hash: string;
-    fid: number;
-};
-type FidRequest = {
-    fid: number;
-    pageSize: number;
-};
-/**
- * This schema defines all required/optional environment settings for Farcaster client
- */
-declare const FarcasterConfigSchema: z.ZodObject<{
-    FARCASTER_DRY_RUN: z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodString]>, boolean, string | boolean>;
-    FARCASTER_FID: z.ZodNumber;
-    MAX_CAST_LENGTH: z.ZodDefault<z.ZodNumber>;
-    FARCASTER_POLL_INTERVAL: z.ZodDefault<z.ZodNumber>;
-    ENABLE_CAST: z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodString]>, boolean, string | boolean>;
-    CAST_INTERVAL_MIN: z.ZodNumber;
-    CAST_INTERVAL_MAX: z.ZodNumber;
-    ENABLE_ACTION_PROCESSING: z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodString]>, boolean, string | boolean>;
-    ACTION_INTERVAL: z.ZodNumber;
-    CAST_IMMEDIATELY: z.ZodEffects<z.ZodUnion<[z.ZodBoolean, z.ZodString]>, boolean, string | boolean>;
-    MAX_ACTIONS_PROCESSING: z.ZodNumber;
-    FARCASTER_SIGNER_UUID: z.ZodString;
-    FARCASTER_NEYNAR_API_KEY: z.ZodString;
-    FARCASTER_HUB_URL: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    FARCASTER_DRY_RUN: boolean;
-    FARCASTER_FID: number;
-    MAX_CAST_LENGTH: number;
-    FARCASTER_POLL_INTERVAL: number;
-    ENABLE_CAST: boolean;
-    CAST_INTERVAL_MIN: number;
-    CAST_INTERVAL_MAX: number;
-    ENABLE_ACTION_PROCESSING: boolean;
-    ACTION_INTERVAL: number;
-    CAST_IMMEDIATELY: boolean;
-    MAX_ACTIONS_PROCESSING: number;
-    FARCASTER_SIGNER_UUID: string;
-    FARCASTER_NEYNAR_API_KEY: string;
-    FARCASTER_HUB_URL: string;
-}, {
-    FARCASTER_DRY_RUN: string | boolean;
-    FARCASTER_FID: number;
-    ENABLE_CAST: string | boolean;
-    CAST_INTERVAL_MIN: number;
-    CAST_INTERVAL_MAX: number;
-    ENABLE_ACTION_PROCESSING: string | boolean;
-    ACTION_INTERVAL: number;
-    CAST_IMMEDIATELY: string | boolean;
-    MAX_ACTIONS_PROCESSING: number;
-    FARCASTER_SIGNER_UUID: string;
-    FARCASTER_NEYNAR_API_KEY: string;
-    FARCASTER_HUB_URL: string;
-    MAX_CAST_LENGTH?: number | undefined;
-    FARCASTER_POLL_INTERVAL?: number | undefined;
-}>;
-type FarcasterConfig = z.infer<typeof FarcasterConfigSchema>;
-declare enum FarcasterMessageType {
-    CAST = "CAST",
-    REPLY = "REPLY"
-}
-
-declare class FarcasterClient {
-    private neynar;
-    private signerUuid;
-    constructor(opts: {
-        neynar: NeynarAPIClient;
-        signerUuid: string;
-    });
-    sendCast({ content, inReplyTo, }: {
-        content: Content;
-        inReplyTo?: CastId;
-    }): Promise<CastWithInteractions[]>;
-    private publishCast;
-    getCast(castHash: string): Promise<CastWithInteractions>;
-    getMentions(request: FidRequest): Promise<CastWithInteractions[]>;
-    getProfile(fid: number): Promise<Profile>;
-    getTimeline(request: FidRequest): Promise<{
-        timeline: Cast[];
-        cursor?: string;
-    }>;
-    clearCache(): void;
-}
-
-interface FarcasterInteractionParams {
-    client: FarcasterClient;
-    runtime: IAgentRuntime;
-    config: FarcasterConfig;
-}
-declare class FarcasterInteractionManager {
-    private timeout;
-    private isRunning;
-    private client;
-    private runtime;
-    private config;
-    private asyncQueue;
-    constructor(opts: FarcasterInteractionParams);
-    start(): Promise<void>;
-    stop(): Promise<void>;
-    private runPeriodically;
-    private ensureCastConnection;
-    private handleInteractions;
-    buildThreadForCast(cast: Cast, skipMemoryId: Set<UUID>): Promise<Cast[]>;
-    private handleMentionCast;
-}
-
-interface FarcasterCastParams {
-    client: FarcasterClient;
-    runtime: IAgentRuntime;
-    config: FarcasterConfig;
-}
-declare class FarcasterCastManager {
-    client: FarcasterClient;
-    runtime: IAgentRuntime;
-    fid: number;
-    private timeout;
-    private config;
-    private isRunning;
-    constructor(opts: FarcasterCastParams);
-    start(): Promise<void>;
-    stop(): Promise<void>;
-    private calculateDelay;
-    private runPeriodically;
-    private generateNewCast;
-}
-
-/**
- * A manager that orchestrates all Farcaster operations:
- * - client: base operations (Neynar client, hub connection, etc.)
- * - posts: autonomous posting logic
- * - interactions: handling mentions, replies, likes, etc.
- */
-declare class FarcasterAgentManager {
-    readonly runtime: IAgentRuntime;
-    readonly client: FarcasterClient;
-    readonly casts: FarcasterCastManager;
-    readonly interactions: FarcasterInteractionManager;
-    constructor(runtime: IAgentRuntime, config: FarcasterConfig);
-    start(): Promise<void>;
-    stop(): Promise<void>;
-}
-
-interface Message {
-    id: string;
-    agentId: UUID;
-    roomId: string;
-    userId: string;
-    username: string;
-    text: string;
-    type: FarcasterMessageType;
-    timestamp: number;
-    inReplyTo?: string;
-    metadata?: any;
-}
-interface GetMessagesOptions {
-    roomId?: string;
-    limit?: number;
-}
-interface SendMessageOptions {
-    agentId: UUID;
-    roomId: string;
-    text: string;
-    type: string;
-    replyToId?: string;
-    metadata?: any;
-}
-interface IMessageService {
-    getMessages(options: GetMessagesOptions): Promise<Message[]>;
-    sendMessage(options: SendMessageOptions): Promise<Message>;
-    getMessage(messageId: string, agentId: UUID): Promise<Message | null>;
-}
-declare class FarcasterMessageService implements IMessageService {
-    private client;
-    private runtime;
-    constructor(client: FarcasterClient, runtime: any);
-    getMessages(options: GetMessagesOptions): Promise<Message[]>;
-    sendMessage(options: SendMessageOptions): Promise<Message>;
-    deleteMessage(messageId: string, agentId: UUID): Promise<void>;
-    getMessage(messageId: string, agentId: UUID): Promise<Message | null>;
-    markAsRead(messageIds: string[], agentId: UUID): Promise<void>;
-}
-
-interface FarcasterCast {
-    id: string;
-    agentId: UUID;
-    roomId: UUID;
-    userId: string;
-    username: string;
-    text: string;
-    timestamp: number;
-    inReplyTo?: string;
-    media?: any[];
-    metadata?: any;
-}
-interface CastServiceInterface {
-    getCasts(params: {
-        agentId: UUID;
-        limit?: number;
-        cursor?: string;
-    }): Promise<FarcasterCast[]>;
-    createCast(params: {
-        agentId: UUID;
-        roomId: UUID;
-        text: string;
-        media?: string[];
-        replyTo?: {
-            hash: string;
-            fid: number;
-        };
-    }): Promise<FarcasterCast>;
-    deleteCast(params: {
-        agentId: UUID;
-        castHash: string;
-    }): Promise<void>;
-    likeCast(params: {
-        agentId: UUID;
-        castHash: string;
-    }): Promise<void>;
-    unlikeCast(params: {
-        agentId: UUID;
-        castHash: string;
-    }): Promise<void>;
-    recast(params: {
-        agentId: UUID;
-        castHash: string;
-    }): Promise<void>;
-    unrecast(params: {
-        agentId: UUID;
-        castHash: string;
-    }): Promise<void>;
-    getMentions(params: {
-        agentId: UUID;
-        limit?: number;
-    }): Promise<FarcasterCast[]>;
-}
-declare class FarcasterCastService implements CastServiceInterface {
-    private client;
-    private runtime;
-    static serviceType: string;
-    constructor(client: FarcasterClient, runtime: IAgentRuntime);
-    /**
-     * Get recent casts from the timeline
-     */
-    getCasts(params: {
-        agentId: UUID;
-        limit?: number;
-        cursor?: string;
-    }): Promise<FarcasterCast[]>;
-    /**
-     * Create a new cast
-     */
-    createCast(params: {
-        agentId: UUID;
-        roomId: UUID;
-        text: string;
-        media?: string[];
-        replyTo?: {
-            hash: string;
-            fid: number;
-        };
-    }): Promise<FarcasterCast>;
-    /**
-     * Delete a cast
-     */
-    deleteCast(params: {
-        agentId: UUID;
-        castHash: string;
-    }): Promise<void>;
-    /**
-     * Like a cast
-     */
-    likeCast(params: {
-        agentId: UUID;
-        castHash: string;
-    }): Promise<void>;
-    /**
-     * Unlike a cast
-     */
-    unlikeCast(params: {
-        agentId: UUID;
-        castHash: string;
-    }): Promise<void>;
-    /**
-     * Recast a cast
-     */
-    recast(params: {
-        agentId: UUID;
-        castHash: string;
-    }): Promise<void>;
-    /**
-     * Remove a recast
-     */
-    unrecast(params: {
-        agentId: UUID;
-        castHash: string;
-    }): Promise<void>;
-    /**
-     * Get mentions
-     */
-    getMentions(params: {
-        agentId: UUID;
-        limit?: number;
-    }): Promise<FarcasterCast[]>;
-    /**
-     * Generate cast content using AI
-     */
-    private generateCastContent;
-    /**
-     * Truncate cast to fit character limit
-     */
-    private truncateCast;
-    /**
-     * Store cast in agent memory
-     */
-    private storeCastInMemory;
-    /**
-     * Convert internal Cast type to FarcasterCast
-     */
-    private castToFarcasterCast;
-}
-
-declare class FarcasterService extends Service {
-    private static instance?;
-    private managers;
-    private messageServices;
-    private castServices;
-    static serviceType: string;
-    readonly description = "Farcaster integration service for sending and receiving casts";
-    readonly capabilityDescription = "The agent is able to send and receive messages on farcaster";
-    private static getInstance;
-    initialize(runtime: IAgentRuntime): Promise<void>;
-    static start(runtime: IAgentRuntime): Promise<Service>;
-    static stop(runtime: IAgentRuntime): Promise<void>;
-    stop(): Promise<void>;
-    getMessageService(agentId: UUID): FarcasterMessageService | undefined;
-    /**
-     * Get the PostService for a specific agent (for compatibility)
-     * @deprecated Use getCastService() instead. Will be removed in a future major release.
-     */
-    getPostService(agentId: UUID): FarcasterCastService | undefined;
-    getCastService(agentId: UUID): FarcasterCastService | undefined;
-    healthCheck(): Promise<{
-        healthy: boolean;
-        details: Record<string, any>;
-    }>;
-    getActiveManagers(): Map<UUID, FarcasterAgentManager>;
-}
-
-/**
- * Represents a Test Suite for Farcaster functionality.
- * This class implements the TestSuite interface.
- * It contains various test cases related to Farcaster operations such as initializing the client,
- * fetching profile, fetching casts, posting casts, and handling cast interactions.
- */
-declare class FarcasterTestSuite implements TestSuite {
-    name: string;
-    description: string;
-    private manager;
-    tests: TestCase[];
-    /**
-     * Constructor for TestSuite class.
-     * Initializes an array of test functions to be executed.
-     */
-    constructor();
-    /**
-     * Test that checks if Farcaster is properly configured
-     */
-    testMockConfiguration(runtime: IAgentRuntime): Promise<void>;
-    /**
-     * Test service initialization without real credentials
-     */
-    testMockServiceInit(runtime: IAgentRuntime): Promise<void>;
-    /**
-     * Asynchronously initializes the Farcaster client for the provided agent runtime.
-     *
-     * @param {IAgentRuntime} runtime - The agent runtime to use for initializing the Farcaster client.
-     * @throws {Error} If the Farcaster client manager is not found or if the Farcaster client fails to initialize.
-     */
-    testInitializingClient(runtime: IAgentRuntime): Promise<void>;
-    /**
-     * Asynchronously fetches the profile of a user from Farcaster using the given runtime.
-     *
-     * @param {IAgentRuntime} runtime The runtime to use for fetching the profile.
-     * @returns {Promise<void>} A Promise that resolves when the profile is successfully fetched, or rejects with an error.
-     */
-    testFetchProfile(runtime: IAgentRuntime): Promise<void>;
-    /**
-     * Asynchronously fetches the timeline from the Farcaster client.
-     *
-     * @param {IAgentRuntime} runtime - The agent runtime object.
-     * @throws {Error} If there are no casts in the timeline.
-     * @throws {Error} If an error occurs while fetching the timeline.
-     */
-    testFetchTimeline(runtime: IAgentRuntime): Promise<void>;
-    /**
-     * Asynchronously posts a test cast using the Farcaster API.
-     *
-     * @param {IAgentRuntime} runtime - The agent runtime object.
-     * @returns {Promise<void>} A Promise that resolves when the cast is successfully posted.
-     * @throws {Error} If there is an error posting the cast.
-     */
-    testPostCast(runtime: IAgentRuntime): Promise<void>;
-    /**
-     * Asynchronously posts an image cast on Farcaster using the provided runtime and cast content.
-     * Note: This might need updating based on how images are actually handled in sendCast
-     *
-     * @param {IAgentRuntime} runtime - The runtime environment for the action.
-     * @returns {Promise<void>} A Promise that resolves when the cast is successfully posted.
-     * @throws {Error} If there is an error posting the cast.
-     */
-    testPostImageCast(runtime: IAgentRuntime): Promise<void>;
-    /**
-     * Asynchronously handles a fake cast response using the given runtime.
-     *
-     * @param {IAgentRuntime} runtime - The runtime object for the agent
-     * @returns {Promise<void>} - A promise that resolves when the cast response is handled
-     * @throws {Error} - If there is an error handling the cast response
-     */
-    testHandleCastResponse(runtime: IAgentRuntime): Promise<void>;
-    /**
-     * Generates random content for a cast based on the given context.
-     *
-     * @param {IAgentRuntime} runtime - The runtime environment.
-     * @param {string} context - Optional context for the content generation.
-     * @returns {Promise<string>} A promise that resolves to the generated cast content.
-     */
-    private generateRandomCastContent;
-    /**
-     * Tests the MessageService functionality
-     *
-     * @param {IAgentRuntime} runtime - The runtime environment.
-     * @returns {Promise<void>} A promise that resolves when the test is complete.
-     */
-    testMessageService(runtime: IAgentRuntime): Promise<void>;
-    /**
-     * Tests the PostService functionality
-     *
-     * @param {IAgentRuntime} runtime - The runtime environment.
-     * @returns {Promise<void>} A promise that resolves when the test is complete.
-     */
-    testPostService(runtime: IAgentRuntime): Promise<void>;
-    /**
-     * Tests real account posting functionality
-     *
-     * @param {IAgentRuntime} runtime - The runtime environment.
-     * @returns {Promise<void>} A promise that resolves when the test is complete.
-     */
-    testRealAccountPosting(runtime: IAgentRuntime): Promise<void>;
-    /**
-     * Tests real account interactions (mentions, replies, etc)
-     *
-     * @param {IAgentRuntime} runtime - The runtime environment.
-     * @returns {Promise<void>} A promise that resolves when the test is complete.
-     */
-    testRealAccountInteractions(runtime: IAgentRuntime): Promise<void>;
-    /**
-     * Tests message metadata tracking functionality
-     *
-     * @param {IAgentRuntime} runtime - The runtime environment.
-     * @returns {Promise<void>} A promise that resolves when the test is complete.
-     */
-    testMessageMetadataTracking(runtime: IAgentRuntime): Promise<void>;
-}
-
+import { FarcasterService } from './service.js';
+import { FarcasterTestSuite } from './__tests__/suite.js';
 declare const farcasterPlugin: {
     name: string;
     description: string;
     services: (typeof FarcasterService)[];
-    actions: _elizaos_core.Action[];
-    providers: _elizaos_core.Provider[];
+    actions: any[];
+    providers: any[];
+    routes: Route[];
     tests: FarcasterTestSuite[];
 };
-
-export { farcasterPlugin as default };
+export default farcasterPlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAK1D,QAAA,MAAM,eAAe;;;;;;;;CAQpB,CAAC;AAEF,eAAe,eAAe,CAAC"}