commune-ai 0.3.0 → 0.3.1

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import type { AttachmentRecord, AttachmentUrl, AttachmentUploadResponse, CreateDomainPayload, DomainEntry, InboxEntry, MessageListParams, SendMessagePayload, UnifiedMessage, SearchFilter, SearchOptions, SearchResult, IndexConversationPayload, ThreadListParams, ThreadListResponse } from './types.js';
+import type { AttachmentRecord, AttachmentUrl, AttachmentUploadResponse, CreateDomainPayload, DomainEntry, InboxEntry, MessageListParams, SendMessagePayload, UnifiedMessage, SearchFilter, SearchOptions, SearchResult, IndexConversationPayload, ThreadListParams, ThreadListResponse, SearchThreadsParams, SearchThreadResult, ThreadMetadataEntry, DeliveryMetricsParams, DeliveryEventEntry, DeliveryEventsParams, DeliverySuppressionsParams, SuppressionEntry } from './types.js';
 export type ClientOptions = {
     baseUrl?: string;
     apiKey: string;
@@ -6,12 +6,13 @@ export type ClientOptions = {
     fetcher?: typeof fetch;
 };
 export declare class CommuneClient {
-    private searchClient;
     private baseUrl;
     private apiKey;
     private headers?;
     private fetcher;
+    private deprecationWarnings;
     constructor(options: ClientOptions);
+    private warnDeprecated;
     private request;
     domains: {
         list: () => Promise<DomainEntry[]>;
@@ -93,6 +94,9 @@ export declare class CommuneClient {
             order?: "asc" | "desc";
         }) => Promise<UnifiedMessage[]>;
     };
+    search: {
+        threads: (params: SearchThreadsParams) => Promise<SearchThreadResult[]>;
+    };
     conversations: {
         search: (query: string, filter: SearchFilter, options?: SearchOptions) => Promise<SearchResult[]>;
         index: (organizationId: string, conversation: IndexConversationPayload) => Promise<{
@@ -108,6 +112,16 @@ export declare class CommuneClient {
             limit?: number;
             order?: "asc" | "desc";
         }) => Promise<UnifiedMessage[]>;
+        metadata: (threadId: string) => Promise<ThreadMetadataEntry>;
+        setStatus: (threadId: string, status: "open" | "needs_reply" | "waiting" | "closed") => Promise<ThreadMetadataEntry>;
+        addTags: (threadId: string, tags: string[]) => Promise<ThreadMetadataEntry>;
+        removeTags: (threadId: string, tags: string[]) => Promise<ThreadMetadataEntry>;
+        assign: (threadId: string, assignedTo?: string | null) => Promise<ThreadMetadataEntry>;
+    };
+    delivery: {
+        metrics: (params?: DeliveryMetricsParams) => Promise<Record<string, unknown>>;
+        events: (params?: DeliveryEventsParams) => Promise<DeliveryEventEntry[]>;
+        suppressions: (params?: DeliverySuppressionsParams) => Promise<SuppressionEntry[]>;
     };
     attachments: {
         upload: (content: string, filename: string, mimeType: string) => Promise<AttachmentUploadResponse>;

package/dist/client.js

@@ -1,4 +1,3 @@
-import { SearchClient } from './client/search.js';
 const DEFAULT_BASE_URL = 'https://api.commune.email';
 const buildQuery = (params) => {
     const query = new URLSearchParams();
@@ -13,6 +12,7 @@ const buildQuery = (params) => {
 };
 export class CommuneClient {
     constructor(options) {
+        this.deprecationWarnings = new Set();
         this.domains = {
             list: async () => {
                 const response = await this.request(`/v1/domains`);
@@ -136,18 +136,29 @@ export class CommuneClient {
                 })}`);
             },
         };
+        this.search = {
+            threads: async (params) => {
+                return this.request(`/v1/search/threads${buildQuery({
+                    q: params.query,
+                    inbox_id: params.inboxId,
+                    domain_id: params.domainId,
+                    limit: params.limit,
+                })}`);
+            },
+        };
         this.conversations = {
             search: async (query, filter, options) => {
-                return this.request('/v1/search', {
-                    method: 'POST',
-                    json: {
-                        query,
-                        filter,
-                        options,
-                    },
+                this.warnDeprecated('conversations.search', '[commune-ai] `conversations.search` is deprecated. Use `search.threads({ query, inboxId, domainId, limit })`.');
+                const inboxId = filter.inboxIds && filter.inboxIds.length > 0 ? filter.inboxIds[0] : undefined;
+                return this.search.threads({
+                    query,
+                    inboxId,
+                    domainId: filter.domainId,
+                    limit: options?.limit,
                 });
             },
             index: async (organizationId, conversation) => {
+                this.warnDeprecated('conversations.index', '[commune-ai] `conversations.index` is deprecated and will be removed. Indexing is handled automatically.');
                 return this.request('/v1/search/index', {
                     method: 'POST',
                     json: {
@@ -157,6 +168,7 @@ export class CommuneClient {
                 });
             },
             indexBatch: async (organizationId, conversations) => {
+                this.warnDeprecated('conversations.indexBatch', '[commune-ai] `conversations.indexBatch` is deprecated and will be removed. Indexing is handled automatically.');
                 return this.request('/v1/search/index/batch', {
                     method: 'POST',
                     json: {
@@ -193,6 +205,58 @@ export class CommuneClient {
                     order: params?.order,
                 })}`);
             },
+            metadata: async (threadId) => {
+                return this.request(`/v1/threads/${encodeURIComponent(threadId)}/metadata`);
+            },
+            setStatus: async (threadId, status) => {
+                return this.request(`/v1/threads/${encodeURIComponent(threadId)}/status`, {
+                    method: 'PUT',
+                    json: { status },
+                });
+            },
+            addTags: async (threadId, tags) => {
+                return this.request(`/v1/threads/${encodeURIComponent(threadId)}/tags`, {
+                    method: 'POST',
+                    json: { tags },
+                });
+            },
+            removeTags: async (threadId, tags) => {
+                return this.request(`/v1/threads/${encodeURIComponent(threadId)}/tags`, {
+                    method: 'DELETE',
+                    json: { tags },
+                });
+            },
+            assign: async (threadId, assignedTo) => {
+                return this.request(`/v1/threads/${encodeURIComponent(threadId)}/assign`, {
+                    method: 'PUT',
+                    json: { assigned_to: assignedTo ?? null },
+                });
+            },
+        };
+        this.delivery = {
+            metrics: async (params = {}) => {
+                return this.request(`/v1/delivery/metrics${buildQuery({
+                    inbox_id: params.inboxId,
+                    domain_id: params.domainId,
+                    period: params.period,
+                })}`);
+            },
+            events: async (params = {}) => {
+                return this.request(`/v1/delivery/events${buildQuery({
+                    message_id: params.messageId,
+                    inbox_id: params.inboxId,
+                    domain_id: params.domainId,
+                    event_type: params.eventType,
+                    limit: params.limit,
+                })}`);
+            },
+            suppressions: async (params = {}) => {
+                return this.request(`/v1/delivery/suppressions${buildQuery({
+                    inbox_id: params.inboxId,
+                    domain_id: params.domainId,
+                    limit: params.limit,
+                })}`);
+            },
         };
         this.attachments = {
             upload: async (content, filename, mimeType) => {
@@ -213,7 +277,12 @@ export class CommuneClient {
         this.apiKey = options.apiKey;
         this.headers = options.headers;
         this.fetcher = options.fetcher || fetch;
-        this.searchClient = new SearchClient(this.baseUrl, { Authorization: `Bearer ${this.apiKey}` });
+    }
+    warnDeprecated(key, message) {
+        if (this.deprecationWarnings.has(key))
+            return;
+        this.deprecationWarnings.add(key);
+        console.warn(message);
     }
     async request(path, options = {}) {
         const { json, headers, ...rest } = options;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { CommuneClient } from './client.js';
-export type { ApiError, ApiResponse, AttachmentRecord, Channel, ConversationListParams, CreateDomainPayload, CreateInboxPayload, Direction, DomainEntry, DomainWebhook, InboxEntry, InboxWebhook, InboundEmailWebhookPayload, MessageListParams, MessageMetadata, Participant, ParticipantRole, SendMessagePayload, SvixHeaders, Thread, ThreadListParams, ThreadListResponse, UnifiedMessage, } from './types.js';
+export type { ApiError, ApiResponse, AttachmentRecord, Channel, ConversationListParams, CreateDomainPayload, CreateInboxPayload, Direction, DomainEntry, DomainWebhook, InboxEntry, InboxWebhook, InboundEmailWebhookPayload, MessageListParams, MessageMetadata, Participant, ParticipantRole, SendMessagePayload, SearchThreadResult, SearchThreadsParams, ThreadMetadataEntry, SvixHeaders, SuppressionEntry, Thread, DeliveryEventEntry, DeliveryEventsParams, DeliveryMetricsParams, DeliverySuppressionsParams, ThreadListParams, ThreadListResponse, UnifiedMessage, } from './types.js';
 export { verifyResendWebhook, verifyCommuneWebhook, computeCommuneSignature } from './webhooks.js';
 export type { CommuneWebhookHeaders } from './webhooks.js';
 export { createWebhookHandler } from './listener.js';

package/dist/types.d.ts

@@ -305,3 +305,65 @@ export interface ThreadListParams {
     cursor?: string;
     order?: 'asc' | 'desc';
 }
+export interface SearchThreadsParams {
+    query: string;
+    inboxId?: string;
+    domainId?: string;
+    limit?: number;
+}
+export interface SearchThreadResult {
+    thread_id: string;
+    subject?: string | null;
+    score?: number;
+    inbox_id?: string | null;
+    domain_id?: string | null;
+    participants?: string[];
+    direction?: Direction | null;
+}
+export interface ThreadMetadataEntry {
+    thread_id: string;
+    orgId?: string;
+    tags: string[];
+    status: 'open' | 'needs_reply' | 'waiting' | 'closed';
+    assigned_to?: string | null;
+    updated_at?: string;
+}
+export interface DeliveryMetricsParams {
+    inboxId?: string;
+    domainId?: string;
+    period?: string;
+}
+export interface DeliveryEventEntry {
+    _id?: string;
+    message_id: string;
+    event_type: string;
+    event_data: Record<string, unknown>;
+    processed_at?: string;
+    inbox_id?: string;
+    domain_id?: string;
+}
+export interface DeliveryEventsParams {
+    messageId?: string;
+    inboxId?: string;
+    domainId?: string;
+    eventType?: string;
+    limit?: number;
+}
+export interface SuppressionEntry {
+    _id?: string;
+    email: string;
+    reason: string;
+    type: string;
+    source: 'inbox' | 'domain' | 'global';
+    inbox_id?: string;
+    domain_id?: string;
+    created_at?: string;
+    expires_at?: string;
+    message_id?: string;
+    metadata?: Record<string, unknown>;
+}
+export interface DeliverySuppressionsParams {
+    inboxId?: string;
+    domainId?: string;
+    limit?: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commune-ai",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Email infrastructure for agents — set up an inbox and send your first email in 30 seconds. Programmatic inboxes (~1 line), consistent threads, custom domains, attachments, and structured data.",
   "type": "module",
   "main": "dist/index.js",