@anonfly/sdk 1.0.1 → 1.0.2

package/README.md

@@ -1,6 +1,21 @@
+<p align="center">
+  <img src="../../docs/images/logo.png" width="96" />
+</p>
+
 # @anonfly/sdk
 
-Core SDK logic for the Anonfly service.
+[![Version](https://img.shields.io/npm/v/@anonfly/sdk?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/@anonfly/sdk)
+[![Downloads](https://img.shields.io/npm/dm/@anonfly/sdk?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/@anonfly/sdk)
+
+The core logic for the Anonfly messaging platform. This package provides a low-level, headless SDK for interacting with the Anonfly API and WebSocket services.
+
+## Features
+
+- **🛡️ Industrial-grade Transport:** Powerful `HttpClient` with middleware support.
+- **⚡ Real-time Engine:** Robust `WebSocketClient` with automatic reconnection.
+- **🔄 Resilience:** Built-in `retryMiddleware` with exponential backoff.
+- **📦 Resource-based API:** Clean access to `rooms`, `messages`, `auth`, and `admin` logic.
+- **✨ Pure TypeScript:** Zero-dependency core logic with full type-safety.
 
 ## Installation
 
@@ -8,12 +23,87 @@ Core SDK logic for the Anonfly service.
 npm install @anonfly/sdk
 ```
 
-## Features
+## Usage
+
+### Basic Initialization
+
+```typescript
+import { Anonfly } from '@anonfly/sdk';
+
+const anonfly = new Anonfly({
+  apiKey: 'YOUR_API_KEY',
+  baseUrl: 'https://api.anonfly.com/v1',
+  wsUrl: 'wss://api.anonfly.com', // Optional for real-time
+  retries: 3, // Optional: defaults to built-in retry logic
+});
+
+// Use resources
+const rooms = await anonfly.rooms.list();
+```
+
+### Working with Resources
+
+The SDK is organized into logical resources:
+
+```typescript
+// Authentication
+const session = await anonfly.auth.login(credentials);
+
+// Message Management
+const message = await anonfly.messages.send(roomId, {
+  content: "Hello World",
+  type: "text",
+});
+
+// Room Management
+const room = await anonfly.rooms.create({ name: "General" });
+```
+
+### Advanced: Custom Middleware
+
+You can extend the `HttpClient` with custom middleware:
+
+```typescript
+anonfly.http.use(async (request, next) => {
+  console.log(`Starting request to ${request.url}`);
+  const response = await next(request);
+  console.log(`Finished request with status ${response.status}`);
+  return response;
+});
+```
+
+### Real-time with WebSockets
+
+```typescript
+if (anonfly.ws) {
+  anonfly.ws.subscribe('message:new', (data) => {
+    console.log('New message received:', data);
+  });
+  
+  anonfly.ws.connect();
+}
+```
 
-- **Type Safety:** Comprehensive TypeScript definitions for all API resources.
-- **Middleware Support:** Extensible HTTP client with built-in retry logic.
-- **Real-time:** Native WebSocket support for live message updates.
+## Recipes
+
+### Handling Connection Drops
+
+The SDK automatically handles reconnections if configured, but you can also listen to events:
+
+```typescript
+anonfly.ws?.on('close', () => {
+  console.warn('Connection lost. Cleaning up UI state...');
+});
+```
+
+## TypeScript Usage
+
+`@anonfly/sdk` is written 100% in TypeScript. All types are exported from the main entry point:
+
+```typescript
+import { AnonflyConfig, Room, Message } from '@anonfly/sdk';
+```
 
 ## License
 
-MIT
+[MIT](../../LICENSE)

package/dist/core/transport/WebSocketClient.d.ts

@@ -13,6 +13,8 @@ export declare class WebSocketClient extends EventEmitter {
     connect(): void;
     private reconnect;
     send(data: any): void;
+    subscribe(topic: string, handler: (data: any) => void): void;
+    unsubscribe(topic: string, handler: (data: any) => void): void;
     disconnect(): void;
 }
 //# sourceMappingURL=WebSocketClient.d.ts.map

package/dist/core/transport/WebSocketClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WebSocketClient.d.ts","sourceRoot":"","sources":["../../../src/core/transport/WebSocketClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,MAAM,WAAW,QAAQ;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,qBAAa,eAAgB,SAAQ,YAAY;IAIjC,OAAO,CAAC,MAAM;IAH1B,OAAO,CAAC,EAAE,CAA0B;IACpC,OAAO,CAAC,UAAU,CAAK;gBAEH,MAAM,EAAE,QAAQ;IAIpC,OAAO;IA6BP,OAAO,CAAC,SAAS;IAMjB,IAAI,CAAC,IAAI,EAAE,GAAG;IAQd,UAAU;CAMb"}
+{"version":3,"file":"WebSocketClient.d.ts","sourceRoot":"","sources":["../../../src/core/transport/WebSocketClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,MAAM,WAAW,QAAQ;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,qBAAa,eAAgB,SAAQ,YAAY;IAIjC,OAAO,CAAC,MAAM;IAH1B,OAAO,CAAC,EAAE,CAA0B;IACpC,OAAO,CAAC,UAAU,CAAK;gBAEH,MAAM,EAAE,QAAQ;IAIpC,OAAO;IAoCP,OAAO,CAAC,SAAS;IAMjB,IAAI,CAAC,IAAI,EAAE,GAAG;IAQd,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI;IAIrD,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI;IAIvD,UAAU;CAMb"}

package/dist/index.cjs

@@ -225,6 +225,11 @@ var WebSocketClient = class extends import_events.EventEmitter {
       try {
         const message = JSON.parse(data.toString());
         this.emit("message", message);
+        if (message.topic) {
+          this.emit(message.topic, message);
+        } else if (message.chatroomId) {
+          this.emit(`room:${message.chatroomId}`, message);
+        }
       } catch {
         this.emit("message", data.toString());
       }
@@ -251,6 +256,12 @@ var WebSocketClient = class extends import_events.EventEmitter {
       throw new Error("WebSocket is not connected");
     }
   }
+  subscribe(topic, handler) {
+    this.on(topic, handler);
+  }
+  unsubscribe(topic, handler) {
+    this.off(topic, handler);
+  }
   disconnect() {
     if (this.ws) {
       this.ws.close();

package/dist/index.js

@@ -188,6 +188,11 @@ var WebSocketClient = class extends EventEmitter {
       try {
         const message = JSON.parse(data.toString());
         this.emit("message", message);
+        if (message.topic) {
+          this.emit(message.topic, message);
+        } else if (message.chatroomId) {
+          this.emit(`room:${message.chatroomId}`, message);
+        }
       } catch {
         this.emit("message", data.toString());
       }
@@ -214,6 +219,12 @@ var WebSocketClient = class extends EventEmitter {
       throw new Error("WebSocket is not connected");
     }
   }
+  subscribe(topic, handler) {
+    this.on(topic, handler);
+  }
+  unsubscribe(topic, handler) {
+    this.off(topic, handler);
+  }
   disconnect() {
     if (this.ws) {
       this.ws.close();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anonfly/sdk",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "type": "module",
   "description": "Core SDK logic for Anonfly service",
   "main": "./dist/index.cjs",