@elizaos/plugin-imessage 2.0.0-beta.1 → 2.0.11-beta.7

package/dist/service.d.ts

@@ -1,266 +0,0 @@
-/**
- * iMessage service implementation for elizaOS.
- */
-import { type IAgentRuntime, Service } from "@elizaos/core";
-import { type ChatDbMessage } from "./chatdb-reader.js";
-import { type ContactPatch, type ContactsMap, type FullContact, type NewContactInput } from "./contacts-reader.js";
-import { type IIMessageService, type IMessageChat, type IMessageListMessagesOptions, type IMessageMessage, type IMessageSendOptions, type IMessageSendResult, type IMessageServiceStatus, type IMessageSettings } from "./types.js";
-/**
- * iMessage service for Eliza agents.
- * Note: This only works on macOS.
- */
-export declare class IMessageService extends Service implements IIMessageService {
-    static serviceType: string;
-    capabilityDescription: string;
-    private settings;
-    private connected;
-    private pollInterval;
-    /**
-     * Highest `message.ROWID` we've already dispatched to the agent. The
-     * polling loop asks chat.db for rows strictly greater than this value,
-     * then advances the cursor to the largest row it actually processed.
-     * Initialized to 0 on start; bumped on every successful dispatch so
-     * we skip backlog on a fresh launch without ever double-delivering.
-     */
-    private lastRowId;
-    /**
-     * Reentrancy gate for the polling loop. Dispatch calls
-     * `messageService.handleMessage` which invokes the LLM and typically
-     * takes several seconds per message. With a 2-second poll interval
-     * that means multiple ticks can land on top of each other, each
-     * seeing the same stale cursor and re-dispatching the same rows.
-     * This flag ensures at most one poll is in flight at a time; ticks
-     * that arrive while a poll is active are dropped (the next scheduled
-     * tick will pick up where the current one left off).
-     */
-    private pollInFlight;
-    /**
-     * Room keys we've already emitted a WORLD_JOINED event for in this
-     * service lifetime. Not persisted — on restart every room is
-     * re-greeted, which is correct: a fresh Eliza process doesn't know
-     * what previous processes already synced, and the bootstrap plugin's
-     * WORLD_JOINED handler is idempotent (handleServerSync tolerates
-     * already-known rooms via upsert semantics).
-     */
-    private seenWorlds;
-    /**
-     * Entity keys we've already emitted an ENTITY_JOINED event for.
-     * Same lifetime + rationale as seenWorlds.
-     */
-    private seenEntities;
-    /**
-     * Live chat.db handle, bound to the lifetime of this service. Non-null
-     * means inbound polling is active. Null means either (a) not running
-     * under Bun, or (b) chat.db couldn't be opened — in both cases the
-     * service remains send-only and logs a one-time warning on start.
-     */
-    private chatDb;
-    private chatDbPath;
-    /**
-     * Cached handle → display name map from the user's Apple Contacts.
-     * Populated lazily on first inbound message via AppleScript against
-     * Contacts.app, NOT at service start. Loading at boot would trigger
-     * the macOS Contacts TCC dialog at app launch, even though the user
-     * may never receive an inbound iMessage. We defer the AppleScript
-     * call (and its TCC prompt) until the first message that actually
-     * needs handle→name resolution. Empty map means either the user
-     * hasn't authorized Contacts access yet, the address book is empty,
-     * or no inbound message has triggered the lazy load yet.
-     */
-    private contacts;
-    /** Whether the lazy contact load has been attempted this session. */
-    private contactsLoadAttempted;
-    /**
-     * Start the iMessage service.
-     */
-    static start(runtime: IAgentRuntime): Promise<IMessageService>;
-    static registerSendHandlers(runtime: IAgentRuntime, service: IMessageService): void;
-    /**
-     * Stop the iMessage service.
-     */
-    stop(): Promise<void>;
-    /**
-     * Check if the service is connected.
-     */
-    isConnected(): boolean;
-    getStatus(): IMessageServiceStatus;
-    /**
-     * Check if running on macOS.
-     */
-    isMacOS(): boolean;
-    /**
-     * Send a message via iMessage.
-     */
-    sendMessage(to: string, text: string, options?: IMessageSendOptions): Promise<IMessageSendResult>;
-    /**
-     * Get recent messages by reading chat.db. Returns the most recent
-     * `limit` messages (any sender, any chat) in chronological order.
-     *
-     * Returns an empty array if the chat.db reader is unavailable (plugin
-     * running under plain Node without bun:sqlite, or Full Disk Access not
-     * granted, etc.).
-     */
-    getRecentMessages(limit?: number): Promise<IMessageMessage[]>;
-    /**
-     * Return the newest messages in chronological order, optionally scoped
-     * to a single chat identifier. Returns an empty array if chat.db is not
-     * available and the connector is currently running in send-only mode.
-     */
-    getMessages(options?: IMessageListMessagesOptions): Promise<IMessageMessage[]>;
-    /**
-     * List every chat the Messages.app database knows about, joined with
-     * participant handles. Returns an empty list if the chat.db reader is
-     * unavailable (Node runtime, missing FDA, etc.).
-     *
-     * Previously this method used an AppleScript stub against
-     * Messages.app's `chats` collection. That verb works but is slow and
-     * returns a coarser view (no participant handles, no style field), so
-     * the chat.db path is strictly better when it's available.
-     */
-    getChats(): Promise<IMessageChat[]>;
-    /**
-     * Get current settings.
-     */
-    getSettings(): IMessageSettings | null;
-    /**
-     * Get the cached Apple Contacts map loaded at service start.
-     *
-     * Keys are normalized handles (phones in digits-only + optional leading `+`,
-     * emails lowercased). Values carry the contact's display name.
-     *
-     * Exposed for providers that want to inject contact lookups into agent
-     * state so the LLM can resolve a person's name ("text Shaw") to a handle
-     * it can pass to `sendMessage`.
-     *
-     * Returns an empty map if Contacts access was denied, failed to load,
-     * or the service hasn't finished starting.
-     */
-    getContacts(): ContactsMap;
-    /**
-     * Lazy-load the Apple Contacts map on first call. Subsequent calls
-     * are no-ops. We split this out from `start()` so the macOS Contacts
-     * TCC dialog only fires when the runtime actually needs handle→name
-     * resolution — typically the first inbound message — instead of at
-     * app launch. Failure is non-fatal; the cached map stays empty and
-     * the service falls back to raw handles.
-     */
-    private ensureContactsLoaded;
-    /**
-     * List every contact in the user's address book as a full record with
-     * id, name, and all phones/emails. Delegates to contacts-reader's
-     * `listAllContacts` which goes through Contacts.app's AppleScript
-     * dump. Returns `[]` on failure (permission denied, etc.).
-     */
-    listAllContacts(): Promise<FullContact[]>;
-    /**
-     * Create a new contact in Contacts.app. Requires Contacts WRITE
-     * permission (macOS prompts on first call). Returns the new person's
-     * id on success, or null on failure.
-     *
-     * After a successful create we refresh the cached handle→name map so
-     * inbound messages from the new contact resolve to their name on the
-     * very next poll, without requiring a service restart.
-     */
-    addContact(input: NewContactInput): Promise<string | null>;
-    /**
-     * Patch an existing contact (name fields, add/remove phones, add/remove
-     * emails). Returns true on success, false on failure. Refreshes the
-     * cached map on success so name resolution reflects the change.
-     */
-    updateContact(personId: string, patch: ContactPatch): Promise<boolean>;
-    /**
-     * Delete a contact by Contacts.app id. Returns true on success,
-     * false on failure. Refreshes the cached map on success.
-     */
-    deleteContact(personId: string): Promise<boolean>;
-    private loadSettings;
-    private validateSettings;
-    private sendSingleMessage;
-    private sendViaCli;
-    private sendViaAppleScript;
-    private runAppleScript;
-    private startPolling;
-    /**
-     * Poll chat.db for rows newer than the cursor and route each inbound
-     * message through the agent's message pipeline.
-     *
-     * Flow per message:
-     *   1. Read new rows from chat.db via the bun:sqlite reader.
-     *   2. Skip outbound (is_from_me=1), already-seen, and policy-denied rows.
-     *   3. Build a Memory object in the shape the bootstrap plugin expects.
-     *   4. Ensure the entity + room + world exist via ensureConnection.
-     *   5. Call runtime.messageService.handleMessage with a callback that
-     *      sends the agent's reply back through sendViaAppleScript.
-     *   6. Also emit the plugin-namespaced IMESSAGE_MESSAGE_RECEIVED event
-     *      and the core EventType.MESSAGE_RECEIVED event for any listeners.
-     *
-     * Advances this.lastRowId unconditionally to the max rowId we saw in
-     * this batch — even for skipped rows — so the cursor keeps moving
-     * forward and we never get stuck re-reading the same row on every poll.
-     */
-    private pollForNewMessages;
-    private pollForNewMessagesInner;
-    /**
-     * Turn a single chat.db row into a `Memory`, wire up a reply callback,
-     * and hand the whole thing to `runtime.messageService.handleMessage`.
-     *
-     * Mirrors the shape used by @elizaos/plugin-telegram so the bootstrap
-     * plugin's message pipeline picks up inbound iMessages the same way it
-     * picks up Telegram messages — same entity/room/world creation, same
-     * `source: "imessage"` tag on content, same HandlerCallback signature
-     * for the reply path.
-     */
-    private dispatchInboundMessage;
-    /**
-     * Handle non-conversational chat.db rows — reactions, group events,
-     * anything that isn't a normal text turn. These shouldn't flow through
-     * `messageService.handleMessage` (which would try to generate a reply)
-     * but they're still useful to surface as plugin-namespaced events so
-     * listeners can react, log, or update state.
-     *
-     * Emits two events:
-     *   - A plugin-namespaced event on the existing `IMessageEventTypes`
-     *     enum (e.g. `IMESSAGE_REACTION_RECEIVED`).
-     *   - The generic `EventType.REACTION_RECEIVED` from core when the
-     *     row is a reaction, so core-level handlers see it.
-     */
-    private emitAuxiliaryEvent;
-    private isAllowed;
-    /**
-     * Register a recurring heartbeat task with Eliza's task system and
-     * kick off one if it isn't already queued.
-     *
-     * The heartbeat runs once a minute (configurable via
-     * `IMESSAGE_HEARTBEAT_INTERVAL_MS`) and does a lightweight health
-     * probe: (a) chat.db reader is still open and responsive,
-     * (b) Contacts map still populated, (c) polling cursor is advancing
-     * when expected. On failure it logs + emits
-     * `IMESSAGE_HEARTBEAT_UNHEALTHY`; on success it emits
-     * `IMESSAGE_HEARTBEAT_OK`. Observers (Eliza's heartbeat UI, ops
-     * dashboards, trajectory logger) subscribe to these events.
-     *
-     * The task is tagged `["queue", "repeat", "imessage"]` so Eliza's
-     * built-in TaskService picks it up via its standard polling loop.
-     * Without `updateInterval` being set in metadata, the task fires
-     * once and then deletes; with it, the task service re-schedules.
-     */
-    private registerHeartbeat;
-}
-/**
- * Convert a `ChatDbMessage` (the shape the bun:sqlite reader returns)
- * into the public `IMessageMessage` shape exposed by this plugin's API.
- * Exported so the test suite can exercise it in isolation without
- * spinning up a full runtime + service instance.
- */
-export declare function chatDbMessageToPublicShape(row: ChatDbMessage): IMessageMessage;
-/**
- * Parse tab-delimited AppleScript messages output.
- * Expected format per line: "id\ttext\tdate_sent\tis_from_me\tchat_identifier\tsender"
- */
-export declare function parseMessagesFromAppleScript(result: string): IMessageMessage[];
-/**
- * Parse tab-delimited AppleScript chats output.
- * Expected format per line: "chat_identifier\tdisplay_name\tparticipant_count\tlast_message_date"
- */
-export declare function parseChatsFromAppleScript(result: string): IMessageChat[];
-//# sourceMappingURL=service.d.ts.map

package/dist/service.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,OAAO,EASL,KAAK,aAAa,EAUlB,OAAO,EAGR,MAAM,eAAe,CAAC;AAKvB,OAAO,EACL,KAAK,aAAa,EAKnB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAEL,KAAK,YAAY,EACjB,KAAK,WAAW,EAEhB,KAAK,WAAW,EAGhB,KAAK,eAAe,EAGrB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAGL,KAAK,gBAAgB,EAErB,KAAK,YAAY,EAKjB,KAAK,2BAA2B,EAChC,KAAK,eAAe,EAEpB,KAAK,mBAAmB,EACxB,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,gBAAgB,EAMtB,MAAM,YAAY,CAAC;AAwUpB;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,OAAQ,YAAW,gBAAgB;IACtE,MAAM,CAAC,WAAW,EAAE,MAAM,CAAyB;IAEnD,qBAAqB,SAAkE;IAEvF,OAAO,CAAC,QAAQ,CAAiC;IACjD,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,YAAY,CAA+B;IACnD;;;;;;OAMG;IACH,OAAO,CAAC,SAAS,CAAa;IAC9B;;;;;;;;;OASG;IACH,OAAO,CAAC,YAAY,CAAkB;IACtC;;;;;;;OAOG;IACH,OAAO,CAAC,UAAU,CAA0B;IAC5C;;;OAGG;IACH,OAAO,CAAC,YAAY,CAA0B;IAC9C;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAA6B;IAC3C,OAAO,CAAC,UAAU,CAAgC;IAClD;;;;;;;;;;OAUG;IACH,OAAO,CAAC,QAAQ,CAA0B;IAC1C,qEAAqE;IACrE,OAAO,CAAC,qBAAqB,CAAS;IAEtC;;OAEG;WACU,KAAK,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC;IA+EpE,MAAM,CAAC,oBAAoB,CAAC,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,eAAe,GAAG,IAAI;IA4QnF;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAmB3B;;OAEG;IACH,WAAW,IAAI,OAAO;IAItB,SAAS,IAAI,qBAAqB;IAelC;;OAEG;IACH,OAAO,IAAI,OAAO;IAIlB;;OAEG;IACG,WAAW,CACf,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,kBAAkB,CAAC;IA+D9B;;;;;;;OAOG;IACG,iBAAiB,CAAC,KAAK,GAAE,MAAW,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAIvE;;;;OAIG;IACG,WAAW,CAAC,OAAO,GAAE,2BAAgC,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IASxF;;;;;;;;;OASG;IACG,QAAQ,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;IAoBzC;;OAEG;IACH,WAAW,IAAI,gBAAgB,GAAG,IAAI;IAItC;;;;;;;;;;;;OAYG;IACH,WAAW,IAAI,WAAW;IAI1B;;;;;;;OAOG;YACW,oBAAoB;IAclC;;;;;OAKG;IACG,eAAe,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAI/C;;;;;;;;OAQG;IACG,UAAU,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAQhE;;;;OAIG;IACG,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC;IAQ5E;;;OAGG;IACG,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAUvD,OAAO,CAAC,YAAY;YA0DN,gBAAgB;YAsBhB,iBAAiB;YAkBjB,UAAU;YAuBV,kBAAkB;YA6DlB,cAAc;IAU5B,OAAO,CAAC,YAAY;IAcpB;;;;;;;;;;;;;;;;;OAiBG;YACW,kBAAkB;YAkBlB,uBAAuB;IA2ErC;;;;;;;;;OASG;YACW,sBAAsB;IAgUpC;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,kBAAkB;IAoD1B,OAAO,CAAC,SAAS;IAuBjB;;;;;;;;;;;;;;;;;OAiBG;YACW,iBAAiB;CA+FhC;AAkBD;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,aAAa,GAAG,eAAe,CAiB9E;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,EAAE,CA0C9E;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,EAAE,CA+CxE"}