commune-ai 0.1.3 → 0.1.5

package/README.md

@@ -36,14 +36,8 @@ pnpm add commune-ai
 2. Sign up and create an organization
 3. Go to **Domains** → Click **"Add Domain"**
 4. Enter a subdomain (e.g., `agent.yourcompany.com`)
-5. Click **"Create"** - DNS records will be shown
-6. Add these DNS records to your DNS provider:
-   ```
-   Type: MX    Name: agent    Value: feedback-smtp.us-east-1.amazonses.com    Priority: 10
-   Type: CNAME Name: _dmarc.agent    Value: _dmarc.agent.yourcompany.com
-   Type: TXT   Name: agent    Value: v=spf1 include:amazonses.com ~all
-   Type: TXT   Name: _dmarc.agent    Value: v=DMARC1; p=quarantine; rua=mailto:dmarc@yourcompany.com
-   ```
+5. Click **"Create"** - The dashboard will show DNS records to add
+6. Add the DNS records shown in the dashboard to your DNS provider
 7. Click **"Verify"** in the dashboard (wait 5-10 minutes for DNS propagation)
 
 ### 2. Create Inbox
@@ -226,11 +220,179 @@ const searchResults = await client.search({
 });
 
 console.log(`Found ${searchResults.length} relevant emails`);
-for (const result of searchResults) {
+```
+
+---
+
+## Manage Inboxes Programmatically
+
+Create and manage email inboxes for your agents programmatically.
+
+### Create Multiple Inboxes
+
+Set up different inboxes for different purposes:
+
+```ts
+import { CommuneClient } from "commune-ai";
+
+const client = new CommuneClient({
+  apiKey: process.env.COMMUNE_API_KEY,
+});
+
+// Create inboxes for different departments
+async function setupInboxes(domainId: string) {
+  const supportInbox = await client.inboxes.create(domainId, {
+    localPart: "support",  // Creates support@yourdomain.com
+    agent: {
+      id: "support-agent",
+      name: "Support Bot",
+      metadata: { department: "customer-success" }
+    },
+    status: "active",
+  });
+
+  const salesInbox = await client.inboxes.create(domainId, {
+    localPart: "sales",  // Creates sales@yourdomain.com
+    agent: {
+      id: "sales-agent",
+      name: "Sales Bot",
+      metadata: { department: "sales" }
+    },
+    status: "active",
+  });
+
+  return { supportInbox, salesInbox };
+}
+```
+
+### Set Webhooks for Specific Inboxes
+
+Configure webhooks per inbox to route emails to different handlers:
+
+```ts
+async function configureWebhooks(domainId: string, inboxes: any) {
+  // Support inbox webhook
+  await client.inboxes.setWebhook(domainId, inboxes.supportInbox.id, {
+    endpoint: "https://your-api.com/webhooks/support",
+    events: ["email.received"],
+  });
+
+  // Sales inbox webhook
+  await client.inboxes.setWebhook(domainId, inboxes.salesInbox.id, {
+    endpoint: "https://your-api.com/webhooks/sales",
+    events: ["email.received"],
+  });
+}
+```
+
+### List and Manage Inboxes
+
+```ts
+// List all inboxes for a domain
+const inboxes = await client.inboxes.list(domainId);
+console.log(`Found ${inboxes.length} inboxes`);
+
+// Update an inbox
+await client.inboxes.update(domainId, inboxId, {
+  localPart: "help",  // Change from "support" to "help"
+  status: "active",
+});
+
+// Delete an inbox
+await client.inboxes.remove(domainId, inboxId);
+```
+
+---
+
+## Listen for Specific Inbox Events
+
+Route incoming emails based on which inbox received them:
+
+```ts
+import { createWebhookHandler } from "commune-ai";
+
+const handler = createWebhookHandler({
+  onEvent: async (message, context) => {
+    const { inboxId, inboxAddress } = context.payload;
+
+    console.log(`📧 Email received at: ${inboxAddress}`);
+
+    // Route to different handlers based on inbox
+    if (inboxAddress?.includes("support")) {
+      await handleSupportEmail(message, context);
+    } else if (inboxAddress?.includes("sales")) {
+      await handleSalesEmail(message, context);
+    } else {
+      // Default handler for other inboxes
+      await handleGeneralEmail(message, context);
+    }
+  },
+});
+
+// Example handlers
+async function handleSupportEmail(message: any, context: any) {
+  const sender = message.participants.find(p => p.role === "sender")?.identity;
+  if (sender) {
+    await client.messages.send({
+      to: sender,
+      text: "Thanks for contacting support! We'll get back to you soon.",
+      conversation_id: message.conversation_id,
+      domainId: context.payload.domainId,
+      inboxId: context.payload.inboxId,
+    });
+  }
+}
+
+async function handleSalesEmail(message: any, context: any) {
+  const sender = message.participants.find(p => p.role === "sender")?.identity;
+  if (sender) {
+    await client.messages.send({
+      to: sender,
+      text: "Thanks for your interest! A sales representative will contact you.",
+      conversation_id: message.conversation_id,
+      domainId: context.payload.domainId,
+      inboxId: context.payload.inboxId,
+    });
+  }
+}
+```
+
+---
+
+## Semantic Search (Coming Soon)
+
+Search across all emails in your organization using natural language queries.
+
+```ts
+import { CommuneClient } from "commune-ai";
+
+const client = new CommuneClient({
+  apiKey: process.env.COMMUNE_API_KEY,
+});
+
+// Find emails similar to a query
+const results = await client.search({
+  query: "What were the pricing questions from last week?",
+  limit: 10,
+  threshold: 0.7, // Similarity threshold 0-1
+  before: "2024-12-31", // Only search recent emails
+  sender: "customer@example.com", // Filter by sender (optional)
+});
+
+console.log(`Found ${results.length} relevant emails:`);
+for (const result of results) {
   console.log(`Match (${result.similarity.toFixed(2)}): ${result.message.content}`);
+  console.log(`Highlights: ${result.highlights.join(", ")}`);
 }
 ```
 
+**What you get:**
+- **Natural language queries** - Search like "pricing issues from enterprise customers"
+- **Similarity scores** - Ranked results by relevance (0-1)
+- **Highlighted matches** - Text snippets showing why the email matched
+- **Filtering options** - By date range, sender, or other criteria
+- **Fast results** - AI-powered semantic matching
+
 ---
 
 ## Complete agent example

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commune-ai",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Email infrastructure for AI agents - webhooks, threads, history, and semantic search",
   "type": "module",
   "main": "dist/index.js",