@elizaos/plugin-blooio 2.0.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Shaw Walters and elizaOS Contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,105 @@
1
+ # Blooio Plugin for ElizaOS
2
+
3
+ Integrates Blooio iMessage/SMS messaging into ElizaOS with signed webhooks and outbound message sending.
4
+
5
+ ## Overview
6
+
7
+ The Blooio plugin enables ElizaOS agents to:
8
+
9
+ - Send messages to iMessage/SMS chats (phone, email, or group ID)
10
+ - Receive inbound messages via Blooio webhooks
11
+ - Track recent conversation history per chat
12
+ - Verify webhook signatures using the provided signing secret
13
+
14
+ ## Installation
15
+
16
+ ```bash
17
+ npm install @elizaos/plugin-blooio
18
+ ```
19
+
20
+ ## Configuration
21
+
22
+ ### Environment Variables
23
+
24
+ ```env
25
+ # Required
26
+ BLOOIO_API_KEY=your_blooio_api_key
27
+ BLOOIO_WEBHOOK_URL=https://your-domain.com/webhook
28
+ BLOOIO_WEBHOOK_SECRET=whsec_...
29
+
30
+ # Optional
31
+ BLOOIO_WEBHOOK_PORT=3001
32
+ BLOOIO_WEBHOOK_PATH=/webhook
33
+ BLOOIO_BASE_URL=https://backend.blooio.com/v2/api
34
+ BLOOIO_FROM_NUMBER=+17147023671
35
+ BLOOIO_TEST_CHAT_ID=+15551234567
36
+ ```
37
+
38
+ ### Character Configuration
39
+
40
+ ```typescript
41
+ {
42
+ name: "MyAgent",
43
+ clients: [],
44
+ plugins: ["@elizaos/plugin-blooio"],
45
+ settings: {}
46
+ }
47
+ ```
48
+
49
+ ## Service Architecture
50
+
51
+ ### BlooioService
52
+
53
+ ```typescript
54
+ export class BlooioService extends Service {
55
+ async sendMessage(chatId: string, request: BlooioSendMessageRequest): Promise<BlooioSendMessageResponse>;
56
+ }
57
+ ```
58
+
59
+ ### Webhook Server
60
+
61
+ The plugin starts an Express server and listens on the path derived from `BLOOIO_WEBHOOK_URL`
62
+ or `BLOOIO_WEBHOOK_PATH` if provided. The endpoint verifies `X-Blooio-Signature` using
63
+ `BLOOIO_WEBHOOK_SECRET`.
64
+
65
+ ## Actions
66
+
67
+ ### Send Message
68
+
69
+ ```typescript
70
+ {
71
+ name: "SEND_MESSAGE",
72
+ description: "Send a message via Blooio to a chat (phone, email, or group)"
73
+ }
74
+ ```
75
+
76
+ ## Providers
77
+
78
+ ### Conversation History Provider
79
+
80
+ ```typescript
81
+ {
82
+ name: "blooioConversationHistory",
83
+ description: "Provides recent Blooio conversation history with a chat"
84
+ }
85
+ ```
86
+
87
+ ## Testing
88
+
89
+ Run unit tests:
90
+
91
+ ```bash
92
+ npm run test:unit
93
+ ```
94
+
95
+ To test outbound sending, set `BLOOIO_TEST_CHAT_ID` and run:
96
+
97
+ ```bash
98
+ npm test
99
+ ```
100
+
101
+ ## Security Notes
102
+
103
+ - Always verify webhook signatures in production.
104
+ - Use HTTPS for webhook URLs.
105
+ - Rotate your signing secret if compromised.
@@ -0,0 +1,5 @@
1
+ import { Plugin } from '@elizaos/core';
2
+
3
+ declare const blooioPlugin: Plugin;
4
+
5
+ export { blooioPlugin as default };