JavaScript / TypeScript

The DNotifier NPM SDK allows developers to integrate Realtime Chat, Pub/Sub messaging, and AI features into any JavaScript environment (Node.js, React, Angular, Next.js, NestJS, Vue, etc.).

Below are the main functions available and examples for each.

connect()

Description: Authenticates with DNotifier and establishes a WebSocket connection. Sets up message listeners and handshake.

Usage:

await client.connect();

Callbacks (optional):

• onConnected — called after successful connection

• onMessage — called for every incoming message

• onDisconnected — called if the connection closes or errors

---

getPlanLimits()

Description: Returns the current subscription limits after authentication, including AI and messaging limits.

Returns:

{
  messagesHardLimit,
  maxAIRequestsPerMonth,
  maxAIWordsPerMonth,
  knowledgeBaseMaxWords,
  aiEnabled,
  maxUsers,
  maxRowsPerUser
}

Usage:

const limits = client.getPlanLimits();
console.log(limits.aiEnabled, limits.maxAIRequestsPerMonth);

---

send({ senderId, receiverId, receiverIds, data })

Description: Send a realtime message to one or multiple receivers.

Parameters:

• senderId — required

• receiverId — single recipient (optional if receiverIds provided)

• receiverIds — array of recipient IDs (optional if receiverId provided)

• data — message payload

Usage:

client.send({
  senderId: "user123",
  receiverId: "user456",
  data: { text: "Hello World!" }
});

// Send Image Buffer
const imageBuffer = fs.readFileSync(imagePath);
notifier.send({
  senderId: userId,
  receiverId: userId,
  data: { 
    type: "image",
    content: imageBuffer
   },
});

// Send audio message
const audioBuffer = fs.readFileSync(audioPath);
notifier.send({
  senderId: userId,
  receiverId: userId,
  data: { 
    type: "audio",
    content: audioBuffer
   },
});

// Send doc message
const docBuffer = fs.readFileSync(docPath);
notifier.send({
  senderId: userId,
  receiverId: userId,
  data: { 
    type: "doc",
    content: docBuffer
   },
});

If a message exceeds the size limit defined in your subscription plan, it will be counted as multiple messages. You can review the usage breakdown in the Dashboard graphs for better visibility.

---

sendAI({ senderId, message })

Description: Send a message to the AI pipeline. Use this instead of sendWithOpenAI.

Parameters:

• senderId — required

• message — object

  // Use it for string / textual messages
  message : { 
      text : "hey ai, what you can do for me?" 
      useKnowledgeBase: false // or true, if you want to use Knowledge base for the agent. 
  }
  
  // Use for context and multiple messages
  message : { 
  messages : [ 
   { role: "user" , content : "hey ai...!" } ,
   { role: "user" , content : "what can do you for me?" }
  ], 
  useKnowledgeBase: false // or true, if you want to use Knowledge base for the agent. 
  }

Usage:

client.sendAI({
  senderId: "user123",
  message: { text : "Explain DNotifier in simple terms." }
  //message : { messages : [] } 
});

---

fetchAIHistory({ senderId })

Description: Fetch past AI messages sent by a user.

Parameters:

• senderId — required

Usage:

client.fetchAIHistory({ senderId: "user123" });

---

sendBinary({ senderId, receiverIds, buffer, type })

Description: Send binary data (files, images, audio, etc.) to one or more receivers.

Parameters:

• senderId — required

• receiverIds — array of recipients

• buffer — binary data buffer (required)

• type — optional, default "binary"

Usage:

client.sendBinary({
  senderId: "user123",
  receiverIds: ["user456", "user789"],
  buffer: myFileBuffer,
  type: "image"
});

Full Workflow Example — NPM SDK (Safe Post-Connection)

import { DNotifier } from "@dnotifier-realtime/dnotifier";

const client = new DNotifier({
  appId: "YOUR_APP_ID",      // Replace with your App ID
  secret: "YOUR_SECRET",     // Replace with your App Secret
  userId: "user123",         // Your user ID
  transport: "ws",           // Use WebSocket transport
  onConnected: () => {
    console.log("Connected to DNotifier!");

    // Send a simple text message after connection
    client.send({
      senderId: "user123",
      receiverId: "user456",
      data: { text: "Hello!" }
    });

    // Send a message to AI pipeline after connection
    client.sendAI({
      senderId: "user123",
      message: { text : "Explain DNotifier in simple terms." }
      //message : { messages : [] } 
    });

    console.log("Messages sent!");
  },
  onMessage: (msg) => console.log("Received:", msg),
  onDisconnected: (info) => console.log("Disconnected:", info)
});

// Connect to DNotifier
client.connect().catch(console.error);