wexa-chat 0.1.35 → 0.2.0

package/README.md

@@ -121,7 +121,7 @@ export type InitOptions = {
   - `searchByParticipantPair({ organizationId, a, b })`
 
 - Messages
-  - `sendMessage({ organizationId, conversationId, senderModel, senderId, text, kind?, parentMessageId?, rootThreadId? })`
+  - `sendMessage({ organizationId, conversationId, senderModel, senderId, text, source, kind?, parentMessageId?, rootThreadId? })`
   - `listMessages({ organizationId, conversationId, limit?, cursor? })`
   - `listMessagesWithSenders({ organizationId, conversationId, limit?, cursor?, populateSenders: true, populateOptions? })`
   - `markRead({ organizationId, conversationId, participantModel, participantId, messageId })`
@@ -209,6 +209,24 @@ The method returns messages sorted by creation time (newest first), making it id
 
 The type `MessageWithSender` is exported from the package for proper TypeScript support.
 
+### Message Source
+
+Messages now include a required `source` field (array) to indicate one or more origins for a message. The model enforces `source` values via an enum of strings:
+
+```ts
+export const sourceType = {
+  LINKEDIN: 'linkedin',
+  WHATSAPP: 'whatsapp',
+  EMAIL: 'email',
+  CORE: 'core',
+} as const;
+
+export type SourceType = (typeof sourceType)[keyof typeof sourceType];
+```
+
+When sending a message via `sendMessage`, you must provide `source: SourceType[]`.
+For internal server-generated messages, use `[sourceType.CORE]`.
+
 ## Models
 
 The package exports the following model types which can be imported directly:

package/dist/index.d.cts

@@ -108,8 +108,75 @@ type InitOptions = {
         sendPerMin?: number;
         typingPerMin?: number;
     };
+    /**
+     * Optional external data service endpoint accessible across the package
+     */
+    dataServiceEndpoint?: string;
+    /**
+     * Optional secret id to access the external service
+     */
+    secretId?: string;
+};
+
+declare const sourceType: {
+    readonly LINKEDIN: "linkedin";
+    readonly WHATSAPP: "whatsapp";
+    readonly EMAIL: "email";
+    readonly CORE: "core";
+};
+type SourceType = (typeof sourceType)[keyof typeof sourceType];
+interface IMessage extends Document {
+    organizationId: string;
+    conversationId: string;
+    senderModel: string;
+    senderId: string;
+    text: string;
+    kind: 'text' | 'system';
+    source: SourceType[];
+    failed_source?: Array<{
+        source: string;
+        message: string;
+    }>;
+    parentMessageId?: string;
+    rootThreadId?: string;
+    editedAt?: Date;
+    deletedAt?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+}
+/**
+ * Create (or retrieve) Message model safely
+ */
+declare function createMessageModel(options: InitOptions, conn?: Connection): Model<IMessage>;
+
+declare const modelRegistry: Map<string, mongoose.Model<any, {}, {}, {}, any, any>>;
+/**
+ * Create Mongoose models with applied configuration
+ * @param mongooseInstance Mongoose instance
+ * @param options Initialization options
+ * @returns Object containing Conversation and Message models
+ */
+declare function createModels(mongooseInstance: typeof mongoose, options: InitOptions): {
+    Conversation: mongoose.Model<IConversation, {}, {}, {}, mongoose.Document<unknown, {}, IConversation> & IConversation & {
+        _id: mongoose.Types.ObjectId;
+    }, any> | mongoose.Model<any, {}, {}, {}, any, any>;
+    Message: mongoose.Model<IMessage, {}, {}, {}, mongoose.Document<unknown, {}, IMessage> & IMessage & {
+        _id: mongoose.Types.ObjectId;
+    }, any> | mongoose.Model<any, {}, {}, {}, any, any>;
 };
 
+/**
+ * Ensure all indexes are created on models
+ * @param models Object containing Mongoose models
+ */
+declare function ensureIndexes(models: {
+    Conversation: Model<IConversation>;
+    Message: Model<IMessage>;
+}): Promise<void>;
+
+type ConversationModel = Model<IConversation>;
+type MessageModel = Model<IMessage>;
+
 type CreateConversationArgs = {
     organizationId: string;
     a: {
@@ -126,10 +193,15 @@ type SendMessageArgs = {
     conversationId: string;
     senderModel: string;
     senderId: string;
+    source: SourceType[];
     text: string;
-    kind?: "text" | "system";
+    kind?: 'text' | 'system';
     parentMessageId?: string;
     rootThreadId?: string;
+    connectorIds?: Record<string, {
+        contactId: string;
+        connectorId: string;
+    }>;
 };
 type ListMessagesArgs = {
     organizationId: string;
@@ -155,7 +227,7 @@ type SearchMessagesArgs = {
     conversationId?: string;
     senderModel?: string;
     senderId?: string;
-    kind?: "text" | "system";
+    kind?: 'text' | 'system';
     dateFrom?: string;
     dateTo?: string;
     threadRootId?: string;
@@ -196,25 +268,6 @@ interface IConversation extends Document {
  */
 declare function createConversationModel(options: InitOptions, conn?: Connection): Model<IConversation>;
 
-interface IMessage extends Document {
-    organizationId: string;
-    conversationId: string;
-    senderModel: string;
-    senderId: string;
-    text: string;
-    kind: 'text' | 'system';
-    parentMessageId?: string;
-    rootThreadId?: string;
-    editedAt?: Date;
-    deletedAt?: Date;
-    createdAt: Date;
-    updatedAt: Date;
-}
-/**
- * Create (or retrieve) Message model safely
- */
-declare function createMessageModel(options: InitOptions, conn?: Connection): Model<IMessage>;
-
 /**
  * Pagination result interface
  */
@@ -401,34 +454,6 @@ declare function createTransport(config?: TransportConfig, server?: Server): Tra
     socket?: SocketTransport;
 };
 
-declare const modelRegistry: Map<string, mongoose.Model<any, {}, {}, {}, any, any>>;
-/**
- * Create Mongoose models with applied configuration
- * @param mongooseInstance Mongoose instance
- * @param options Initialization options
- * @returns Object containing Conversation and Message models
- */
-declare function createModels(mongooseInstance: typeof mongoose, options: InitOptions): {
-    Conversation: mongoose.Model<IConversation, {}, {}, {}, mongoose.Document<unknown, {}, IConversation> & IConversation & {
-        _id: mongoose.Types.ObjectId;
-    }, any> | mongoose.Model<any, {}, {}, {}, any, any>;
-    Message: mongoose.Model<IMessage, {}, {}, {}, mongoose.Document<unknown, {}, IMessage> & IMessage & {
-        _id: mongoose.Types.ObjectId;
-    }, any> | mongoose.Model<any, {}, {}, {}, any, any>;
-};
-
-/**
- * Ensure all indexes are created on models
- * @param models Object containing Mongoose models
- */
-declare function ensureIndexes(models: {
-    Conversation: Model<IConversation>;
-    Message: Model<IMessage>;
-}): Promise<void>;
-
-type ConversationModel = Model<IConversation>;
-type MessageModel = Model<IMessage>;
-
 /**
  * Generates a random string ID with the specified length
  * @param length The length of the ID to generate (default: 24)
@@ -521,6 +546,13 @@ declare function searchByParticipantPair(model: Model<IConversation>, params: {
     };
 }): Promise<IConversation | null>;
 
+type RuntimeConfig = {
+    dataServiceEndpoint?: string;
+    secretId?: string;
+};
+declare function setRuntimeConfig(cfg: RuntimeConfig): void;
+declare function getRuntimeConfig(): RuntimeConfig;
+
 /**
  * Chat services container
  */
@@ -546,4 +578,4 @@ interface ChatServices {
  */
 declare function initChat(mongooseInstance: typeof mongoose, options: InitOptions, server?: Server): Promise<ChatServices>;
 
-export { type Actor, type ChatServices, type ConversationModel, type ConversationReadEvent, type ConversationsService, type CreateConversationArgs, type EnvironmentConfig, type IConversation, type IMessage, type InitOptions, type ListMessagesArgs, type MarkReadArgs, type MessageCreatedEvent, type MessageModel, type MessageServiceHooks, type MessageWithSender, type MessagesService, type PaginatedResult, type PresenceEvent, type RedisConfig, type SearchConversationsArgs, type SearchMessagesArgs, type SendMessageArgs, type SocketConfig$1 as SocketConfig, type Transport, type TransportConfig, type TypingEvent, createConversationId, createConversationModel, createConversationsService, createCursor, createMessageId, createMessageModel, createMessagesService, createModels, createPaginatedResponse, createThreadId, createTransport, ensureIndexes, generateId, getRedisConfig, initChat, modelRegistry, parseCursor, searchByParticipantPair, searchConversations, searchMessages, validateCreateConversationArgs, validateInitOptions, validateMarkReadArgs, validatePagination, validateSendMessageArgs };
+export { type Actor, type ChatServices, type ConversationModel, type ConversationReadEvent, type ConversationsService, type CreateConversationArgs, type EnvironmentConfig, type IConversation, type IMessage, type InitOptions, type ListMessagesArgs, type MarkReadArgs, type MessageCreatedEvent, type MessageModel, type MessageServiceHooks, type MessageWithSender, type MessagesService, type PaginatedResult, type PresenceEvent, type RedisConfig, type RuntimeConfig, type SearchConversationsArgs, type SearchMessagesArgs, type SendMessageArgs, type SocketConfig$1 as SocketConfig, type SourceType, type Transport, type TransportConfig, type TypingEvent, createConversationId, createConversationModel, createConversationsService, createCursor, createMessageId, createMessageModel, createMessagesService, createModels, createPaginatedResponse, createThreadId, createTransport, ensureIndexes, generateId, getRedisConfig, getRuntimeConfig, initChat, modelRegistry, parseCursor, searchByParticipantPair, searchConversations, searchMessages, setRuntimeConfig, sourceType, validateCreateConversationArgs, validateInitOptions, validateMarkReadArgs, validatePagination, validateSendMessageArgs };

package/dist/index.d.ts

@@ -108,8 +108,75 @@ type InitOptions = {
         sendPerMin?: number;
         typingPerMin?: number;
     };
+    /**
+     * Optional external data service endpoint accessible across the package
+     */
+    dataServiceEndpoint?: string;
+    /**
+     * Optional secret id to access the external service
+     */
+    secretId?: string;
+};
+
+declare const sourceType: {
+    readonly LINKEDIN: "linkedin";
+    readonly WHATSAPP: "whatsapp";
+    readonly EMAIL: "email";
+    readonly CORE: "core";
+};
+type SourceType = (typeof sourceType)[keyof typeof sourceType];
+interface IMessage extends Document {
+    organizationId: string;
+    conversationId: string;
+    senderModel: string;
+    senderId: string;
+    text: string;
+    kind: 'text' | 'system';
+    source: SourceType[];
+    failed_source?: Array<{
+        source: string;
+        message: string;
+    }>;
+    parentMessageId?: string;
+    rootThreadId?: string;
+    editedAt?: Date;
+    deletedAt?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+}
+/**
+ * Create (or retrieve) Message model safely
+ */
+declare function createMessageModel(options: InitOptions, conn?: Connection): Model<IMessage>;
+
+declare const modelRegistry: Map<string, mongoose.Model<any, {}, {}, {}, any, any>>;
+/**
+ * Create Mongoose models with applied configuration
+ * @param mongooseInstance Mongoose instance
+ * @param options Initialization options
+ * @returns Object containing Conversation and Message models
+ */
+declare function createModels(mongooseInstance: typeof mongoose, options: InitOptions): {
+    Conversation: mongoose.Model<IConversation, {}, {}, {}, mongoose.Document<unknown, {}, IConversation> & IConversation & {
+        _id: mongoose.Types.ObjectId;
+    }, any> | mongoose.Model<any, {}, {}, {}, any, any>;
+    Message: mongoose.Model<IMessage, {}, {}, {}, mongoose.Document<unknown, {}, IMessage> & IMessage & {
+        _id: mongoose.Types.ObjectId;
+    }, any> | mongoose.Model<any, {}, {}, {}, any, any>;
 };
 
+/**
+ * Ensure all indexes are created on models
+ * @param models Object containing Mongoose models
+ */
+declare function ensureIndexes(models: {
+    Conversation: Model<IConversation>;
+    Message: Model<IMessage>;
+}): Promise<void>;
+
+type ConversationModel = Model<IConversation>;
+type MessageModel = Model<IMessage>;
+
 type CreateConversationArgs = {
     organizationId: string;
     a: {
@@ -126,10 +193,15 @@ type SendMessageArgs = {
     conversationId: string;
     senderModel: string;
     senderId: string;
+    source: SourceType[];
     text: string;
-    kind?: "text" | "system";
+    kind?: 'text' | 'system';
     parentMessageId?: string;
     rootThreadId?: string;
+    connectorIds?: Record<string, {
+        contactId: string;
+        connectorId: string;
+    }>;
 };
 type ListMessagesArgs = {
     organizationId: string;
@@ -155,7 +227,7 @@ type SearchMessagesArgs = {
     conversationId?: string;
     senderModel?: string;
     senderId?: string;
-    kind?: "text" | "system";
+    kind?: 'text' | 'system';
     dateFrom?: string;
     dateTo?: string;
     threadRootId?: string;
@@ -196,25 +268,6 @@ interface IConversation extends Document {
  */
 declare function createConversationModel(options: InitOptions, conn?: Connection): Model<IConversation>;
 
-interface IMessage extends Document {
-    organizationId: string;
-    conversationId: string;
-    senderModel: string;
-    senderId: string;
-    text: string;
-    kind: 'text' | 'system';
-    parentMessageId?: string;
-    rootThreadId?: string;
-    editedAt?: Date;
-    deletedAt?: Date;
-    createdAt: Date;
-    updatedAt: Date;
-}
-/**
- * Create (or retrieve) Message model safely
- */
-declare function createMessageModel(options: InitOptions, conn?: Connection): Model<IMessage>;
-
 /**
  * Pagination result interface
  */
@@ -401,34 +454,6 @@ declare function createTransport(config?: TransportConfig, server?: Server): Tra
     socket?: SocketTransport;
 };
 
-declare const modelRegistry: Map<string, mongoose.Model<any, {}, {}, {}, any, any>>;
-/**
- * Create Mongoose models with applied configuration
- * @param mongooseInstance Mongoose instance
- * @param options Initialization options
- * @returns Object containing Conversation and Message models
- */
-declare function createModels(mongooseInstance: typeof mongoose, options: InitOptions): {
-    Conversation: mongoose.Model<IConversation, {}, {}, {}, mongoose.Document<unknown, {}, IConversation> & IConversation & {
-        _id: mongoose.Types.ObjectId;
-    }, any> | mongoose.Model<any, {}, {}, {}, any, any>;
-    Message: mongoose.Model<IMessage, {}, {}, {}, mongoose.Document<unknown, {}, IMessage> & IMessage & {
-        _id: mongoose.Types.ObjectId;
-    }, any> | mongoose.Model<any, {}, {}, {}, any, any>;
-};
-
-/**
- * Ensure all indexes are created on models
- * @param models Object containing Mongoose models
- */
-declare function ensureIndexes(models: {
-    Conversation: Model<IConversation>;
-    Message: Model<IMessage>;
-}): Promise<void>;
-
-type ConversationModel = Model<IConversation>;
-type MessageModel = Model<IMessage>;
-
 /**
  * Generates a random string ID with the specified length
  * @param length The length of the ID to generate (default: 24)
@@ -521,6 +546,13 @@ declare function searchByParticipantPair(model: Model<IConversation>, params: {
     };
 }): Promise<IConversation | null>;
 
+type RuntimeConfig = {
+    dataServiceEndpoint?: string;
+    secretId?: string;
+};
+declare function setRuntimeConfig(cfg: RuntimeConfig): void;
+declare function getRuntimeConfig(): RuntimeConfig;
+
 /**
  * Chat services container
  */
@@ -546,4 +578,4 @@ interface ChatServices {
  */
 declare function initChat(mongooseInstance: typeof mongoose, options: InitOptions, server?: Server): Promise<ChatServices>;
 
-export { type Actor, type ChatServices, type ConversationModel, type ConversationReadEvent, type ConversationsService, type CreateConversationArgs, type EnvironmentConfig, type IConversation, type IMessage, type InitOptions, type ListMessagesArgs, type MarkReadArgs, type MessageCreatedEvent, type MessageModel, type MessageServiceHooks, type MessageWithSender, type MessagesService, type PaginatedResult, type PresenceEvent, type RedisConfig, type SearchConversationsArgs, type SearchMessagesArgs, type SendMessageArgs, type SocketConfig$1 as SocketConfig, type Transport, type TransportConfig, type TypingEvent, createConversationId, createConversationModel, createConversationsService, createCursor, createMessageId, createMessageModel, createMessagesService, createModels, createPaginatedResponse, createThreadId, createTransport, ensureIndexes, generateId, getRedisConfig, initChat, modelRegistry, parseCursor, searchByParticipantPair, searchConversations, searchMessages, validateCreateConversationArgs, validateInitOptions, validateMarkReadArgs, validatePagination, validateSendMessageArgs };
+export { type Actor, type ChatServices, type ConversationModel, type ConversationReadEvent, type ConversationsService, type CreateConversationArgs, type EnvironmentConfig, type IConversation, type IMessage, type InitOptions, type ListMessagesArgs, type MarkReadArgs, type MessageCreatedEvent, type MessageModel, type MessageServiceHooks, type MessageWithSender, type MessagesService, type PaginatedResult, type PresenceEvent, type RedisConfig, type RuntimeConfig, type SearchConversationsArgs, type SearchMessagesArgs, type SendMessageArgs, type SocketConfig$1 as SocketConfig, type SourceType, type Transport, type TransportConfig, type TypingEvent, createConversationId, createConversationModel, createConversationsService, createCursor, createMessageId, createMessageModel, createMessagesService, createModels, createPaginatedResponse, createThreadId, createTransport, ensureIndexes, generateId, getRedisConfig, getRuntimeConfig, initChat, modelRegistry, parseCursor, searchByParticipantPair, searchConversations, searchMessages, setRuntimeConfig, sourceType, validateCreateConversationArgs, validateInitOptions, validateMarkReadArgs, validatePagination, validateSendMessageArgs };