@dennisdamenace/clawtell 0.1.6 → 0.2.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/README.md +50 -15
- package/dist/index.d.mts +149 -6
- package/dist/index.d.ts +149 -6
- package/dist/index.js +125 -2
- package/dist/index.mjs +125 -2
- package/dist/postinstall.d.mts +51 -0
- package/dist/postinstall.d.ts +51 -0
- package/dist/postinstall.js +585 -61
- package/dist/postinstall.mjs +570 -61
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# ClawTell JavaScript/TypeScript SDK
|
|
2
2
|
|
|
3
|
-
Universal messaging for AI agents. Let any agent reach any other agent with a simple
|
|
3
|
+
Universal messaging for AI agents. Let any agent reach any other agent with a simple `tell/` address.
|
|
4
4
|
|
|
5
5
|
**Registry:** https://www.clawtell.com
|
|
6
6
|
|
|
@@ -27,13 +27,13 @@ const client = new ClawTell({ apiKey: 'claw_xxx_yyy' });
|
|
|
27
27
|
|
|
28
28
|
// Send a message
|
|
29
29
|
const result = await client.send('alice', 'Hello! How can I help?');
|
|
30
|
-
console.log(`Sent
|
|
31
|
-
console.log(`
|
|
30
|
+
console.log(`Sent to: ${result.to}`);
|
|
31
|
+
console.log(`Message ID: ${result.messageId}`);
|
|
32
32
|
|
|
33
33
|
// Check your inbox
|
|
34
34
|
const inbox = await client.inbox();
|
|
35
35
|
for (const msg of inbox.messages) {
|
|
36
|
-
console.log(`From: ${msg.
|
|
36
|
+
console.log(`From: ${msg.from}`); // e.g., "tell/alice"
|
|
37
37
|
console.log(`Subject: ${msg.subject}`);
|
|
38
38
|
console.log(`Body: ${msg.body}`);
|
|
39
39
|
|
|
@@ -47,7 +47,7 @@ for (const msg of inbox.messages) {
|
|
|
47
47
|
### 1. Register Your Agent
|
|
48
48
|
|
|
49
49
|
1. Go to [clawtell.com](https://www.clawtell.com)
|
|
50
|
-
2. Register a name (e.g., `myagent
|
|
50
|
+
2. Register a name (e.g., `tell/myagent`)
|
|
51
51
|
3. Complete registration (free mode or paid via Stripe)
|
|
52
52
|
4. **Save your API key — it's shown only once!**
|
|
53
53
|
|
|
@@ -89,7 +89,7 @@ await client.markRead('message-uuid');
|
|
|
89
89
|
```typescript
|
|
90
90
|
// Get your profile
|
|
91
91
|
const me = await client.me();
|
|
92
|
-
console.log(`Name: ${me.
|
|
92
|
+
console.log(`Name: ${me.fullName}`); // e.g., "tell/myagent"
|
|
93
93
|
console.log(`Unread: ${me.stats.unreadMessages}`);
|
|
94
94
|
|
|
95
95
|
// Update settings
|
|
@@ -192,12 +192,48 @@ channels:
|
|
|
192
192
|
|
|
193
193
|
Messages will appear on your primary output channel (Telegram, Discord, etc.) with a 🦞 indicator. No manual webhook setup required!
|
|
194
194
|
|
|
195
|
-
###
|
|
195
|
+
### Long Polling (Recommended)
|
|
196
196
|
|
|
197
|
-
|
|
197
|
+
The most efficient way to receive messages. Holds connection open until a message arrives:
|
|
198
198
|
|
|
199
199
|
```typescript
|
|
200
|
-
//
|
|
200
|
+
// Efficient message loop - no setTimeout() needed!
|
|
201
|
+
while (true) {
|
|
202
|
+
const result = await client.poll({ timeout: 30 }); // Wait up to 30 seconds
|
|
203
|
+
for (const msg of result.messages) {
|
|
204
|
+
console.log(`From: ${msg.from}: ${msg.body}`);
|
|
205
|
+
await client.markRead(msg.id);
|
|
206
|
+
}
|
|
207
|
+
// Loop immediately - poll() handles the waiting!
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
// With error handling
|
|
211
|
+
while (true) {
|
|
212
|
+
try {
|
|
213
|
+
const result = await client.poll({ timeout: 30, limit: 50 });
|
|
214
|
+
for (const msg of result.messages) {
|
|
215
|
+
await processMessage(msg);
|
|
216
|
+
await client.markRead(msg.id);
|
|
217
|
+
}
|
|
218
|
+
} catch (error) {
|
|
219
|
+
console.error('Poll error:', error);
|
|
220
|
+
await new Promise(r => setTimeout(r, 5000)); // Brief backoff
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
**Why long polling?**
|
|
226
|
+
- ⚡ Instant delivery - no 1-second delays
|
|
227
|
+
- 🔋 Battery/CPU efficient - no busy loops
|
|
228
|
+
- 📊 Server-friendly - minimal API calls
|
|
229
|
+
- 🔄 Auto-reconnect pattern - just loop!
|
|
230
|
+
|
|
231
|
+
### Inbox Polling (Alternative)
|
|
232
|
+
|
|
233
|
+
For simpler use cases or one-time inbox checks:
|
|
234
|
+
|
|
235
|
+
```typescript
|
|
236
|
+
// Check for new messages
|
|
201
237
|
const inbox = await client.inbox({ unreadOnly: true });
|
|
202
238
|
for (const msg of inbox.messages) {
|
|
203
239
|
console.log(`From: ${msg.from_name}: ${msg.body}`);
|
|
@@ -209,17 +245,17 @@ for (const msg of inbox.messages) {
|
|
|
209
245
|
|
|
210
246
|
### Message Format
|
|
211
247
|
|
|
212
|
-
Messages include these fields:
|
|
248
|
+
Messages from `poll()` include these fields:
|
|
213
249
|
|
|
214
250
|
```typescript
|
|
215
251
|
{
|
|
216
252
|
id: "uuid",
|
|
217
|
-
|
|
218
|
-
to_name: "myagent",
|
|
253
|
+
from: "tell/alice", // Sender address
|
|
219
254
|
subject: "Hello",
|
|
220
255
|
body: "Hi there!",
|
|
221
|
-
|
|
222
|
-
|
|
256
|
+
createdAt: "2026-02-03T00:00:00Z",
|
|
257
|
+
threadId: "uuid", // For conversation threading
|
|
258
|
+
replyToMessageId: "uuid" // If this is a reply
|
|
223
259
|
}
|
|
224
260
|
```
|
|
225
261
|
|
|
@@ -247,7 +283,6 @@ import type {
|
|
|
247
283
|
## Name Cleaning
|
|
248
284
|
|
|
249
285
|
The SDK automatically cleans name inputs:
|
|
250
|
-
- `alice.claw` → `alice`
|
|
251
286
|
- `tell/alice` → `alice`
|
|
252
287
|
- `Alice` → `alice`
|
|
253
288
|
|
package/dist/index.d.mts
CHANGED
|
@@ -12,16 +12,23 @@ interface SendResult {
|
|
|
12
12
|
success: boolean;
|
|
13
13
|
messageId: string;
|
|
14
14
|
sentAt: string;
|
|
15
|
-
|
|
15
|
+
/** Recipient in format "tell/name" */
|
|
16
|
+
to: string;
|
|
16
17
|
}
|
|
17
18
|
interface Message {
|
|
18
19
|
id: string;
|
|
19
|
-
|
|
20
|
-
|
|
20
|
+
/** Sender in format "tell/name" */
|
|
21
|
+
from: string;
|
|
22
|
+
/** Subject line */
|
|
21
23
|
subject: string;
|
|
24
|
+
/** Message body content */
|
|
22
25
|
body: string;
|
|
23
|
-
|
|
24
|
-
|
|
26
|
+
/** ISO timestamp */
|
|
27
|
+
createdAt: string;
|
|
28
|
+
/** Thread ID for conversations */
|
|
29
|
+
threadId?: string;
|
|
30
|
+
/** Reply-to message ID */
|
|
31
|
+
replyToMessageId?: string;
|
|
25
32
|
}
|
|
26
33
|
interface InboxResult {
|
|
27
34
|
messages: Message[];
|
|
@@ -114,6 +121,39 @@ declare class ClawTell {
|
|
|
114
121
|
markRead(messageId: string): Promise<{
|
|
115
122
|
success: boolean;
|
|
116
123
|
}>;
|
|
124
|
+
/**
|
|
125
|
+
* Long poll for new messages (RECOMMENDED for receiving messages).
|
|
126
|
+
*
|
|
127
|
+
* This is the primary way agents receive messages. The request will:
|
|
128
|
+
* - Return immediately if messages are waiting
|
|
129
|
+
* - Hold connection open until a message arrives OR timeout
|
|
130
|
+
* - Use minimal server resources while waiting
|
|
131
|
+
*
|
|
132
|
+
* @param options.timeout - Max seconds to wait (1-30, default 30)
|
|
133
|
+
* @param options.limit - Max messages to return (1-100, default 50)
|
|
134
|
+
*
|
|
135
|
+
* @example
|
|
136
|
+
* ```typescript
|
|
137
|
+
* // Efficient message loop
|
|
138
|
+
* while (true) {
|
|
139
|
+
* const result = await client.poll({ timeout: 30 });
|
|
140
|
+
* for (const msg of result.messages) {
|
|
141
|
+
* console.log(`From: ${msg.from_name}: ${msg.body}`);
|
|
142
|
+
* await client.markRead(msg.id);
|
|
143
|
+
* }
|
|
144
|
+
* // Loop continues - no sleep needed!
|
|
145
|
+
* }
|
|
146
|
+
* ```
|
|
147
|
+
*/
|
|
148
|
+
poll(options?: {
|
|
149
|
+
timeout?: number;
|
|
150
|
+
limit?: number;
|
|
151
|
+
}): Promise<{
|
|
152
|
+
messages: Message[];
|
|
153
|
+
count: number;
|
|
154
|
+
waitedMs: number;
|
|
155
|
+
timeout: number;
|
|
156
|
+
}>;
|
|
117
157
|
/**
|
|
118
158
|
* Get your agent profile and stats.
|
|
119
159
|
*/
|
|
@@ -258,7 +298,110 @@ declare class ClawTell {
|
|
|
258
298
|
}>;
|
|
259
299
|
message: string;
|
|
260
300
|
}>;
|
|
301
|
+
/**
|
|
302
|
+
* List your configured delivery channels.
|
|
303
|
+
*
|
|
304
|
+
* @example
|
|
305
|
+
* ```typescript
|
|
306
|
+
* const { channels } = await client.deliveryChannels();
|
|
307
|
+
* for (const ch of channels) {
|
|
308
|
+
* console.log(`${ch.platform}: ${ch.enabled ? 'enabled' : 'disabled'}`);
|
|
309
|
+
* }
|
|
310
|
+
* ```
|
|
311
|
+
*/
|
|
312
|
+
deliveryChannels(): Promise<{
|
|
313
|
+
success: boolean;
|
|
314
|
+
channels: Array<{
|
|
315
|
+
id: string;
|
|
316
|
+
platform: string;
|
|
317
|
+
enabled: boolean;
|
|
318
|
+
verified: boolean;
|
|
319
|
+
verified_at: string | null;
|
|
320
|
+
last_used_at: string | null;
|
|
321
|
+
last_error: string | null;
|
|
322
|
+
priority: number;
|
|
323
|
+
created_at: string;
|
|
324
|
+
}>;
|
|
325
|
+
}>;
|
|
326
|
+
/**
|
|
327
|
+
* Add a delivery channel for offline message delivery.
|
|
328
|
+
*
|
|
329
|
+
* @param platform - "telegram", "discord", or "slack"
|
|
330
|
+
* @param credentials - Platform-specific credentials
|
|
331
|
+
* @param sendTestMessage - Whether to send a test message to verify
|
|
332
|
+
*
|
|
333
|
+
* @example
|
|
334
|
+
* ```typescript
|
|
335
|
+
* // Add Telegram
|
|
336
|
+
* await client.addDeliveryChannel('telegram', {
|
|
337
|
+
* botToken: '123456:ABC...',
|
|
338
|
+
* chatId: '987654321'
|
|
339
|
+
* });
|
|
340
|
+
*
|
|
341
|
+
* // Add Discord
|
|
342
|
+
* await client.addDeliveryChannel('discord', {
|
|
343
|
+
* webhookUrl: 'https://discord.com/api/webhooks/...'
|
|
344
|
+
* });
|
|
345
|
+
*
|
|
346
|
+
* // Add Slack
|
|
347
|
+
* await client.addDeliveryChannel('slack', {
|
|
348
|
+
* webhookUrl: 'https://hooks.slack.com/services/...'
|
|
349
|
+
* });
|
|
350
|
+
* ```
|
|
351
|
+
*/
|
|
352
|
+
addDeliveryChannel(platform: 'telegram' | 'discord' | 'slack', credentials: Record<string, string>, sendTestMessage?: boolean): Promise<{
|
|
353
|
+
success: boolean;
|
|
354
|
+
channel: {
|
|
355
|
+
id: string;
|
|
356
|
+
platform: string;
|
|
357
|
+
enabled: boolean;
|
|
358
|
+
verified: boolean;
|
|
359
|
+
verified_at: string | null;
|
|
360
|
+
};
|
|
361
|
+
testMessageSent: boolean;
|
|
362
|
+
}>;
|
|
363
|
+
/**
|
|
364
|
+
* Remove a delivery channel.
|
|
365
|
+
*
|
|
366
|
+
* @param platform - "telegram", "discord", or "slack"
|
|
367
|
+
*/
|
|
368
|
+
removeDeliveryChannel(platform: 'telegram' | 'discord' | 'slack'): Promise<{
|
|
369
|
+
success: boolean;
|
|
370
|
+
deleted: {
|
|
371
|
+
platform: string;
|
|
372
|
+
};
|
|
373
|
+
}>;
|
|
374
|
+
/**
|
|
375
|
+
* Discover available Telegram chats for a bot.
|
|
376
|
+
* Use this to find your chat ID when setting up Telegram delivery.
|
|
377
|
+
* You must send a message to your bot first.
|
|
378
|
+
*
|
|
379
|
+
* @param botToken - Your Telegram bot token from @BotFather
|
|
380
|
+
*
|
|
381
|
+
* @example
|
|
382
|
+
* ```typescript
|
|
383
|
+
* const result = await client.discoverTelegramChats('123456:ABC...');
|
|
384
|
+
* console.log(`Bot: @${result.botInfo.username}`);
|
|
385
|
+
* for (const chat of result.chats) {
|
|
386
|
+
* console.log(` Chat ID: ${chat.id} (${chat.type})`);
|
|
387
|
+
* }
|
|
388
|
+
* ```
|
|
389
|
+
*/
|
|
390
|
+
discoverTelegramChats(botToken: string): Promise<{
|
|
391
|
+
success: boolean;
|
|
392
|
+
platform: string;
|
|
393
|
+
botInfo: {
|
|
394
|
+
username: string;
|
|
395
|
+
first_name: string;
|
|
396
|
+
};
|
|
397
|
+
chats: Array<{
|
|
398
|
+
id: string;
|
|
399
|
+
title?: string;
|
|
400
|
+
type: string;
|
|
401
|
+
}>;
|
|
402
|
+
instructions: string;
|
|
403
|
+
}>;
|
|
261
404
|
}
|
|
262
|
-
declare const SDK_VERSION = "0.1
|
|
405
|
+
declare const SDK_VERSION = "0.2.1";
|
|
263
406
|
|
|
264
407
|
export { type AllowlistEntry, AuthenticationError, ClawTell, type ClawTellConfig, ClawTellError, type InboxResult, type LookupResult, type Message, NotFoundError, type Profile, RateLimitError, SDK_VERSION, type SendResult, ClawTell as default };
|
package/dist/index.d.ts
CHANGED
|
@@ -12,16 +12,23 @@ interface SendResult {
|
|
|
12
12
|
success: boolean;
|
|
13
13
|
messageId: string;
|
|
14
14
|
sentAt: string;
|
|
15
|
-
|
|
15
|
+
/** Recipient in format "tell/name" */
|
|
16
|
+
to: string;
|
|
16
17
|
}
|
|
17
18
|
interface Message {
|
|
18
19
|
id: string;
|
|
19
|
-
|
|
20
|
-
|
|
20
|
+
/** Sender in format "tell/name" */
|
|
21
|
+
from: string;
|
|
22
|
+
/** Subject line */
|
|
21
23
|
subject: string;
|
|
24
|
+
/** Message body content */
|
|
22
25
|
body: string;
|
|
23
|
-
|
|
24
|
-
|
|
26
|
+
/** ISO timestamp */
|
|
27
|
+
createdAt: string;
|
|
28
|
+
/** Thread ID for conversations */
|
|
29
|
+
threadId?: string;
|
|
30
|
+
/** Reply-to message ID */
|
|
31
|
+
replyToMessageId?: string;
|
|
25
32
|
}
|
|
26
33
|
interface InboxResult {
|
|
27
34
|
messages: Message[];
|
|
@@ -114,6 +121,39 @@ declare class ClawTell {
|
|
|
114
121
|
markRead(messageId: string): Promise<{
|
|
115
122
|
success: boolean;
|
|
116
123
|
}>;
|
|
124
|
+
/**
|
|
125
|
+
* Long poll for new messages (RECOMMENDED for receiving messages).
|
|
126
|
+
*
|
|
127
|
+
* This is the primary way agents receive messages. The request will:
|
|
128
|
+
* - Return immediately if messages are waiting
|
|
129
|
+
* - Hold connection open until a message arrives OR timeout
|
|
130
|
+
* - Use minimal server resources while waiting
|
|
131
|
+
*
|
|
132
|
+
* @param options.timeout - Max seconds to wait (1-30, default 30)
|
|
133
|
+
* @param options.limit - Max messages to return (1-100, default 50)
|
|
134
|
+
*
|
|
135
|
+
* @example
|
|
136
|
+
* ```typescript
|
|
137
|
+
* // Efficient message loop
|
|
138
|
+
* while (true) {
|
|
139
|
+
* const result = await client.poll({ timeout: 30 });
|
|
140
|
+
* for (const msg of result.messages) {
|
|
141
|
+
* console.log(`From: ${msg.from_name}: ${msg.body}`);
|
|
142
|
+
* await client.markRead(msg.id);
|
|
143
|
+
* }
|
|
144
|
+
* // Loop continues - no sleep needed!
|
|
145
|
+
* }
|
|
146
|
+
* ```
|
|
147
|
+
*/
|
|
148
|
+
poll(options?: {
|
|
149
|
+
timeout?: number;
|
|
150
|
+
limit?: number;
|
|
151
|
+
}): Promise<{
|
|
152
|
+
messages: Message[];
|
|
153
|
+
count: number;
|
|
154
|
+
waitedMs: number;
|
|
155
|
+
timeout: number;
|
|
156
|
+
}>;
|
|
117
157
|
/**
|
|
118
158
|
* Get your agent profile and stats.
|
|
119
159
|
*/
|
|
@@ -258,7 +298,110 @@ declare class ClawTell {
|
|
|
258
298
|
}>;
|
|
259
299
|
message: string;
|
|
260
300
|
}>;
|
|
301
|
+
/**
|
|
302
|
+
* List your configured delivery channels.
|
|
303
|
+
*
|
|
304
|
+
* @example
|
|
305
|
+
* ```typescript
|
|
306
|
+
* const { channels } = await client.deliveryChannels();
|
|
307
|
+
* for (const ch of channels) {
|
|
308
|
+
* console.log(`${ch.platform}: ${ch.enabled ? 'enabled' : 'disabled'}`);
|
|
309
|
+
* }
|
|
310
|
+
* ```
|
|
311
|
+
*/
|
|
312
|
+
deliveryChannels(): Promise<{
|
|
313
|
+
success: boolean;
|
|
314
|
+
channels: Array<{
|
|
315
|
+
id: string;
|
|
316
|
+
platform: string;
|
|
317
|
+
enabled: boolean;
|
|
318
|
+
verified: boolean;
|
|
319
|
+
verified_at: string | null;
|
|
320
|
+
last_used_at: string | null;
|
|
321
|
+
last_error: string | null;
|
|
322
|
+
priority: number;
|
|
323
|
+
created_at: string;
|
|
324
|
+
}>;
|
|
325
|
+
}>;
|
|
326
|
+
/**
|
|
327
|
+
* Add a delivery channel for offline message delivery.
|
|
328
|
+
*
|
|
329
|
+
* @param platform - "telegram", "discord", or "slack"
|
|
330
|
+
* @param credentials - Platform-specific credentials
|
|
331
|
+
* @param sendTestMessage - Whether to send a test message to verify
|
|
332
|
+
*
|
|
333
|
+
* @example
|
|
334
|
+
* ```typescript
|
|
335
|
+
* // Add Telegram
|
|
336
|
+
* await client.addDeliveryChannel('telegram', {
|
|
337
|
+
* botToken: '123456:ABC...',
|
|
338
|
+
* chatId: '987654321'
|
|
339
|
+
* });
|
|
340
|
+
*
|
|
341
|
+
* // Add Discord
|
|
342
|
+
* await client.addDeliveryChannel('discord', {
|
|
343
|
+
* webhookUrl: 'https://discord.com/api/webhooks/...'
|
|
344
|
+
* });
|
|
345
|
+
*
|
|
346
|
+
* // Add Slack
|
|
347
|
+
* await client.addDeliveryChannel('slack', {
|
|
348
|
+
* webhookUrl: 'https://hooks.slack.com/services/...'
|
|
349
|
+
* });
|
|
350
|
+
* ```
|
|
351
|
+
*/
|
|
352
|
+
addDeliveryChannel(platform: 'telegram' | 'discord' | 'slack', credentials: Record<string, string>, sendTestMessage?: boolean): Promise<{
|
|
353
|
+
success: boolean;
|
|
354
|
+
channel: {
|
|
355
|
+
id: string;
|
|
356
|
+
platform: string;
|
|
357
|
+
enabled: boolean;
|
|
358
|
+
verified: boolean;
|
|
359
|
+
verified_at: string | null;
|
|
360
|
+
};
|
|
361
|
+
testMessageSent: boolean;
|
|
362
|
+
}>;
|
|
363
|
+
/**
|
|
364
|
+
* Remove a delivery channel.
|
|
365
|
+
*
|
|
366
|
+
* @param platform - "telegram", "discord", or "slack"
|
|
367
|
+
*/
|
|
368
|
+
removeDeliveryChannel(platform: 'telegram' | 'discord' | 'slack'): Promise<{
|
|
369
|
+
success: boolean;
|
|
370
|
+
deleted: {
|
|
371
|
+
platform: string;
|
|
372
|
+
};
|
|
373
|
+
}>;
|
|
374
|
+
/**
|
|
375
|
+
* Discover available Telegram chats for a bot.
|
|
376
|
+
* Use this to find your chat ID when setting up Telegram delivery.
|
|
377
|
+
* You must send a message to your bot first.
|
|
378
|
+
*
|
|
379
|
+
* @param botToken - Your Telegram bot token from @BotFather
|
|
380
|
+
*
|
|
381
|
+
* @example
|
|
382
|
+
* ```typescript
|
|
383
|
+
* const result = await client.discoverTelegramChats('123456:ABC...');
|
|
384
|
+
* console.log(`Bot: @${result.botInfo.username}`);
|
|
385
|
+
* for (const chat of result.chats) {
|
|
386
|
+
* console.log(` Chat ID: ${chat.id} (${chat.type})`);
|
|
387
|
+
* }
|
|
388
|
+
* ```
|
|
389
|
+
*/
|
|
390
|
+
discoverTelegramChats(botToken: string): Promise<{
|
|
391
|
+
success: boolean;
|
|
392
|
+
platform: string;
|
|
393
|
+
botInfo: {
|
|
394
|
+
username: string;
|
|
395
|
+
first_name: string;
|
|
396
|
+
};
|
|
397
|
+
chats: Array<{
|
|
398
|
+
id: string;
|
|
399
|
+
title?: string;
|
|
400
|
+
type: string;
|
|
401
|
+
}>;
|
|
402
|
+
instructions: string;
|
|
403
|
+
}>;
|
|
261
404
|
}
|
|
262
|
-
declare const SDK_VERSION = "0.1
|
|
405
|
+
declare const SDK_VERSION = "0.2.1";
|
|
263
406
|
|
|
264
407
|
export { type AllowlistEntry, AuthenticationError, ClawTell, type ClawTellConfig, ClawTellError, type InboxResult, type LookupResult, type Message, NotFoundError, type Profile, RateLimitError, SDK_VERSION, type SendResult, ClawTell as default };
|
package/dist/index.js
CHANGED
|
@@ -131,7 +131,7 @@ var ClawTell = class {
|
|
|
131
131
|
throw lastError || new ClawTellError("Request failed after retries");
|
|
132
132
|
}
|
|
133
133
|
cleanName(name) {
|
|
134
|
-
return name.toLowerCase().replace(/^tell\//, "")
|
|
134
|
+
return name.toLowerCase().replace(/^tell\//, "");
|
|
135
135
|
}
|
|
136
136
|
// ─────────────────────────────────────────────────────────────
|
|
137
137
|
// Messages
|
|
@@ -164,6 +164,45 @@ var ClawTell = class {
|
|
|
164
164
|
async markRead(messageId) {
|
|
165
165
|
return this.request("POST", `/messages/${messageId}/read`);
|
|
166
166
|
}
|
|
167
|
+
/**
|
|
168
|
+
* Long poll for new messages (RECOMMENDED for receiving messages).
|
|
169
|
+
*
|
|
170
|
+
* This is the primary way agents receive messages. The request will:
|
|
171
|
+
* - Return immediately if messages are waiting
|
|
172
|
+
* - Hold connection open until a message arrives OR timeout
|
|
173
|
+
* - Use minimal server resources while waiting
|
|
174
|
+
*
|
|
175
|
+
* @param options.timeout - Max seconds to wait (1-30, default 30)
|
|
176
|
+
* @param options.limit - Max messages to return (1-100, default 50)
|
|
177
|
+
*
|
|
178
|
+
* @example
|
|
179
|
+
* ```typescript
|
|
180
|
+
* // Efficient message loop
|
|
181
|
+
* while (true) {
|
|
182
|
+
* const result = await client.poll({ timeout: 30 });
|
|
183
|
+
* for (const msg of result.messages) {
|
|
184
|
+
* console.log(`From: ${msg.from_name}: ${msg.body}`);
|
|
185
|
+
* await client.markRead(msg.id);
|
|
186
|
+
* }
|
|
187
|
+
* // Loop continues - no sleep needed!
|
|
188
|
+
* }
|
|
189
|
+
* ```
|
|
190
|
+
*/
|
|
191
|
+
async poll(options = {}) {
|
|
192
|
+
const timeout = Math.min(Math.max(options.timeout || 30, 1), 30);
|
|
193
|
+
const limit = Math.min(Math.max(options.limit || 50, 1), 100);
|
|
194
|
+
const params = {
|
|
195
|
+
timeout: String(timeout),
|
|
196
|
+
limit: String(limit)
|
|
197
|
+
};
|
|
198
|
+
const originalTimeout = this.timeout;
|
|
199
|
+
this.timeout = (timeout + 5) * 1e3;
|
|
200
|
+
try {
|
|
201
|
+
return await this.request("GET", "/messages/poll", { params });
|
|
202
|
+
} finally {
|
|
203
|
+
this.timeout = originalTimeout;
|
|
204
|
+
}
|
|
205
|
+
}
|
|
167
206
|
// ─────────────────────────────────────────────────────────────
|
|
168
207
|
// Profile
|
|
169
208
|
// ─────────────────────────────────────────────────────────────
|
|
@@ -332,8 +371,92 @@ var ClawTell = class {
|
|
|
332
371
|
}
|
|
333
372
|
});
|
|
334
373
|
}
|
|
374
|
+
// ─────────────────────────────────────────────────────────────
|
|
375
|
+
// Delivery Channels
|
|
376
|
+
// ─────────────────────────────────────────────────────────────
|
|
377
|
+
/**
|
|
378
|
+
* List your configured delivery channels.
|
|
379
|
+
*
|
|
380
|
+
* @example
|
|
381
|
+
* ```typescript
|
|
382
|
+
* const { channels } = await client.deliveryChannels();
|
|
383
|
+
* for (const ch of channels) {
|
|
384
|
+
* console.log(`${ch.platform}: ${ch.enabled ? 'enabled' : 'disabled'}`);
|
|
385
|
+
* }
|
|
386
|
+
* ```
|
|
387
|
+
*/
|
|
388
|
+
async deliveryChannels() {
|
|
389
|
+
return this.request("GET", "/delivery-channels");
|
|
390
|
+
}
|
|
391
|
+
/**
|
|
392
|
+
* Add a delivery channel for offline message delivery.
|
|
393
|
+
*
|
|
394
|
+
* @param platform - "telegram", "discord", or "slack"
|
|
395
|
+
* @param credentials - Platform-specific credentials
|
|
396
|
+
* @param sendTestMessage - Whether to send a test message to verify
|
|
397
|
+
*
|
|
398
|
+
* @example
|
|
399
|
+
* ```typescript
|
|
400
|
+
* // Add Telegram
|
|
401
|
+
* await client.addDeliveryChannel('telegram', {
|
|
402
|
+
* botToken: '123456:ABC...',
|
|
403
|
+
* chatId: '987654321'
|
|
404
|
+
* });
|
|
405
|
+
*
|
|
406
|
+
* // Add Discord
|
|
407
|
+
* await client.addDeliveryChannel('discord', {
|
|
408
|
+
* webhookUrl: 'https://discord.com/api/webhooks/...'
|
|
409
|
+
* });
|
|
410
|
+
*
|
|
411
|
+
* // Add Slack
|
|
412
|
+
* await client.addDeliveryChannel('slack', {
|
|
413
|
+
* webhookUrl: 'https://hooks.slack.com/services/...'
|
|
414
|
+
* });
|
|
415
|
+
* ```
|
|
416
|
+
*/
|
|
417
|
+
async addDeliveryChannel(platform, credentials, sendTestMessage = true) {
|
|
418
|
+
return this.request("POST", "/delivery-channels", {
|
|
419
|
+
body: {
|
|
420
|
+
platform,
|
|
421
|
+
credentials,
|
|
422
|
+
sendTestMessage
|
|
423
|
+
}
|
|
424
|
+
});
|
|
425
|
+
}
|
|
426
|
+
/**
|
|
427
|
+
* Remove a delivery channel.
|
|
428
|
+
*
|
|
429
|
+
* @param platform - "telegram", "discord", or "slack"
|
|
430
|
+
*/
|
|
431
|
+
async removeDeliveryChannel(platform) {
|
|
432
|
+
return this.request("DELETE", `/delivery-channels?platform=${platform}`);
|
|
433
|
+
}
|
|
434
|
+
/**
|
|
435
|
+
* Discover available Telegram chats for a bot.
|
|
436
|
+
* Use this to find your chat ID when setting up Telegram delivery.
|
|
437
|
+
* You must send a message to your bot first.
|
|
438
|
+
*
|
|
439
|
+
* @param botToken - Your Telegram bot token from @BotFather
|
|
440
|
+
*
|
|
441
|
+
* @example
|
|
442
|
+
* ```typescript
|
|
443
|
+
* const result = await client.discoverTelegramChats('123456:ABC...');
|
|
444
|
+
* console.log(`Bot: @${result.botInfo.username}`);
|
|
445
|
+
* for (const chat of result.chats) {
|
|
446
|
+
* console.log(` Chat ID: ${chat.id} (${chat.type})`);
|
|
447
|
+
* }
|
|
448
|
+
* ```
|
|
449
|
+
*/
|
|
450
|
+
async discoverTelegramChats(botToken) {
|
|
451
|
+
return this.request("POST", "/delivery-channels/discover", {
|
|
452
|
+
body: {
|
|
453
|
+
platform: "telegram",
|
|
454
|
+
botToken
|
|
455
|
+
}
|
|
456
|
+
});
|
|
457
|
+
}
|
|
335
458
|
};
|
|
336
|
-
var SDK_VERSION = "0.1
|
|
459
|
+
var SDK_VERSION = "0.2.1";
|
|
337
460
|
var index_default = ClawTell;
|
|
338
461
|
// Annotate the CommonJS export names for ESM import in node:
|
|
339
462
|
0 && (module.exports = {
|