commune-ai 0.2.2 → 0.2.4

package/README.md

@@ -263,6 +263,95 @@ export COMMUNE_API_KEY="your_key_from_dashboard"
 
 ---
 
+## Structured extraction (per inbox)
+You can attach a **JSON schema** to a specific inbox so Commune extracts structured data from inbound emails.
+
+### 1) Add a schema to an inbox (dashboard)
+In **Dashboard → Inboxes**, open an inbox and add a Structured Extraction schema. Save it and enable extraction.
+
+### 2) Set the schema via SDK (optional)
+```ts
+await client.inboxes.setExtractionSchema({
+  domainId: "domain-123",
+  inboxId: "inbox-456",
+  schema: {
+    name: "invoice_extraction",
+    description: "Extract invoice details",
+    enabled: true,
+    schema: {
+      type: "object",
+      properties: {
+        invoiceNumber: { type: "string" },
+        amount: { type: "number" },
+        dueDate: { type: "string" }
+      },
+      required: ["invoiceNumber", "amount"],
+      additionalProperties: false
+    }
+  }
+});
+```
+
+### 3) Read extracted data in your webhook
+The webhook payload includes the structured output when extraction is enabled.
+
+```ts
+const handler = createWebhookHandler({
+  onEvent: async (message, context) => {
+    const extracted = context.payload.extractedData
+      || message.metadata?.extracted_data
+      || null;
+
+    if (extracted) {
+      // use structured fields in your agent workflow
+      console.log("Extracted:", extracted);
+    }
+  },
+});
+```
+
+> Tip: Keep your schema minimal (only the fields you need). You can evolve it over time.
+
+### Example: Invoice extraction (end-to-end)
+```ts
+import { CommuneClient, createWebhookHandler } from "@commune/sdk";
+
+const client = new CommuneClient({ apiKey: process.env.COMMUNE_API_KEY! });
+
+await client.inboxes.setExtractionSchema({
+  domainId: "domain-123",
+  inboxId: "inbox-456",
+  schema: {
+    name: "invoice_extraction",
+    enabled: true,
+    schema: {
+      type: "object",
+      properties: {
+        invoiceNumber: { type: "string" },
+        amount: { type: "number" },
+        vendor: { type: "string" }
+      },
+      required: ["invoiceNumber", "amount"],
+      additionalProperties: false
+    }
+  }
+});
+
+const handler = createWebhookHandler({
+  onEvent: async (message, context) => {
+    const extracted = context.payload.extractedData;
+    if (!extracted) return;
+
+    console.log("Invoice:", extracted.invoiceNumber);
+    console.log("Amount:", extracted.amount);
+
+    await processInvoice(extracted);
+  },
+});
+```
+
+---
+
 ## Webhook verification (Commune → your app)
 Commune signs outbound webhooks using your **inbox webhook secret**. Verify the
 signature before processing the request.

package/dist/client.d.ts

@@ -19,11 +19,6 @@ export declare class CommuneClient {
         verify: (domainId: string) => Promise<Record<string, unknown>>;
         records: (domainId: string) => Promise<unknown[]>;
         status: (domainId: string) => Promise<Record<string, unknown>>;
-        createWebhook: (domainId: string, payload?: {
-            endpoint?: string;
-            events?: string[];
-        }) => Promise<Record<string, unknown>>;
-        saveWebhookSecret: (domainId: string, secret: string) => Promise<Record<string, unknown>>;
     };
     inboxes: {
         list: (domainId: string) => Promise<InboxEntry[]>;
@@ -46,6 +41,20 @@ export declare class CommuneClient {
             endpoint: string;
             events?: string[];
         }) => Promise<InboxEntry>;
+        setExtractionSchema: (payload: {
+            domainId: string;
+            inboxId: string;
+            schema: {
+                name: string;
+                description?: string;
+                enabled?: boolean;
+                schema: Record<string, any>;
+            };
+        }) => Promise<InboxEntry>;
+        removeExtractionSchema: (payload: {
+            domainId: string;
+            inboxId: string;
+        }) => Promise<InboxEntry>;
     };
     messages: {
         send: (payload: SendMessagePayload) => Promise<Record<string, unknown>>;

package/dist/client.js

@@ -38,15 +38,6 @@ export class CommuneClient {
             status: async (domainId) => {
                 return this.request(`/api/domains/${encodeURIComponent(domainId)}/status`);
             },
-            createWebhook: async (domainId, payload) => {
-                return this.request(`/api/domains/${encodeURIComponent(domainId)}/webhook`, {
-                    method: 'POST',
-                    json: payload,
-                });
-            },
-            saveWebhookSecret: async (domainId, secret) => {
-                return this.request(`/api/domains/${encodeURIComponent(domainId)}/webhook/secret`, { method: 'POST', json: { secret } });
-            },
         };
         this.inboxes = {
             list: async (domainId) => {
@@ -70,14 +61,20 @@ export class CommuneClient {
             setWebhook: async (domainId, inboxId, payload) => {
                 return this.request(`/api/domains/${encodeURIComponent(domainId)}/inboxes/${encodeURIComponent(inboxId)}/webhook`, { method: 'POST', json: payload });
             },
+            setExtractionSchema: async (payload) => {
+                const { domainId, inboxId, schema } = payload;
+                return this.request(`/api/domains/${encodeURIComponent(domainId)}/inboxes/${encodeURIComponent(inboxId)}/extraction-schema`, { method: 'PUT', json: schema });
+            },
+            removeExtractionSchema: async (payload) => {
+                const { domainId, inboxId } = payload;
+                return this.request(`/api/domains/${encodeURIComponent(domainId)}/inboxes/${encodeURIComponent(inboxId)}/extraction-schema`, { method: 'DELETE' });
+            },
         };
         this.messages = {
             send: async (payload) => {
-                // Always send as email (Slack support coming soon)
-                const emailPayload = { ...payload, channel: 'email' };
                 return this.request('/api/messages/send', {
                     method: 'POST',
-                    json: emailPayload,
+                    json: payload,
                 });
             },
             list: async (params) => {
@@ -99,10 +96,8 @@ export class CommuneClient {
                 })}`);
             },
         };
-        // Semantic search across all organizational emails (coming soon)
+        // Semantic search across all organizational emails
         this.search = async (params) => {
-            // Placeholder for future semantic search implementation
-            // This will search across all emails in the organization
             return this.request(`/api/search${buildQuery({
                 q: params.query,
                 limit: params.limit || 10,
@@ -117,16 +112,10 @@ export class CommuneClient {
                 return this.request(`/api/attachments/${encodeURIComponent(attachmentId)}`);
             },
         };
-        if (!options.apiKey) {
-            throw new Error('API key is required. Get one from your Commune dashboard at https://commune.ai');
-        }
         this.baseUrl = (options.baseUrl || DEFAULT_BASE_URL).replace(/\/$/, '');
         this.apiKey = options.apiKey;
         this.headers = options.headers;
         this.fetcher = options.fetcher || fetch;
-        if (!this.apiKey) {
-            throw new Error('CommuneClient requires apiKey');
-        }
     }
     async request(path, options = {}) {
         const { json, headers, ...rest } = options;

package/dist/index.js

@@ -1,3 +1,3 @@
 export { CommuneClient } from './client.js';
-export { verifyResendWebhook, verifySlackWebhook, verifyCommuneWebhook } from './webhooks.js';
+export { verifyResendWebhook } from './webhooks.js';
 export { createWebhookHandler } from './listener.js';

package/dist/types.d.ts

@@ -17,6 +17,7 @@ export interface MessageMetadata {
     message_id?: string | null;
     provider?: 'resend' | 'email' | string;
     raw?: unknown;
+    extracted_data?: Record<string, any>;
 }
 export interface UnifiedMessage {
     _id?: string;
@@ -63,6 +64,12 @@ export interface InboxEntry {
         metadata?: Record<string, unknown>;
     };
     webhook?: InboxWebhook;
+    extractionSchema?: {
+        name: string;
+        description?: string;
+        schema: Record<string, any>;
+        enabled: boolean;
+    };
     createdAt?: string;
     status?: string;
 }
@@ -132,6 +139,7 @@ export interface InboundEmailWebhookPayload {
     event: unknown;
     email: unknown;
     message: UnifiedMessage;
+    extractedData?: Record<string, any>;
 }
 export interface ApiError {
     message?: string;

package/dist/webhooks.js

@@ -1,4 +1,3 @@
-import crypto from 'crypto';
 import { Webhook } from 'svix';
 export const verifyResendWebhook = (payload, headers, secret) => {
     const webhook = new Webhook(secret);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commune-ai",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "Our email infrastructure - webhooks, threads, history, and semantic search",
   "type": "module",
   "main": "dist/index.js",
@@ -15,9 +15,30 @@
     "dist",
     "README.md"
   ],
+  "keywords": [
+    "email",
+    "slack",
+    "ai",
+    "agent",
+    "webhook",
+    "communication",
+    "inbox",
+    "api"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/commune-ai/commune"
+  },
+  "homepage": "https://github.com/commune-ai/commune#readme",
+  "bugs": {
+    "url": "https://github.com/commune-ai/commune/issues"
+  },
   "scripts": {
     "build": "tsc -p tsconfig.json",
-    "clean": "rm -rf dist"
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run clean && npm run build",
+    "prepack": "npm run build"
   },
   "dependencies": {
     "svix": "^1.44.0"