fms-notification-sdk
v1.0.2
Published
Realtime notification SDK using Node, MongoDB and Socket.io
Maintainers
Readme
FMS Notification SDK
Realtime notification SDK built with Node.js, MongoDB & Socket.io. Easily send and receive notifications in React, Next.js, or any JavaScript app.
📦 Installation
npm install fms-notification-sdk⚡ Quick Start
import NotificationSDK from "fms-notification-sdk";
const sdk = new NotificationSDK({
apiKey: "YOUR_API_KEY"
});🔔 Send Notification
sdk.sendNotification({
title: "Hello",
message: "This is a test notification",
userId: "123",
type: "info"
});📥 Get User Notifications
const notifications = await sdk.getNotifications("123");
console.log(notifications);✅ Mark as Read
await sdk.markAsRead("notification_id_here");⚡ Real-time Notifications (Socket)
sdk.initSocket("123", (data) => {
console.log("New notification received:", data);
});Disconnect socket:
sdk.disconnectSocket();⚙️ Configuration
const sdk = new NotificationSDK({
apiUrl: "https://coredata.space/fms",
socketUrl: "https://coredata.space",
apiKey: "YOUR_API_KEY"
});📡 Available Methods
| Method | Description | | ---------------------------- | --------------------------------- | | sendNotification(data) | Send a new notification | | getNotifications(userId) | Fetch notifications for a user | | markAsRead(id) | Mark notification as read | | initSocket(userId, callback) | Listen for realtime notifications | | disconnectSocket() | Disconnect socket |
📄 Notification Object Format
{
title: "Title",
message: "Message",
userId: "123",
type: "info"
}🧪 React Example
import { useEffect } from "react";
import NotificationSDK from "fms-notification-sdk";
function App() {
useEffect(() => {
const sdk = new NotificationSDK({
apiKey: "YOUR_API_KEY"
});
sdk.sendNotification({
title: "Hello",
message: "Notification from React",
userId: "123"
});
sdk.initSocket("123", (data) => {
console.log("Realtime:", data);
});
}, []);
return <div>Notification Test</div>;
}
export default App;🏗️ Tech Stack
- Node.js
- MongoDB
- Socket.io
- Express
👨💻 Author
Himanshu Pandey FMS Notification System
📌 Version
Current Version: 1.0.2
