arifa-client 1.0.0

package/README.md

@@ -0,0 +1,11 @@
+# ArifaClient SDK
+
+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
+```

package/dist/ArifaClient.d.ts

@@ -0,0 +1,45 @@
+type ArifaEvent = any;
+type ConnectionState = "connected" | "disconnected";
+interface ArifaClientOptions {
+    apiKey: string;
+    client: "web" | "mobile";
+    wsUrl?: string;
+    apiEndpoint?: string;
+}
+interface NotifyPayload {
+    recipient: string;
+    payload: Record<string, any>;
+    client?: "web" | "mobile";
+}
+type ConnectionCallback = (state: ConnectionState) => void;
+export declare class ArifaClient {
+    private apiKey;
+    private client;
+    private wsUrl;
+    private apiEndpoint;
+    private ws;
+    private isConnected;
+    private reconnectAttempts;
+    private reconnectTimer;
+    private subscriptions;
+    private connectionListeners;
+    constructor({ apiKey, client, wsUrl, apiEndpoint }: ArifaClientOptions);
+    private safeParse;
+    /** Subscribe to a recipient */
+    subscribe(recipient: string): {
+        listen: (callback: (event: ArifaEvent) => void) => void;
+        unsubscribe: () => void;
+    };
+    /** Listen to connection state changes */
+    onConnectionChange(callback: ConnectionCallback): void;
+    private emitConnection;
+    /** Connect WebSocket */
+    private connect;
+    /** Send notification */
+    notify({ recipient, payload, client }: NotifyPayload): Promise<any>;
+    /** Disconnect WS */
+    disconnect(): void;
+    /** Return connection state */
+    connected(): boolean;
+}
+export {};

package/dist/ArifaClient.js

@@ -0,0 +1,118 @@
+export class ArifaClient {
+    apiKey;
+    client;
+    wsUrl;
+    apiEndpoint;
+    ws = null;
+    isConnected = false;
+    reconnectAttempts = 0;
+    reconnectTimer = null;
+    subscriptions = {};
+    connectionListeners = [];
+    constructor({ apiKey, client, wsUrl, apiEndpoint }) {
+        this.apiKey = apiKey;
+        this.client = client;
+        this.wsUrl = wsUrl || "wss://notifications.arifa.dev/ws";
+        this.apiEndpoint = apiEndpoint || "https://notifications.arifa.dev/notify";
+    }
+    safeParse(input) {
+        try {
+            if (typeof input === "object")
+                return input;
+            let parsed = JSON.parse(input);
+            if (typeof parsed === "string")
+                parsed = JSON.parse(parsed);
+            return parsed;
+        }
+        catch {
+            return null;
+        }
+    }
+    /** Subscribe to a recipient */
+    subscribe(recipient) {
+        if (!this.subscriptions[recipient]) {
+            this.subscriptions[recipient] = { recipient, listeners: [] };
+        }
+        this.connect(recipient);
+        return {
+            listen: (callback) => {
+                this.subscriptions[recipient].listeners.push(callback);
+            },
+            unsubscribe: () => {
+                delete this.subscriptions[recipient];
+            },
+        };
+    }
+    /** Listen to connection state changes */
+    onConnectionChange(callback) {
+        this.connectionListeners.push(callback);
+    }
+    emitConnection(state) {
+        this.connectionListeners.forEach((cb) => cb(state));
+    }
+    /** Connect WebSocket */
+    connect(recipient) {
+        if (this.ws && this.ws.readyState !== WebSocket.CLOSED)
+            return;
+        this.ws = new WebSocket(`${this.wsUrl}/connect?api_key=${this.apiKey}&recipient=${recipient}&client=${this.client}`);
+        this.ws.onopen = () => {
+            this.isConnected = true;
+            this.reconnectAttempts = 0;
+            this.emitConnection("connected");
+            console.log("ArifaClient connected");
+        };
+        this.ws.onmessage = (event) => {
+            const parsed = this.safeParse(event.data);
+            if (!parsed || !parsed.recipient)
+                return;
+            const sub = this.subscriptions[parsed.recipient];
+            if (sub)
+                sub.listeners.forEach((fn) => fn(parsed));
+        };
+        this.ws.onclose = (event) => {
+            this.isConnected = false;
+            this.emitConnection("disconnected");
+            if ([4001, 4003].includes(event.code) || !navigator.onLine)
+                return;
+            const timeout = Math.min(30000, 2000 * 2 ** this.reconnectAttempts);
+            this.reconnectAttempts++;
+            this.reconnectTimer = window.setTimeout(() => this.connect(recipient), timeout);
+        };
+    }
+    /** Send notification */
+    async notify({ recipient, payload, client }) {
+        if (!recipient || !payload)
+            throw new Error("recipient and payload are required");
+        const body = {
+            recipient,
+            payload,
+            api_key: this.apiKey,
+            client: client || this.client,
+        };
+        const res = await fetch(this.apiEndpoint, {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+                Origin: window.location.origin,
+            },
+            body: JSON.stringify(body),
+        });
+        if (!res.ok) {
+            const text = await res.text();
+            throw new Error(`Failed to send notification: ${res.status} ${res.statusText} ${text}`);
+        }
+        return res.json();
+    }
+    /** Disconnect WS */
+    disconnect() {
+        if (this.reconnectTimer)
+            clearTimeout(this.reconnectTimer);
+        this.ws?.close();
+        this.isConnected = false;
+        this.emitConnection("disconnected");
+    }
+    /** Return connection state */
+    connected() {
+        return this.isConnected;
+    }
+}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "arifa-client",
+  "version": "1.0.0",
+  "description": "JavaScript/TypeScript client SDK for Arifa Realtime Notification Service",
+  "main": "dist/ArifaClient.js",
+  "module": "dist/ArifaClient.js",
+  "types": "dist/ArifaClient.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "arifa",
+    "realtime",
+    "notifications",
+    "websocket",
+    "sdk"
+  ],
+  "author": "Peter Nyando",
+  "license": "MIT",
+  "type": "module",
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  }
+}