EasyJSSDK

中文 README

A simple and easy-to-use communication SDK for WuKongIM, based on its JSON-RPC protocol.

Installation

npm install easyjssdk

Usage

// ... existing code ...
import { WKIM, WKIMChannelType, WKIMEvent } from 'easyjssdk';

// 1. Initialization
const im = WKIM.init("ws://your-wukongim-server.com:5200", {
    uid: "your_user_id",        // Your user ID
    token: "your_auth_token"    // Your authentication token
    // deviceId: "optional_device_id", // Optional device ID
    // deviceFlag: 2 // Optional device flag (1:APP, 2:WEB, default is 2)
});

// 2. Receive messages
im.on(WKIMEvent.Message, (message) => {
    console.log("Received message:", message);
    // Process received message (message.payload, message.fromUid, etc.)
});
// For more events, check the documentation
https://github.com/WuKongIM/EasyJSSDK/blob/main/example/app.js#L132

// 3. Connect to the server
await im.connect()

// 4. Example: Send a message after successful connection
const targetChannelID = "friend_user_id"; // Target user ID
const messagePayload = { type: 1, content: "Hello from EasyJSSDK!" }; // Your custom message payload
return im.send(targetChannelID, WKIMChannelType.Person, messagePayload);

Example:

Development

1. Clone the repository.
2. Run npm install.
3. Run npm run build to compile TypeScript to JavaScript.

Running the Example

This repository includes a simple HTML/JS example to test the SDK.

1. Build the SDK: Make sure you have built the library first:

   npm run build

2. Start a Local Server: Navigate to the root directory of this project (EasyJSSDK) in your terminal. You need to serve the files using a local web server because the example uses ES Modules. A simple way is using http-server:

   # If you don't have http-server, install it globally:
   # npm install -g http-server
   
   # Run the server from the EasyJSSDK directory:
   http-server .

   Alternatively, use the VS Code "Live Server" extension or any other local server, ensuring it serves from the project root directory (EasyJSSDK).

3. Open the Example: Open your web browser and navigate to the example page, typically: http://localhost:8080/example/ (Adjust the port number if your server uses a different one).

4. Test: Enter your WuKongIM server details (URL, UID, Token) and use the buttons to connect, disconnect, and send messages.