arifa-client 1.0.1 → 1.0.3

package/README.md

@@ -3,9 +3,146 @@
 JavaScript/TypeScript client SDK for **Arifa Realtime Notification Service**.  
 Allows you to connect via WebSocket, listen to events, and send notifications using HTTP.
 
-
 ## Installation
 
 ```bash
 npm install arifa-client
-```
+```
+
+or using Yarn:
+
+```bash
+yarn add arifa-client
+```
+
+## Usage
+
+#### Import and Initialize
+
+```js
+import { ArifaClient } from "arifa-client";
+
+const client = new ArifaClient({
+  apiKey: "arifa_test:YOUR_API_KEY",
+  client: "web", // "web" or "mobile"
+});
+```
+
+#### Listen to Connection State
+
+```js
+client.onConnectionChange((state) => {
+  console.log("Connection state:", state); // "connected" or "disconnected"
+});
+```
+
+#### Subscribe Recipient
+
+Note: `Recipient must be UUID`
+
+```js
+const sub = client.subscribe("RECIPIENT_UUID");
+
+// Listen for events
+sub.listen((event) => {
+  console.log("Received event:", event);
+});
+
+// Unsubscribe when done
+sub.unsubscribe();
+```
+
+#### Send a Event/Notification/Data
+
+```js
+const res = await client.notify({
+  recipient: "RECIPIENT_UUID",
+  payload: { title: "Hello", message: "Welcome to Arifa!" }, // Can be any JSON data
+});
+console.log(res);
+```
+
+`recipient` → UUID of the user
+`payload`→ Any JSON object
+`client` → Optional, "web" or "mobile"
+
+**Note**: The notify method returns a result object with the notification status.
+Example responses:
+
+- "sent" → Notification successfully sent to a connected user
+
+- "User offline, notification saved" → User is offline; the message was stored for later delivery
+
+- "Failed to send/save notification" → There was an error sending or saving the notification
+
+#### Disconnect
+
+```js
+client.disconnect();
+```
+
+#### Check Connection Status
+
+```js
+if (client.connected()) {
+  console.log("WebSocket is connected");
+} else {
+  console.log("WebSocket is disconnected");
+}
+```
+
+## ## ArifaClient Usage Example
+
+```jsx
+import { ArifaClient } from "arifa-client";
+
+// Initialize client
+const client = new ArifaClient({
+  apiKey: "arifa_test:YOUR_API_KEY",
+  client: "web", // "web" or "mobile"
+});
+
+// Listen to connection state
+client.onConnectionChange((state) => {
+  console.log("Connection state:", state); // "connected" or "disconnected"
+});
+
+// Subscribe to a recipient (UUID required)
+const sub = client.subscribe("RECIPIENT_UUID");
+
+// Listen for incoming events
+sub.listen((event) => {
+  console.log("Received event:", event);
+});
+
+// Example: Send a notification/event
+const sendNotification = async () => {
+  const res = await client.notify({
+    recipient: "RECIPIENT_UUID",
+    payload: { title: "Hello", message: "Welcome to Arifa!" }, // Any JSON data
+  });
+
+  console.log(res);
+  /*
+    Possible responses:
+    "sent" → Notification successfully sent to a connected user
+    "User offline, notification saved" → User offline; message stored for later delivery
+    "Failed to send/save notification" → Error sending or saving notification
+  */
+};
+
+sendNotification();
+
+// Unsubscribe when done
+// sub.unsubscribe();
+
+// Disconnect client when done
+// client.disconnect();
+
+// Check connection status
+if (client.connected()) {
+  console.log("WebSocket is connected");
+} else {
+  console.log("WebSocket is disconnected");
+}
+```

package/dist/ArifaClient.d.ts

@@ -11,6 +11,10 @@ interface NotifyPayload {
     payload: Record<string, any>;
     client?: "web" | "mobile";
 }
+interface NotifyResponse {
+    success: boolean;
+    message: string;
+}
 type ConnectionCallback = (state: ConnectionState) => void;
 export declare class ArifaClient {
     private apiKey;
@@ -37,7 +41,7 @@ export declare class ArifaClient {
     /** Connect WebSocket */
     private connect;
     /** Send notification */
-    notify({ recipient, payload, client }: NotifyPayload): Promise<any>;
+    notify({ recipient, payload, client, }: NotifyPayload): Promise<NotifyResponse>;
     /** Disconnect WS */
     disconnect(): void;
     /** Return connection state */

package/dist/ArifaClient.js

@@ -80,9 +80,10 @@ export class ArifaClient {
         };
     }
     /** Send notification */
-    async notify({ recipient, payload, client }) {
-        if (!recipient || !payload)
+    async notify({ recipient, payload, client, }) {
+        if (!recipient || !payload) {
             throw new Error("recipient and payload are required");
+        }
         const body = {
             recipient,
             payload,
@@ -97,11 +98,20 @@ export class ArifaClient {
             },
             body: JSON.stringify(body),
         });
+        let json;
+        try {
+            json = await res.json();
+        }
+        catch {
+            throw new Error("Invalid server response");
+        }
         if (!res.ok) {
-            const text = await res.text();
-            throw new Error(`Failed to send notification: ${res.status} ${res.statusText} ${text}`);
+            throw new Error(json.message || "Notification request failed");
         }
-        return res.json();
+        return {
+            success: json.success,
+            message: json.message,
+        };
     }
     /** Disconnect WS */
     disconnect() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arifa-client",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "JavaScript/TypeScript client SDK for Arifa Realtime Notification Service",
   "main": "dist/ArifaClient.js",
   "module": "dist/ArifaClient.js",