🚀 Dozaar WebSocket API

📡 Connection

Authentication

You must provide a JWT token for authentication. You can send it in one of two ways:

// Option 1: Authorization header
const socket = io('ws://your-domain.com/chat', {
  extraHeaders: {
    Authorization: 'Bearer YOUR_JWT_TOKEN'
  }
});

// Option 2: Auth token in handshake
const socket = io('ws://your-domain.com/chat', {
  auth: {
    token: 'YOUR_JWT_TOKEN'
  }
});

🔌 Connection Events

socket.on('connect', () => {
  console.log('Connected to Dozaar WebSocket');
});

📤 Client Events (Emit)

socket.emit('join:conversation', {
  conversationId: '123e4567-e89b-12d3-a456-426614174000'
});

// Listen for acknowledgment
socket.on('joined:conversation', (data) => {
  console.log('Joined conversation:', data.conversationId);
});

socket.emit('leave:conversation', {
  conversationId: '123e4567-e89b-12d3-a456-426614174000'
});

socket.emit('send:message', {
  conversationId: '123e4567-e89b-12d3-a456-426614174000',
  message: 'Hello, world!',
  attachmentUrls: ['https://example.com/image.jpg']
});

socket.emit('typing:start', {
  conversationId: '123e4567-e89b-12d3-a456-426614174000'
});

socket.emit('typing:stop', {
  conversationId: '123e4567-e89b-12d3-a456-426614174000'
});

socket.emit('mark:read', {
  messageId: '123e4567-e89b-12d3-a456-426614174000'
});

socket.emit('get:online_status', {
  userIds: ['user-id-1', 'user-id-2']
});

socket.on('online:status', (data) => {
  console.log('Online statuses:', data.statuses);
});

📥 Server Events (Listen)

socket.on('new:message', (message) => {
  console.log('New message:', message);
  // message contains: id, conversationId, senderId, message, 
  // attachmentUrls, createdAt, sender object, etc.
});

socket.on('user:typing', (data) => {
  console.log(`User ${data.userId} is typing`);
});

socket.on('exception', (error) => {
  console.error('Error:', error.event, error.error);
});

💡 Complete Client Example

import { io } from 'socket.io-client';

// Connect with authentication
const socket = io('ws://your-domain.com/chat', {
  auth: {
    token: 'YOUR_JWT_TOKEN'
  }
});

// Connection events
socket.on('connect', () => {
  console.log('✅ Connected to Dozaar');
  
  // Join a conversation
  socket.emit('join:conversation', {
    conversationId: 'your-conversation-id'
  });
});

socket.on('disconnect', () => {
  console.log('❌ Disconnected');
});

// Listen for messages
socket.on('new:message', (message) => {
  console.log('📨 New message:', message);
});

socket.on('message:notification', (notification) => {
  console.log('🔔 Notification:', notification);
});

// Typing indicators
socket.on('user:typing', (data) => {
  console.log('⌨️ User typing:', data.userId);
});

// Presence
socket.on('user:online', (data) => {
  console.log('🟢 User online:', data.userId);
});

socket.on('user:offline', (data) => {
  console.log('⚫ User offline:', data.userId);
});

// Error handling
socket.on('exception', (error) => {
  console.error('❌ Error:', error);
});

// Send a message
function sendMessage(text) {
  socket.emit('send:message', {
    conversationId: 'your-conversation-id',
    message: text
  });
}

// Start typing
function startTyping() {
  socket.emit('typing:start', {
    conversationId: 'your-conversation-id'
  });
}

// Stop typing
function stopTyping() {
  socket.emit('typing:stop', {
    conversationId: 'your-conversation-id'
  });
}

✨ Best Practices

⚡ Technical Details