@elizaos/plugin-signal 2.0.0-alpha.7 → 2.0.11-beta.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Shaw Walters and elizaOS Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,90 @@
+# @elizaos/plugin-signal
+
+Signal messaging integration for elizaOS. Enables Eliza agents to send and receive end-to-end-encrypted Signal messages via [signal-cli](https://github.com/AsamK/signal-cli) or its REST API.
+
+## What it does
+
+- **Receive messages** — inbound Signal DMs and group messages are stored as agent memories and trigger `SIGNAL_MESSAGE_RECEIVED` events.
+- **Send messages** — agents send DMs and group messages through the elizaOS `MessageConnector` surface (LifeOps, workflow automations, explicit send actions).
+- **Contact and group discovery** — the plugin exposes Signal contacts and groups as connector targets so agents can resolve conversation destinations by name, phone number, or group.
+- **QR device linking** — HTTP endpoints drive a pairing flow (QR code → signal-cli device link) without requiring a separate phone.
+- **Multi-account** — configure multiple Signal accounts via `character.settings.signal.accounts`.
+- **Workflow integration** — supplies credentials to the workflow plugin for Signal-backed automations.
+
+## Capabilities registered
+
+This plugin registers no actions. Messaging is handled through the `MessageConnector` interface.
+
+**Services:**
+- `SignalService` — core connector; manages daemon lifecycle, inbound/outbound messages, contacts, and groups.
+- `SignalWorkflowCredentialProvider` — bridges Signal credentials to the workflow plugin.
+
+**Setup routes (no auth required, mounted at raw paths):**
+- `GET  /api/setup/signal/status` — pairing and connection state
+- `POST /api/setup/signal/start`  — begin QR device-linking session
+- `POST /api/setup/signal/cancel` — stop pairing and disconnect
+
+## Prerequisites
+
+One of:
+- **signal-cli** installed and on `PATH` (the plugin can spawn and manage it as a daemon). On macOS, install via Homebrew: `brew install signal-cli`. Java is required; the plugin auto-detects Homebrew's OpenJDK.
+- A running **signal-cli REST API server** (`signal-cli -a +1... daemon --http 127.0.0.1:8080`) accessible at `SIGNAL_HTTP_URL`.
+- The optional **`@elizaos/signal-native`** peer dependency for QR linking without spawning signal-cli.
+
+The agent's Signal account must be linked (registered or device-linked) before the service can connect. Use the `/api/setup/signal/start` endpoint or run `signal-cli -a +1... link` manually.
+
+## Configuration
+
+### Environment variables
+
+| Variable | Required | Default | Description |
+|---|---|---|---|
+| `SIGNAL_ACCOUNT_NUMBER` | **yes** | — | Phone number in E.164 format (e.g. `+15551234567`) |
+| `SIGNAL_HTTP_URL` | no | `http://127.0.0.1:8080` | signal-cli REST API URL; omit to auto-start a local daemon |
+| `SIGNAL_CLI_PATH` | no | `signal-cli` (PATH) | Path to signal-cli binary |
+| `SIGNAL_CLI_AUTO_INSTALL` | no | `true` | Set `false` to disable Homebrew auto-install |
+| `SIGNAL_AUTH_DIR` | no | `~/.local/share/signal-cli` | signal-cli data directory |
+| `SIGNAL_SHOULD_IGNORE_GROUP_MESSAGES` | no | `false` | Set `true` to respond only to DMs |
+| `SIGNAL_AUTO_REPLY` | no | `false` | Set `true` to have the agent auto-generate replies |
+| `SIGNAL_RECEIVE_MODE` | no | `manual` | `on-start` polls immediately; `manual` lets LifeOps pull |
+| `SIGNAL_STARTUP_TIMEOUT_MS` | no | `30000` | Daemon startup timeout (max 120 000 ms) |
+
+### Character settings (multi-account)
+
+```jsonc
+{
+  "settings": {
+    "signal": {
+      "account": "+15551234567",
+      "httpUrl": "http://127.0.0.1:8080",
+      "accounts": {
+        "work": {
+          "account": "+15559876543",
+          "httpUrl": "http://127.0.0.1:8081",
+          "enabled": true
+        }
+      }
+    }
+  }
+}
+```
+
+## Enabling the plugin
+
+The plugin auto-enables when a `signal` connector block is present in the agent config and not explicitly set to `enabled: false`. You can also add it directly to the plugins array:
+
+```ts
+import signalPlugin from "@elizaos/plugin-signal";
+
+const agent = new AgentRuntime({
+  plugins: [signalPlugin],
+  // ...
+});
+```
+
+## Important behavior notes
+
+- **Auto-reply is off by default.** Inbound messages are recorded as memories and events, but the agent does not respond unless `SIGNAL_AUTO_REPLY=true`. Use LifeOps or explicit workflow actions to send responses.
+- **Auth directory:** signal-cli always uses `~/.local/share/signal-cli` on all platforms (including macOS). This matches the signal-cli default, so an existing local installation works without extra config.
+- **Message length:** messages over 4 000 characters are split automatically.
+- **Group filtering:** set `SIGNAL_SHOULD_IGNORE_GROUP_MESSAGES=true` to limit the agent to direct messages only.

package/auto-enable.ts

@@ -0,0 +1,20 @@
+// Auto-enable check for @elizaos/plugin-signal.
+//
+// Plugin manifest entry-point — referenced by package.json's
+// `elizaos.plugin.autoEnableModule`. Keep this module light: env reads only,
+// no service init, no transitive imports of the full plugin runtime. The
+// auto-enable engine loads dozens of these per boot.
+import type { PluginAutoEnableContext } from "@elizaos/core";
+
+/** Enable when a `signal` connector block is present and not explicitly disabled. */
+export function shouldEnable(ctx: PluginAutoEnableContext): boolean {
+  const c = (ctx.config.connectors as Record<string, unknown> | undefined)?.signal;
+  if (!c || typeof c !== "object") return false;
+  const config = c as Record<string, unknown>;
+  if (config.enabled === false) return false;
+  // The full per-connector field check (signal-cli endpoint / phone number)
+  // lives in the central engine's isConnectorConfigured. We delegate to a
+  // simple "block present + not explicitly disabled" check here; the central
+  // engine's stricter check remains as a fallback during migration.
+  return true;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elizaos/plugin-signal",
-  "version": "2.0.0-alpha.7",
+  "version": "2.0.11-beta.7",
   "description": "Signal messaging integration plugin for ElizaOS agents",
   "type": "module",
   "main": "dist/index.js",
@@ -15,13 +15,38 @@
     "./package.json": "./package.json",
     ".": {
       "types": "./dist/index.d.ts",
+      "eliza-source": {
+        "types": "./src/index.ts",
+        "import": "./src/index.ts",
+        "default": "./src/index.ts"
+      },
       "import": "./dist/index.js",
       "default": "./dist/index.js"
+    },
+    "./*.css": "./dist/*.css",
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "eliza-source": {
+        "types": "./src/*.ts",
+        "import": "./src/*.ts",
+        "default": "./src/*.ts"
+      },
+      "import": "./dist/*.js",
+      "default": "./dist/*.js"
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "auto-enable.ts"
   ],
+  "elizaos": {
+    "plugin": {
+      "autoEnableModule": "./auto-enable.ts",
+      "capabilities": [
+        "messaging"
+      ]
+    }
+  },
   "keywords": [
     "elizaos",
     "plugin",
@@ -36,7 +61,7 @@
     "build": "bun run build.ts",
     "build:ts": "bun run build.ts",
     "dev": "bun --hot build.ts",
-    "clean": "rm -rf dist .turbo node_modules",
+    "clean": "rm -rf dist .turbo",
     "test": "vitest run",
     "typecheck": "echo \"Typecheck skipped for release\"",
     "lint": "echo \"Lint skipped for release\"",
@@ -45,16 +70,25 @@
     "format:check": "bunx @biomejs/biome format ."
   },
   "dependencies": {
-    "@elizaos/core": "2.0.0-alpha.3",
-    "zod": "^4.3.6"
+    "@elizaos/core": "2.0.11-beta.7",
+    "qrcode": "^1.5.4"
   },
   "devDependencies": {
+    "@biomejs/biome": "^2.4.14",
     "@types/node": "^25.0.3",
-    "typescript": "^5.9.3",
-    "@biomejs/biome": "^2.3.11"
+    "@types/qrcode": "^1.5.5",
+    "bun-types": "^1.2.25",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.4"
   },
   "peerDependencies": {
-    "@elizaos/core": "2.0.0-alpha.3"
+    "@elizaos/core": "2.0.11-beta.7",
+    "@elizaos/signal-native": "latest"
+  },
+  "peerDependenciesMeta": {
+    "@elizaos/signal-native": {
+      "optional": true
+    }
   },
   "publishConfig": {
     "access": "public"
@@ -76,7 +110,13 @@
       },
       "SIGNAL_CLI_PATH": {
         "type": "string",
-        "description": "Path to signal-cli executable (alternative to HTTP API)",
+        "description": "Path to signal-cli executable (alternative to HTTP API). Leave blank to resolve signal-cli from PATH and auto-install with Homebrew on macOS/Linux when available; on Windows or without Homebrew, install signal-cli manually and set this path.",
+        "required": false,
+        "sensitive": false
+      },
+      "SIGNAL_CLI_AUTO_INSTALL": {
+        "type": "boolean",
+        "description": "Set false to disable Homebrew auto-install for the default signal-cli binary on macOS/Linux.",
         "required": false,
         "sensitive": false
       },
@@ -88,7 +128,7 @@
       }
     }
   },
-  "milady": {
+  "eliza": {
     "platforms": [
       "node"
     ],
@@ -96,5 +136,6 @@
     "platformDetails": {
       "node": "Default export (Node.js)"
     }
-  }
+  },
+  "gitHead": "cdbc876f793d96073d7eb0d09715a031ce0cd32e"
 }